my $channel_msg_format = Xchat::get_info( "event_text Channel Message" );
From 96aef542ef0415524246d7f60841d6d09f51b263 Mon Sep 17 00:00:00 2001
From: Berke Viktor This function is used to retrieve certain information about the current
-context.
-
ID Return value
+ ID
+ Return value
+ Associated Command(s)
-
away away reason or undef if you are not away
+ away
+ away reason or undef if you are not away
+ AWAY, BACK
-
channel current channel name
+ channel
+ current channel name
+ SETTAB
-
charset character-set used in the current context
+ charset
+ character-set used in the current context
+ CHARSET
event_text <Event Name> text event format string for <Event name>
+
Example:
-
-
host real hostname of the current server
+ host
+ real hostname of the current server
+
-
id connection id
+ id
+ connection id
+
-
inputbox contents of the inputbox
+ inputbox
+ contents of the inputbox
+ SETTEXT
-
libdirfs
- the system wide directory where xchat will look for plugins.
- this string is in the same encoding as the local file system
+ libdirfs
+ the system wide directory where xchat will look for plugins.
+ this string is in the same encoding as the local file system
+
-
modes the current channels modes or undef if not known
+ modes
+ the current channels modes or undef if not known
+ MODE
-
network current network name or undef
+ network
+ current network name or undef, this value is taken from the Network List
+
-
nick current nick
+ nick
+ current nick
+ NICK
-
nickserv nickserv password for this network or undef
+ nickserv
+ nickserv password for this network or undef, this value is taken from the Network List
+
-
server current server name
+
- (what the server claims to be) undef if not connected
- server current server name
+
+ (what the server claims to be) undef if not connected
+
-
state_cursor
- current inputbox cursor position in characters
+ state_cursor
+ current inputbox cursor position in characters
+ SETCURSOR
-
topic current channel topic
+ topic
+ current channel topic
+ TOPIC
-
version xchat version number
+ version
+ xchat version number
+
-
win_status
- status of the xchat window, possible values are "active", "hidden"
- and "normal"
+ win_status
+ status of the xchat window, possible values are "active", "hidden"
+ and "normal"
+ GUI
@@ -644,22 +675,30 @@ C<$id> - one of the following case sensitive values
Additionally when you have detached tabs, each of the windows will return a different win_ptr for the different Gtk2::Window objects.
See char_count.pl for a longer example of a script that uses this to show how many characters you currently have in your input box.
+
-
+xchatdir xchat config directory encoded in UTF-8
+
- examples:
- /home/user/.xchat2
- C:\Documents and Settings\user\Application Data\X-Chat 2
- gtkwin_ptr
+ similar to win_ptr except it will always be a GtkWindow *
+
+
+
xchatdir xchat config directory encoded in UTF-8
+
+ examples:
+ /home/user/.xchat2
+ C:\Documents and Settings\user\Application Data\X-Chat 2
+
-
xchatdirfs same as xchatdir except encoded in the locale file system encoding
+ xchatdirfs same as xchatdir except encoded in the locale file system encoding
+
ID | Return value | +ID | +Return value | +Associated Command(s) |
away | away reason or undef if you are not away | +away | +away reason or undef if you are not away | +AWAY, BACK |
channel | current channel name | +channel | +current channel name | +SETTAB |
charset | character-set used in the current context | +charset | +character-set used in the current context | +CHARSET |
event_text <Event Name> | text event format string for <Event name> Example: -
+ 1
my $channel_msg_format = Xchat::get_info( "event_text Channel Message" ); |
+
+ |||
host | real hostname of the current server | +host | +real hostname of the current server | +|
id | connection id | +id | +connection id | +|
inputbox | contents of the inputbox | +inputbox | +contents of the inputbox | +SETTEXT |
libdirfs | -the system wide directory where xchat will look for plugins. - this string is in the same encoding as the local file system | +libdirfs | +the system wide directory where xchat will look for plugins. + this string is in the same encoding as the local file system | +|
modes | the current channels modes or undef if not known | +modes | +the current channels modes or undef if not known | +MODE |
network | current network name or undef | +network | +current network name or undef, this value is taken from the Network List | +|
nick | current nick | +nick | +current nick | +NICK |
nickserv | nickserv password for this network or undef | +nickserv | +nickserv password for this network or undef, this value is taken from the Network List | +|
server | current server name - (what the server claims to be) undef if not connected - |
+ server | current server name + (what the server claims to be) undef if not connected + |
+ |
state_cursor | -current inputbox cursor position in characters | +state_cursor | +current inputbox cursor position in characters | +SETCURSOR |
topic | current channel topic | +topic | +current channel topic | +TOPIC |
version | xchat version number | +version | +xchat version number | +|
win_status | -status of the xchat window, possible values are "active", "hidden" - and "normal" | +win_status | +status of the xchat window, possible values are "active", "hidden" + and "normal" | +GUI |
win_ptr | native window pointer, GtkWindow * on Unix, HWND on Win32. On Unix if you have the Glib module installed you can use my $window = Glib::Object->new_from_pointer( Xchat::get_info( "win_ptr" ) ); to get a Gtk2::Window object. Additionally when you have detached tabs, each of the windows will return a different win_ptr for the different Gtk2::Window objects. See char_count.pl for a longer example of a script that uses this to show how many characters you currently have in your input box. |
+ |||
xchatdir | xchat config directory encoded in UTF-8 - examples: - /home/user/.xchat2 - C:\Documents and Settings\user\Application Data\X-Chat 2 - |
+ gtkwin_ptr | +similar to win_ptr except it will always be a GtkWindow * | ++ |
xchatdir | xchat config directory encoded in UTF-8 + examples: + /home/user/.xchat2 + C:\Documents and Settings\user\Application Data\X-Chat 2 + |
+ |||
xchatdirfs | same as xchatdir except encoded in the locale file system encoding | +xchatdirfs | same as xchatdir except encoded in the locale file system encoding | +
This function is used to retrieve certain information about the current -context.
+context. If there is an associated command then that command can be used to change the value for a particular ID.
Xchat::get_prefs( $name )