diff --git a/plugins/perl/lib/Xchat.pod b/plugins/perl/lib/Xchat.pod index fff2cba9..76618658 100644 --- a/plugins/perl/lib/Xchat.pod +++ b/plugins/perl/lib/Xchat.pod @@ -556,86 +556,117 @@ C<$id> - one of the following case sensitive values - + + + - + + + - + + + - + + + +
+ my $channel_msg_format = Xchat::get_info( "event_text Channel Message" ); +
+ + - + + + - + + + - + + + - - + + + - + + + - + + + - + + + - + + + - + + - - + + + - + + + - + + + - - + + + @@ -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. + - + + + + + + + - + +
ID Return valueIDReturn valueAssociated Command(s)
away away reason or undef if you are not awayawayaway reason or undef if you are not awayAWAY, BACK
channel current channel namechannelcurrent channel nameSETTAB
charset character-set used in the current contextcharsetcharacter-set used in the current contextCHARSET
event_text <Event Name> text event format string for <Event name>
Example: -
- my $channel_msg_format = Xchat::get_info( "event_text Channel Message" ); -
-
host real hostname of the current serverhostreal hostname of the current server
id connection ididconnection id
inputbox contents of the inputboxinputboxcontents of the inputboxSETTEXT
libdirfsthe system wide directory where xchat will look for plugins. - this string is in the same encoding as the local file systemlibdirfsthe 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 knownmodesthe current channels modes or undef if not knownMODE
network current network name or undefnetworkcurrent network name or undef, this value is taken from the Network List
nick current nicknickcurrent nickNICK
nickserv nickserv password for this network or undefnickservnickserv 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_cursorcurrent inputbox cursor position in charactersstate_cursorcurrent inputbox cursor position in charactersSETCURSOR
topic current channel topictopiccurrent channel topicTOPIC
version xchat version numberversionxchat version number
win_statusstatus of the xchat window, possible values are "active", "hidden" - and "normal"win_statusstatus of the xchat window, possible values are "active", "hidden" + and "normal"GUI
xchatdir xchat config directory encoded in UTF-8
- examples:
- /home/user/.xchat2
- C:\Documents and Settings\user\Application Data\X-Chat 2 - 		gtkwin_ptrsimilar 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 encodingxchatdirfs 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.

=end html diff --git a/plugins/perl/xchat2-perl.html b/plugins/perl/xchat2-perl.html index 65a0b6d4..6092047e 100644 --- a/plugins/perl/xchat2-perl.html +++ b/plugins/perl/xchat2-perl.html @@ -578,75 +578,114 @@ a context cannot be found.

- + + + - + + + - + + + - + + + + + - + + + - + + + - + + + - - + + + - + + + - + + + - + + + - + + + - + + - - + + + - + + + - + + + - - + + + + - + + + + + + + - + +
ID Return valueIDReturn valueAssociated Command(s)
away away reason or undef if you are not awayawayaway reason or undef if you are not awayAWAY, BACK
channel current channel namechannelcurrent channel nameSETTAB
charset character-set used in the current contextcharsetcharacter-set used in the current contextCHARSET
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 serverhostreal hostname of the current server
id connection ididconnection id
inputbox contents of the inputboxinputboxcontents of the inputboxSETTEXT
libdirfsthe system wide directory where xchat will look for plugins. - this string is in the same encoding as the local file systemlibdirfsthe 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 knownmodesthe current channels modes or undef if not knownMODE
network current network name or undefnetworkcurrent network name or undef, this value is taken from the Network List
nick current nicknickcurrent nickNICK
nickserv nickserv password for this network or undefnickservnickserv 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_cursorcurrent inputbox cursor position in charactersstate_cursorcurrent inputbox cursor position in charactersSETCURSOR
topic current channel topictopiccurrent channel topicTOPIC
version xchat version numberversionxchat version number
win_statusstatus of the xchat window, possible values are "active", "hidden" - and "normal"win_statusstatus 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_ptrsimilar 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 encodingxchatdirfs 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 )