mirror of
https://github.com/moparisthebest/hexchat
synced 2024-12-22 15:48:52 -05:00
Cleanup, docs are online now, these are either irrelevant or outdated
This commit is contained in:
Berke Viktor
parent
a6d7cfab78
commit
96fe6bf2ca
@ -1,612 +0,0 @@
|
||||
# HexChat ChangeLog
|
||||
|
||||
|
||||
## 2.9.4 (2012-11-11)
|
||||
|
||||
* fix alerts when omit alerts in away option is set
|
||||
* fix dialog icon in userlist popup
|
||||
* fix opening links on Mac
|
||||
* fix default network in the Network List
|
||||
* fix initial folder in file dialogs
|
||||
* fix positioning the nick change dialog
|
||||
* fix error message for busy servers
|
||||
* fix filename encoding errors
|
||||
* fix Fedora spec file
|
||||
* fix Raw Log content being impossible to copy when auto-copy is disabled
|
||||
* fix rough icon rendering in most windows on Windows
|
||||
* fix config folder when specified with -d argument
|
||||
* add built-in support for SASL authentication via CAP
|
||||
* add support for identify-msg/multi-prefix server capabilities
|
||||
* add text events for CAP related messages
|
||||
* add support for the SysInfo plugin on Unix
|
||||
* add option to change update check frequency and delay for first check
|
||||
* add option to change GUI language on Windows
|
||||
* add Ignore entry to userlist popup
|
||||
* add Afrikaans, Asturian, Danish, Gujarati, Indonesian, Kinyarwanda and Malayalam translations
|
||||
* add ChangeLog and ReadMe links to Start Menu during installation on Windows
|
||||
* add manual page on Unix
|
||||
* add icon support for 3 levels above op user mode
|
||||
* change default colors, text events and user list/channel tree icons
|
||||
* make Esc key close the Raw Log window
|
||||
* use Consolas as the default font where available
|
||||
* open dialog window for double-clicking in the user list by default
|
||||
* variable separation, cleanup and renaming
|
||||
* check in the installers whether Windows release is supported by HexChat
|
||||
* display previous value after /SET
|
||||
* reorganize the Settings menu and add new options
|
||||
* redesign the About dialog
|
||||
* show certain help messages in GTK+ dialogs instead of command line
|
||||
* disable faulty one instance option
|
||||
* build system cosmetics on Unix
|
||||
* reorganize repo file structure
|
||||
* rebranding
|
||||
* update translations
|
||||
* update the network list
|
||||
|
||||
|
||||
## 2.9.3 (2012-10-14)
|
||||
|
||||
* fix various URL detection bugs
|
||||
* fix default folders for file transfers in portable mode
|
||||
* fix Autotools warnings with recent releases
|
||||
* add /ADDSERVER command
|
||||
* add option to save URLs to disk on-the-fly
|
||||
* add option to omit alerts when marked as being away
|
||||
* add default icons for channel tree and option to turn them off
|
||||
* change certain default colors
|
||||
* enhance Non-BMP filtering performance
|
||||
* accept license agreement by default on Windows
|
||||
* update the network list
|
||||
|
||||
|
||||
## 2.9.2 (2012-10-05)
|
||||
|
||||
* fix compilation on Red Hat and Fedora
|
||||
* fix portable to non-portable migrations on Windows
|
||||
* fix ban message in HexTray
|
||||
* fix icon in Connection Complete dialog
|
||||
* fix determining if the log folder path is full or relative
|
||||
* fix desktop notification icons on Unix
|
||||
* fix URL grabber saving an unlimited number of URLs by default
|
||||
* fix URL grabber memory leaks under certain circumstances
|
||||
* fix URL grabber trying to export URL lists to system folders by default
|
||||
* fix opening URLs without http(s)://
|
||||
* add support for regenerating text events during compilation on Windows
|
||||
* add support for the theme manager on Unix
|
||||
* add Unifont to the default list of alternative fonts
|
||||
* add option to retain colors in the topic
|
||||
* allow the installer to preserve custom GTK+ theme settings on Windows
|
||||
* use the icons subfolder of the config folder for loading custom icons
|
||||
* use port 6697 for SSL connections by default
|
||||
* install the SASL plugin by default on Windows
|
||||
* /lastlog improvements
|
||||
* build system cosmetics on Unix
|
||||
* open links with just left click by default
|
||||
* enable timestamps and include seconds by default
|
||||
* make libproxy an optional dependency on Unix
|
||||
* update German translation
|
||||
* update the network list
|
||||
|
||||
|
||||
## 2.9.1 (2012-07-27)
|
||||
|
||||
* fix installing/loading plugins on Unix
|
||||
* fix restoring the HexChat window via shortcuts on Windows
|
||||
* fix HexTray icon rendering for certain events
|
||||
* fix the Show marker line option in Preferences
|
||||
* fix /lastlog regexp support on Windows
|
||||
* add support for the Checksum, Do At, FiSHLiM and SASL plugins on Unix
|
||||
* add option to retain colors when displaying scrollback
|
||||
* add MS Gothic to the default list of alternative fonts
|
||||
* rebranding and cleanup
|
||||
* eliminate lots of compiler warnings
|
||||
* Unix build system fixes and cosmetics
|
||||
* make Git ignore Unix-specific intermediate files
|
||||
* use better compression for Windows installers
|
||||
* switch to GTK+ file dialogs on Windows
|
||||
* restructure the Preferences window
|
||||
* use the addons subfolder of the config folder for auto-loading plugins/scripts
|
||||
* improve the dialog used for opening plugins/scripts
|
||||
* remember user limits in channel list between sessions
|
||||
* remember last search pattern during sessions
|
||||
* update XChat to r1521
|
||||
|
||||
|
||||
## 2.9.0 (2012-07-14)
|
||||
|
||||
* rebranding
|
||||
* migrate code to GitHub
|
||||
* update XChat to r1515
|
||||
* fix x64 Perl interface installation for Perl 5.16
|
||||
* improve URL detection with new TLDs and file extensions
|
||||
|
||||
|
||||
## 1508-3 (2012-06-17)
|
||||
|
||||
* add XChat Theme Manager
|
||||
* fix problems with Turkish locale
|
||||
|
||||
|
||||
## 1508-2 (2012-06-15)
|
||||
|
||||
* add support for Perl 5.16
|
||||
* update Do At plugin
|
||||
* fix drawing of chat area bottom
|
||||
* avoid false hits when restoring from tray via shortcut
|
||||
* migrate from NMAKE to Visual Studio
|
||||
|
||||
|
||||
## 1508 (2012-06-02)
|
||||
|
||||
* remove Real Name from Network List
|
||||
* search window improvements
|
||||
* restore XChat-WDK from tray via shortcut if X-Tray is used
|
||||
|
||||
|
||||
## 1507 (2012-05-13)
|
||||
|
||||
* update OpenSSL to 1.0.1c
|
||||
* FiSHLiM updates
|
||||
|
||||
|
||||
## 1506 (2012-05-04)
|
||||
|
||||
* update OpenSSL to 1.0.1b
|
||||
* update German translation
|
||||
|
||||
|
||||
## 1503 (2012-03-16)
|
||||
|
||||
* update OpenSSL to 1.0.1
|
||||
* URL grabber updates
|
||||
* FiSHLiM updates
|
||||
|
||||
|
||||
## 1500 (2012-02-16)
|
||||
|
||||
* add option for specifying alternative fonts
|
||||
* fix crash due to invalid timestamp format
|
||||
* X-Tray cosmetics
|
||||
|
||||
|
||||
## 1499-7 (2012-02-08)
|
||||
|
||||
* fix update notifications
|
||||
* fix compilation on Linux
|
||||
* add IPv6 support to built-in identd
|
||||
|
||||
|
||||
## 1499-6 (2012-01-20)
|
||||
|
||||
* add DNS plugin
|
||||
|
||||
|
||||
## 1499-5 (2012-01-20)
|
||||
|
||||
* built-in fix for client crashes
|
||||
* update OpenSSL to 1.0.0g
|
||||
|
||||
|
||||
## 1499-4 (2012-01-18)
|
||||
|
||||
* add Non-BMP plugin to avoid client crashes
|
||||
|
||||
|
||||
## 1499-3 (2012-01-15)
|
||||
|
||||
* rework and extend plugin config API
|
||||
* add ADD/DEL/LIST support to X-SASL
|
||||
|
||||
|
||||
## 1499-2 (2012-01-11)
|
||||
|
||||
* add X-SASL plugin
|
||||
|
||||
|
||||
## 1499 (2012-01-09)
|
||||
|
||||
* fix saving FiSHLiM keys
|
||||
* update OpenSSL to 1.0.0f
|
||||
|
||||
|
||||
## 1498-4 (2011-12-05)
|
||||
|
||||
* fix updates not overwriting old files
|
||||
* display WinSys output in one line for others
|
||||
* use Strawberry Perl for building
|
||||
|
||||
|
||||
## 1498-3 (2011-12-02)
|
||||
|
||||
* add plugin config API
|
||||
* add Exec plugin
|
||||
* add WinSys plugin
|
||||
* perform periodic update checks automatically
|
||||
|
||||
|
||||
## 1498-2 (2011-11-25)
|
||||
|
||||
* add FiSHLiM plugin
|
||||
* add option to allow only one instance of XChat to run
|
||||
|
||||
|
||||
## 1498 (2011-11-23)
|
||||
|
||||
* separate x86 and x64 installers (uninstall any previous version!)
|
||||
* downgrade GTK+ to 2.16
|
||||
* re-enable the transparent background option
|
||||
* various X-Tray improvements
|
||||
* add WMPA plugin
|
||||
* add Do At plugin
|
||||
* automatically save set variables to disk by default
|
||||
* update OpenSSL to 1.0.0e
|
||||
|
||||
|
||||
## 1496-6 (2011-08-09)
|
||||
|
||||
* add option to auto-open new tab upon /msg
|
||||
* fix the update checker to use the git repo
|
||||
* disable update checker cache
|
||||
|
||||
|
||||
## 1496-5 (2011-08-07)
|
||||
|
||||
* fix attach/detach keyboard shortcut
|
||||
* add multi-language support to the spell checker
|
||||
|
||||
|
||||
## 1496-4 (2011-07-27)
|
||||
|
||||
* recognize Windows 8 when displaying OS info
|
||||
* update OpenSSL certificate list
|
||||
* fix X-Tray blinking on unselected events
|
||||
* fix X-Tray keyboard shortcut handling
|
||||
* cease support for Perl 5.10
|
||||
* use Strawberry Perl for 5.12 DLLs
|
||||
|
||||
|
||||
## 1496-3 (2011-06-16)
|
||||
|
||||
* add option for changing spell checker color
|
||||
|
||||
|
||||
## 1496-2 (2011-06-05)
|
||||
|
||||
* add support for custom license text
|
||||
|
||||
|
||||
## 1496 (2011-05-30)
|
||||
|
||||
* display build type in CTPC VERSION reply
|
||||
* add support for Perl 5.14
|
||||
|
||||
|
||||
## 1494 (2011-04-16)
|
||||
|
||||
* update Visual Studio to 2010 SP1
|
||||
* update OpenSSL to 1.0.0d
|
||||
* ship MySpell dictionaries in a separate installer
|
||||
|
||||
|
||||
## 1489 (2011-01-26)
|
||||
|
||||
* fix unloading the Winamp plugin
|
||||
* enable the Favorite Networks feature
|
||||
* add Channel Message event support to X-Tray
|
||||
* add mpcInfo plugin
|
||||
|
||||
|
||||
## 1486 (2011-01-16)
|
||||
|
||||
* fix a possible memory leak in the update checker
|
||||
* fix XChat-Text shortcut creation
|
||||
* fix XChat version check via the plugin interface
|
||||
* add option for limiting the size of files to be checksummed
|
||||
* add X-Tray as an install option
|
||||
* disable Plugin-Tray context menu completely
|
||||
|
||||
|
||||
## 1479-2 (2011-01-10)
|
||||
|
||||
* improve command-line argument support
|
||||
* add auto-copy options
|
||||
* enable XChat-Text
|
||||
* disable faulty tray menu items
|
||||
|
||||
|
||||
## 1479 (2010-12-29)
|
||||
|
||||
* update GTK+ to 2.22.1
|
||||
* update OpenSSL to 1.0.0c
|
||||
* update Python to 2.7.1
|
||||
* replace X-Tray with Plugin-Tray
|
||||
|
||||
|
||||
## 1469-3 (2010-10-20)
|
||||
|
||||
* add Checksum plugin
|
||||
* menu integration for Update Checker and Winamp
|
||||
|
||||
|
||||
## 1469-2 (2010-10-09)
|
||||
|
||||
* fix DCC file sending
|
||||
* native open/save dialogs
|
||||
* make the version info nicer
|
||||
* register XChat-WDK as IRC protocol handler
|
||||
* add option to run XChat-WDK after installation
|
||||
* disable erroneous uninstall warnings
|
||||
* disable Plugin-Tray, provide X-Tray only
|
||||
* cease support for Perl 5.8
|
||||
* replace EasyWinampControl with Winamp
|
||||
|
||||
|
||||
## 1469 (2010-10-08)
|
||||
|
||||
* use Visual C++ 2010 for all WDK builds
|
||||
* build Enchant with WDK and update it to 1.6.0
|
||||
* fix SSL validation
|
||||
* fix opening the config folder from GUI in portable mode
|
||||
* further improve dialog placement for closing network tabs
|
||||
|
||||
|
||||
## 1468-2 (2010-10-02)
|
||||
|
||||
* update GTK+ to 2.22
|
||||
* spelling support
|
||||
* more config compatibility with official build
|
||||
* improve dialog placement for closing network tabs
|
||||
* remove themes from the installer
|
||||
* disable toggle for favorite networks until it's usable
|
||||
* disable transparent backgrounds
|
||||
* hide mnemonic underlines until Alt key pressed
|
||||
* fix XP lagometer and throttlemeter rendering
|
||||
|
||||
|
||||
## 1468 (2010-09-19)
|
||||
|
||||
* update Perl to 5.12.2
|
||||
* update Tcl to 8.5.9
|
||||
* fix scrollback shrinking
|
||||
* enable advanced settings pane
|
||||
* retain emoticon settings
|
||||
* add /IGNALL command
|
||||
|
||||
|
||||
## 1464-6 (2010-09-06)
|
||||
|
||||
* fix Perl interface breakage
|
||||
* update checker plugin
|
||||
|
||||
|
||||
## 1464-5 (2010-08-30)
|
||||
|
||||
* primitive update checker
|
||||
|
||||
|
||||
## 1464-4 (2010-08-30)
|
||||
|
||||
* selectable tray icon
|
||||
* selectable theme for portable
|
||||
* selectable plugins
|
||||
|
||||
|
||||
## 1464-3 (2010-08-29)
|
||||
|
||||
* black theme for portable
|
||||
|
||||
|
||||
## 1464-2 (2010-08-29)
|
||||
|
||||
* make Perl version selectable during install
|
||||
|
||||
|
||||
## 1464 (2010-08-26)
|
||||
|
||||
* Perl interface updates
|
||||
|
||||
|
||||
## 1462 (2010-08-25)
|
||||
|
||||
* update XChat to r1462
|
||||
* build system cleanup
|
||||
|
||||
|
||||
## 1459-3 (2010-08-23)
|
||||
|
||||
* more installer changes (uninstall any previous version!)
|
||||
|
||||
|
||||
## 1459-2 (2010-08-23)
|
||||
|
||||
* universal installer
|
||||
* update build dependencies
|
||||
|
||||
|
||||
## 1459 (2010-08-19)
|
||||
|
||||
* portable mode and installer fixes
|
||||
|
||||
|
||||
## 1457 (2010-08-17)
|
||||
|
||||
* disable GUI warnings
|
||||
|
||||
|
||||
## 1455-2 (2010-08-17)
|
||||
|
||||
* unified installer for standard and portable
|
||||
|
||||
|
||||
## 1455 (2010-08-15)
|
||||
|
||||
* support for gtkwin_ptr in the Perl interface
|
||||
|
||||
|
||||
## 1454 (2010-08-14)
|
||||
|
||||
* gtkwin_ptr for plugins introduced
|
||||
|
||||
|
||||
## 1452 (2010-08-14)
|
||||
|
||||
* fix taskbar alerts on x86
|
||||
* upgrade Perl to 5.12 and make 5.8/5.10 builds available separately
|
||||
|
||||
|
||||
## 1451-6 (2010-08-12)
|
||||
|
||||
* include Lua-WDK with the installer
|
||||
|
||||
|
||||
## 1451-5 (2010-08-12)
|
||||
|
||||
* switch to Inno Setup (uninstall any previous version!)
|
||||
* add Lua support
|
||||
|
||||
|
||||
## 1451-4 (2010-08-11)
|
||||
|
||||
* enable the XDCC plugin
|
||||
|
||||
|
||||
## 1451-3 (2010-08-11)
|
||||
|
||||
* enable Python support
|
||||
|
||||
|
||||
## 1451-2 (2010-08-11)
|
||||
|
||||
* enable SSL support
|
||||
* fix simultaneous connections
|
||||
* re-enable identd by default
|
||||
|
||||
|
||||
## 1451 (2010-08-10)
|
||||
|
||||
* update XChat to r1451
|
||||
* disable identd by default
|
||||
* remove DNS plugin
|
||||
|
||||
|
||||
## 1444 (2010-07-30)
|
||||
|
||||
* update XChat to r1444
|
||||
* downgrade Tcl to 8.5
|
||||
* add Tcl support to the x64 build
|
||||
|
||||
|
||||
## 1441 (2010-06-15)
|
||||
|
||||
* update XChat to r1441
|
||||
* enable transfer of files bigger than 4 GB
|
||||
|
||||
|
||||
## 1439 (2010-05-30)
|
||||
|
||||
* update XChat to r1439 (2.8.8)
|
||||
|
||||
|
||||
## 1431-6 (2010-05-30)
|
||||
|
||||
* re-enable the transparent background option
|
||||
* add branding to Plugin-Tray
|
||||
* installer updates
|
||||
|
||||
|
||||
## 1431-5 (2010-05-29)
|
||||
|
||||
* fix installer
|
||||
* add DNS plugin status messages
|
||||
|
||||
|
||||
## 1431-4 (2010-05-28)
|
||||
|
||||
* disable the transparent background option
|
||||
* downgrade GTK+ to more stable 2.16
|
||||
|
||||
|
||||
## 1431-3 (2010-05-23)
|
||||
|
||||
* add portable build support
|
||||
|
||||
|
||||
## 1431-2 (2010-05-22)
|
||||
|
||||
* replace X-Tray with Plugin-Tray
|
||||
|
||||
|
||||
## 1431 (2010-05-21)
|
||||
|
||||
* update XChat to r1431
|
||||
* include a lot of XChat translations added since 2.8.6
|
||||
|
||||
|
||||
## 1412-3 (2010-05-02)
|
||||
|
||||
* fix GTK function call
|
||||
|
||||
|
||||
## 1412-2 (2010-05-02)
|
||||
|
||||
* re-enable taskbar alerts on x64
|
||||
|
||||
|
||||
## 1412 (2010-05-02)
|
||||
|
||||
* update XChat to r1412
|
||||
* update GTK+ and friends
|
||||
* update Visual Studio to 2010
|
||||
* fix Perl warning message
|
||||
* include GTK L10n with the installer
|
||||
|
||||
|
||||
## 1409-9 (2010-04-18)
|
||||
|
||||
* fix loading of scrollback
|
||||
|
||||
|
||||
## 1409-8 (2010-04-03)
|
||||
|
||||
* fix X-Tray on x64
|
||||
|
||||
|
||||
## 1409-7 (2010-04-02)
|
||||
|
||||
* disable taskbar notification options
|
||||
|
||||
|
||||
## 1409-6 (2010-03-31)
|
||||
|
||||
* display version numbers everywhere
|
||||
|
||||
|
||||
## 1409-5 (2010-03-31)
|
||||
|
||||
* add DNS plugin
|
||||
* add EasyWinampControl plugin
|
||||
* disable Plugin-Tray settings
|
||||
|
||||
|
||||
## 1409-4 (2010-03-30)
|
||||
|
||||
* add X-Tray
|
||||
|
||||
|
||||
## 1409-3 (2010-03-29)
|
||||
|
||||
* plugin linkage fixes
|
||||
|
||||
|
||||
## 1409-2 (2010-03-29)
|
||||
|
||||
* enable IPv6 support
|
||||
* enable NLS support
|
||||
* enable Perl support
|
||||
* enable Tcl support
|
||||
|
||||
|
||||
## 1409 (2010-03-29)
|
||||
|
||||
* initial release
|
||||
|
||||
@ -1,199 +0,0 @@
|
||||
# HexChat D-Bus Interface
|
||||
|
||||
For more help you can see the HexChat [plugin interface documentation](https://github.com/hexchat/hexchat/blob/master/share/doc/plugins.md). WARNING: The dbus interface may change in the future.
|
||||
|
||||
You can use the "/org/hexchat/Remote" object with interface "org.hexchat.plugin", but his context can be changed by other clients at any moment and you may receive signal asked by other clients. So for more complex usage it's better to get your own remote object. Using "Connect" method on interface "org.hexchat.connection"
|
||||
|
||||
## Available methods on _org.hexchat.connection_ interface:
|
||||
|
||||
* "Connect"
|
||||
* Parameters:
|
||||
* gchar\*: filename
|
||||
* gchar\*: name
|
||||
* gchar\*: description
|
||||
* gchar\*: version
|
||||
* Returns:
|
||||
* gchar\*: Your own object's path.
|
||||
|
||||
* "Disconnect"
|
||||
* No parameter, no return value. It frees your remote object.
|
||||
|
||||
## Available methods on _org.hexchat.plugin_ interface:
|
||||
|
||||
* "Command"
|
||||
* Parameters:
|
||||
* gchar\*: the command name without the "/". (e.g. "nick pseudo")
|
||||
|
||||
* "Print"
|
||||
* Parameters:
|
||||
* gchar\*: text to print on the HexChat window.
|
||||
|
||||
* "FindContext"
|
||||
* Parameters:
|
||||
* gchar\*: the server name. Can be NULL.
|
||||
* gchar\*: the channel name. Can be NULL.
|
||||
* Returns:
|
||||
* guint: context ID.
|
||||
|
||||
* "GetContext"
|
||||
* Returns:
|
||||
* guint: current context's ID.
|
||||
|
||||
* "SetContext"
|
||||
* Parameters:
|
||||
* guint: context ID to switch, returned by "FindContext" or "GetContext"
|
||||
* Returns:
|
||||
* gboolean:
|
||||
* 1: Success.
|
||||
* 0: Failure.
|
||||
|
||||
* "GetInfo"
|
||||
* Parameters:
|
||||
* gchar\*: ID of the information you want.
|
||||
* Returns:
|
||||
* gchar\*: information you requested.
|
||||
|
||||
* "GetPrefs"
|
||||
* Parameters:
|
||||
* gchar\*: Setting name required.
|
||||
* Returns:
|
||||
* int:
|
||||
* 0: Failed.
|
||||
* 1: Returned a string.
|
||||
* 2: Returned an integer.
|
||||
* 3: Returned a boolean.
|
||||
* gchar\*: the information requested if it's a string.
|
||||
* int: the information requested if it's a integer or boolean.
|
||||
|
||||
* "HookCommand"
|
||||
* Parameters:
|
||||
* gchar\*: Name of the command (without the forward slash).
|
||||
* int: Priority of this command.
|
||||
* gchar\*: String of text to display when the user executes /help for this command. May be NULL if you're lazy.
|
||||
* int: Value to returns when the command is catched. See HEXCHAT\_EAT\_*.
|
||||
* Returns:
|
||||
* guint: The ID of the hook.
|
||||
|
||||
* "HookServer"
|
||||
* Parameters:
|
||||
* gchar\*: Name of the server event.
|
||||
* int: Priority of this command.
|
||||
* int: Value to returns when the command is catched. See HEXCHAT\_EAT\_*.
|
||||
* Returns:
|
||||
* guint: The ID of the hook.
|
||||
|
||||
* "HookPrint"
|
||||
* Parameters:
|
||||
* gchar\*: Name of the print event.
|
||||
* int: Priority of this command.
|
||||
* int: Value to returns when the command is catched. See HEXCHAT\_EAT\_*.
|
||||
* Returns:
|
||||
* guint: The ID of the hook.
|
||||
|
||||
* "Unhook"
|
||||
* Parameters:
|
||||
* guint: ID of the hook to unhook.
|
||||
(the return value of "HookCommand", "HookServer" or "HookPrint")
|
||||
|
||||
* "ListGet"
|
||||
* Parameters:
|
||||
* gchar\*: The list name.
|
||||
* Returns:
|
||||
* guint: List ID.
|
||||
|
||||
* "ListNext"
|
||||
* Parameters:
|
||||
* guint: List ID returned by "ListGet".
|
||||
* Returns:
|
||||
* gboolean: says if there is no more item in the list.
|
||||
|
||||
* "ListStr"
|
||||
* Parameters:
|
||||
* guint: List ID returned by "ListGet".
|
||||
* gchar\*: Name of the information needed.
|
||||
* Returns:
|
||||
* gchar\*: The information requested.
|
||||
|
||||
Warning: "context" attribute of "channels" list should be get with "ListInt"
|
||||
|
||||
* "ListInt"
|
||||
* Parameters:
|
||||
* guint: List ID returned by "ListGet".
|
||||
* gchar\*: Name of the information needed.
|
||||
* Returns:
|
||||
* guint: The information requested.
|
||||
|
||||
* "ListTime"
|
||||
* Parameters:
|
||||
* guint: List ID returned by "ListGet".
|
||||
* gchar\*: Name of the information needed.
|
||||
* Returns:
|
||||
* guint64: The information requested.
|
||||
|
||||
* "ListFields"
|
||||
* Parameters:
|
||||
* gchar\*: The list name.
|
||||
* Returns:
|
||||
* gchar\*\*: information names in this list.
|
||||
|
||||
* "ListFree"
|
||||
* Parameters:
|
||||
* guint: List ID returned by "ListGet".
|
||||
|
||||
* "EmitPrint"
|
||||
* Parameters:
|
||||
* gchar\*: Text event to print.
|
||||
* gchar\*\*: NULL terminated array of string.
|
||||
* Returns:
|
||||
* gboolean:
|
||||
* 1: Success.
|
||||
* 0: Failure.
|
||||
|
||||
* "Nickcmp"
|
||||
* Parameters:
|
||||
* gchar\*: String to compare.
|
||||
* gchar\*: String to compare.
|
||||
* Returns:
|
||||
* int: An integer less than, equal to, or greater than zero if s1 is found, respectively, to be less than, to match, or be greater than s2.
|
||||
|
||||
* "Strip"
|
||||
* Parameters:
|
||||
* gchar\*: String to strip.
|
||||
* int: Length of the string (or -1 for NULL terminated).
|
||||
* int: Bit-field of flags:
|
||||
* 0: Strip mIRC colors.
|
||||
* 1: Strip text attributes.
|
||||
* Returns:
|
||||
* gchar\*: stripped string.
|
||||
|
||||
* "SendModes"
|
||||
* Parameters:
|
||||
* gchar\*\*: NULL terminated array of targets (strings). The names of people whom the action will be performed on.
|
||||
* int: Maximum modes to send per line.
|
||||
* gchar: Mode sign, '-' or '+'.
|
||||
* gchar: Mode char, e.g. 'o' for Ops.
|
||||
|
||||
## Available signals:
|
||||
|
||||
* "ServerSignal"
|
||||
* Parameters:
|
||||
* gchar\*\*: word returned by HexChat.
|
||||
* gchar\*\*: word_eol returned by HexChat.
|
||||
* guint: the ID of the hook (the return value of "HookServer").
|
||||
* guint: the ID of the context where the event come from.
|
||||
|
||||
* "CommandSignal"
|
||||
* Parameters:
|
||||
* gchar\*\*: word returned by HexChat.
|
||||
* gchar\*\*: word_eol returned by HexChat.
|
||||
* guint: the ID of the hook (the return value of "HookCommand").
|
||||
* guint: the ID of the context where the event come from.
|
||||
|
||||
* "PrintSignal"
|
||||
* Parameters:
|
||||
* gchar\*\*: word returned by HexChat.
|
||||
* guint: the ID of the hook (the return value of "HookPrint").
|
||||
* guint: the ID of the context where the event come from.
|
||||
|
||||
* "UnloadSignal"
|
||||
* Emitted when the user asks to unload your program. Please exit(0); when received!
|
||||
318
share/doc/faq.md
318
share/doc/faq.md
@ -1,318 +0,0 @@
|
||||
# HexChat Frequently Asked Questions
|
||||
|
||||
## Using HexChat
|
||||
|
||||
### How do I autoconnect and join a channel when HexChat loads?
|
||||
|
||||
In the Network list select the Network you want to auto-connect to and
|
||||
click Edit and turn ON the "Auto connect to this network at startup"
|
||||
checkbox.
|
||||
|
||||
List channels in the favorites list to join them on connect.
|
||||
|
||||
|
||||
### Why does HexChat join channels before identifying?
|
||||
|
||||
When using the nickserv password HexChat waits a short time before joining.
|
||||
To change this value (which is in seconds) by running:
|
||||
> /set irc\_join\_delay number
|
||||
|
||||
The other option is SASL which is network dependent and can be enabled in the Network list (2.9.4+).
|
||||
|
||||
|
||||
### How do I connect through a proxy?
|
||||
|
||||
Go to the menus, _Settings_ `->` _Preferences_ `->` _Network Setup_ and fill in
|
||||
the requested information there. Authentication (using a username and
|
||||
password) is only supported for HTTP and Socks5.
|
||||
|
||||
|
||||
### How do I show @ and + in front of nicknames that are Op and Voice when they talk?
|
||||
|
||||
To display @ and + characters next to nicknames as they talk, do the
|
||||
following:
|
||||
|
||||
In the menus, open up _Settings_ `->` _Text Events_. Find the
|
||||
_Channel Message_ event in the list. The $3 code can be inserted to
|
||||
print the user's mode-character (e.g. @ or +). For example, you might
|
||||
want to change the default:
|
||||
|
||||
> %C18%H<%H$4$1%H>%H%O$t$2
|
||||
|
||||
To
|
||||
|
||||
> %C18%H<%H$4$3$1%H>%H%O$t$2
|
||||
|
||||
Don't forget to **press Enter**, so the changes take effect in the list at
|
||||
the top of the window.
|
||||
|
||||
|
||||
### How do I change the Op and Voice userlist icons and Tree View icons?
|
||||
|
||||
HexChat allows you to override the default icons. To use this feature, first create the required folder:
|
||||
|
||||
* Unix/Linux
|
||||
|
||||
> ~/.config/hexchat/icons
|
||||
|
||||
* Windows
|
||||
|
||||
> %APPDATA%\\HexChat\\icons
|
||||
|
||||
The required file names:
|
||||
|
||||
* **tray icon:**
|
||||
|
||||
* tray\_fileoffer.png
|
||||
* tray\_highlight.png
|
||||
* tray\_message.png
|
||||
* hexchat.png
|
||||
|
||||
* **channel tree:**
|
||||
|
||||
* tree\_channel.png
|
||||
* tree\_dialog.png
|
||||
* tree\_server.png
|
||||
* tree\_util.png _(Channel List, DCC, etc (if enabled as tabs))_
|
||||
|
||||
* **user list:**
|
||||
|
||||
* ulist\_voice.png
|
||||
* ulist\_halfop.png
|
||||
* ulist\_op.png
|
||||
* ulist\_owner.png _(1 level above op)_
|
||||
* ulist\_founder.png _(2 levels above op)_
|
||||
* ulist\_netop.png _(3 levels above op)_
|
||||
|
||||
You can hide either of them in _Preferences_.
|
||||
|
||||
|
||||
### How do I set different ban types?
|
||||
|
||||
1. Right click the nickname in the userlist, and choose a ban type from the "Kick/Ban" submenu.
|
||||
|
||||
2. You can also do it manually:
|
||||
> /ban nick bantype where the bantype is a number from 0 to 3.
|
||||
3. Or set the default with:
|
||||
|
||||
> /set irc\_ban\_type bantype sets the default ban type to use for all bans. The different types are:
|
||||
>
|
||||
> - 0 = \*!*@*.host
|
||||
> - 1 = \*!*@domain
|
||||
> - 2 = \*!*user@*.host
|
||||
> - 3 = \*!*user@domain
|
||||
|
||||
|
||||
### Why does the timestamp overlap some nicknames?
|
||||
|
||||
Some networks allow very long nicknames (up to 32 letters). It can be
|
||||
annoying to have the separator bar move too far to the right, just for
|
||||
one long nick. Therefore, it has a set limit for the distance it will
|
||||
move to the right. If you use a large font, you may need to adjust this
|
||||
distance. It is set in pixels, for example:
|
||||
|
||||
> /set text\_max\_indent 320
|
||||
|
||||
Once you adjust this setting high enough, overlapping timestamps and
|
||||
nicknames should not occur. The adjustment will not take effect
|
||||
immediately, a restart may be needed.
|
||||
|
||||
|
||||
### How do I turn on Conference mode where I will not see join or part messages?
|
||||
|
||||
Right-click on the tab you want to change. In the submenu of the channel
|
||||
name, there's a toggle-item "Show join/part messages", simply turn this
|
||||
off.
|
||||
|
||||
If you want to turn this option on globally go to _Preferences_ `->` _Advanced_.
|
||||
|
||||
Then all channels you join **after** setting this will start with "Show
|
||||
join/part messages" turned off.
|
||||
|
||||
|
||||
### Why doesn't DCC send work behind a router (IPNat/ADSL)?
|
||||
|
||||
If you are behind a IP-NAT or ADSL router, you will most likely have an
|
||||
address like 192.168.0.1. This address is not usable on the Internet,
|
||||
and must be translated.
|
||||
|
||||
When offering a DCC file, HexChat will tell the receiver your address.
|
||||
If it says 192.168.0.1, the receiver will not be able to connect. One
|
||||
way to make it send your "real" address is to enable the "Get my IP from
|
||||
IRC Server" option in HexChat. This option is available in
|
||||
_Preferences_ `->` _File Transfers_. When you turn it ON, you will have
|
||||
to re-login to the server before it'll take effect.
|
||||
|
||||
You will also need to forward some ports for use in DCC send. You may
|
||||
pick almost any port range you wish, for example, in HexChat set:
|
||||
|
||||
> First DCC send port: 4990
|
||||
> Last DCC send port: 5000
|
||||
|
||||
This will allow you to send up to ten files at the same time, which
|
||||
should be plenty for most people. Lastly, configure your router/modem to
|
||||
forward ports 4990-5000 to your PC's address. You'll have to consult
|
||||
your router/modem's manual on how to do this.
|
||||
|
||||
|
||||
### How do I execute multiple commands in one line?
|
||||
|
||||
There are three ways to do this:
|
||||
|
||||
* /LOAD -e <textfile>, where <textfile> is a full pathname to a
|
||||
file containing commands on each line.
|
||||
|
||||
* Separate your commands with CTRL-SHIFT-u-a. This will appear as a little box with numbers onit.
|
||||
|
||||
* You can create two UserCommands, with the same name, and then execute the UserCommand.
|
||||
It will be executed in the same order as it's written in the UserCommands GUI.
|
||||
|
||||
|
||||
### I get this error: "Unknown file type abc.yz. Maybe you need to install the Perl or Python plugin?"
|
||||
|
||||
If you get this error when trying to load a Perl or Python script, it
|
||||
means the plugin for running those scripts isn't loaded.
|
||||
|
||||
* The Perl, Python and TCL plugins come with HexChat in the same archive.
|
||||
* During ./configure, it will check for Perl, Python and TCL libs and headers, you should check if it failed there.
|
||||
* The plugins directory can be found by issuing the shell command
|
||||
> hexchat -p
|
||||
* All *.so files are auto-loaded at startup (*.dll on Windows).
|
||||
* If you downloaded a binary package, maybe the packager decided to exclude the Perl or Python plugins.
|
||||
|
||||
|
||||
### How do I play sound files on certain events?
|
||||
|
||||
In the menus, go to: _Settings_ `->` _Preferences_ `->` _Sound_. Select the event
|
||||
you want to make a sound on, then type in a sound filename (or use the Browse button).
|
||||
|
||||
|
||||
### How do I auto-load scripts at startup?
|
||||
|
||||
The root of your HexChat config is:
|
||||
|
||||
* Windows: %APPDATA%\\HexChat
|
||||
* Unix/Linux: ~/.config/hexchat
|
||||
|
||||
Referred to as <config> from now. HexChat automatically loads, at startup:
|
||||
|
||||
* <config>/addons/*.lua Lua scripts
|
||||
* <config>/addons/*.pl Perl scripts
|
||||
* <config>/addons/*.py Python scripts
|
||||
* <config>/addons/*.tcl Tcl scripts
|
||||
* <config>/addons/*.dll Plugins (Windows)
|
||||
* <config>/addons/*.so Plugins (Unix)
|
||||
|
||||
You may need to create the _addons_ folder manually.
|
||||
|
||||
### How do I minimize HexChat to the System Tray (Notification Area)?
|
||||
|
||||
On both Unix and Windows there is an included tray plugin. To enable minimizing to tray on exit:
|
||||
|
||||
> /set gui\_tray\_close on
|
||||
|
||||
For minimizing to tray on minimize:
|
||||
|
||||
> /set gui\_tray\_minimize on
|
||||
|
||||
Alerts for this tray are in _Preferences_ `->` _Alerts_.
|
||||
|
||||
The other option is Windows only, called HexTray. It is included with the installer.
|
||||
Right click on the tray icon for its options.
|
||||
|
||||
|
||||
### Where are the log files saved to?
|
||||
|
||||
* Unix/Linux
|
||||
|
||||
> ~/.config/hexchat/logs
|
||||
|
||||
* Windows
|
||||
|
||||
> %APPDATA%\\HexChat\\logs
|
||||
|
||||
|
||||
### How do I rotate log files every so often?
|
||||
|
||||
By default settings, no rotation occurs, your log files will just keep getting larger.
|
||||
|
||||
Go to _Settings_ `->` _Preferences_ `->` _Logging_ and change the log filename to any one of these:
|
||||
|
||||
> %Y-%m-%d/%n-%c.log ->2006-12-30/FreeNode-\#channel.log
|
||||
>
|
||||
> %n/%Y-%m-%d/%c.log ->FreeNode/2006-12-30/\#channel.log
|
||||
>
|
||||
> %n/%c.log -> FreeNode/\#channel.log (no rotation)
|
||||
|
||||
%Y, %m and %d represents the current year, month and day respectively.
|
||||
%n is the network name, e.g. "FreeNode" or "UnderNet", and finally, %c
|
||||
is the channel. In these examples, a new log filename and folder would
|
||||
be created after midnight.
|
||||
|
||||
You can find more possibilities at [http://xchat.org/docs/log/](http://xchat.org/docs/log/).
|
||||
|
||||
|
||||
### Where did the Real Name field go?
|
||||
|
||||
The real name field is now removed from the Network List. This is in
|
||||
order to avoid alienating newcomers (some might be afraid of their
|
||||
personal data).
|
||||
|
||||
The network-specific real name can still be set via the GUI. If you want
|
||||
to modify the global real name, just issue the following command:
|
||||
|
||||
> /set irc\_real\_name Stewie Griffin
|
||||
|
||||
|
||||
### How do I migrate my settings from XChat?
|
||||
|
||||
* UNIX/Linux
|
||||
|
||||
> 1. Copy ~/.xchat2 to ~/.config/hexchat
|
||||
> 2. Rename ~/.config/hexchat/xchat.conf to ~/.config/hexchat/hexchat.conf
|
||||
> 3. Rename ~/.config/hexchat/xchatlogs to ~/.config/hexchat/logs
|
||||
> 4. Move all your 3rd party addons to ~/.config/hexchat/addons
|
||||
> 5. Rename ~/.config/hexchat/plugin\_\*.conf to ~/.config/hexchat/addon\_\*.conf
|
||||
|
||||
* Windows
|
||||
|
||||
> 1. Copy %APPDATA%\\X-Chat 2 to %APPDATA%\\HexChat
|
||||
> 2. Rename %APPDATA%\\HexChat\\xchat.conf to %APPDATA%\\HexChat\\hexchat.conf
|
||||
> 3. Rename %APPDATA%\\HexChat\\xchatlogs to %APPDATA%\\HexChat\\logs
|
||||
> 4. Move all your 3rd party addons to %APPDATA%\\HexChat\\addons
|
||||
> 5. Rename %APPDATA%\\HexChat\\plugin\_\*.conf to %APPDATA%\\HexChat\\addon\_\*.conf
|
||||
|
||||
|
||||
## Contributions, Development and Bugs.
|
||||
|
||||
|
||||
### I found a bug, what can I do?
|
||||
|
||||
Firstly, make sure it's the latest stable version of HexChat.
|
||||
|
||||
If you still experience issues, you can search for the issue on
|
||||
[GitHub](https://github.com/hexchat/hexchat/issues?state=open)
|
||||
if it has not been reported open an issue with as much detail as possible.
|
||||
|
||||
|
||||
### Can I write a new language translation for HexChat?
|
||||
|
||||
You sure can, but I don't accept translations directly. They must be
|
||||
done through the
|
||||
[Transifex Project](https://www.transifex.com/projects/p/hexchat/).
|
||||
You simply register on the site, then you can apply for membership in a translation
|
||||
team via the web interface. Approvals are done manually so it might take a few days
|
||||
for you to be approved. Also bear in mind that the email address with which you
|
||||
register on Transifex will be visible in the translation files.
|
||||
|
||||
If you want to test your translation in action:
|
||||
|
||||
* Download your translation from Transifex
|
||||
* Open the downloaded _.po_ file with [Poedit](http://www.poedit.net/)
|
||||
* Simply press _Save_ in Poedit, which causes it to generate a _.mo_ file next to the _.po_ file
|
||||
* Copy the generated _.mo_ file to _HexChat \ locale \ <language code> \ LC\_MESSAGES \ hexchat.mo_
|
||||
* Restart HexChat
|
||||
|
||||
***
|
||||
|
||||
For pretty html: `pandoc --toc -s faq.md -o faq.html`
|
||||
@ -1,927 +0,0 @@
|
||||
# HexChat Perl Interface
|
||||
|
||||
|
||||
## Introduction
|
||||
|
||||
This is the Perl interface for HexChat. If there are any problems, questions, comments or
|
||||
suggestions please email them to the address on the bottom of this page.
|
||||
|
||||
|
||||
## Constants
|
||||
|
||||
|
||||
###Priorities
|
||||
|
||||
* **`Xchat::PRI_HIGHEST`**
|
||||
* **`Xchat::PRI_HIGH`**
|
||||
* **`Xchat::PRI_NORM`**
|
||||
* **`Xchat::PRI_LOW`**
|
||||
* **`Xchat::PRI_LOWEST`**
|
||||
|
||||
|
||||
### Return values
|
||||
|
||||
* **`Xchat::EAT_NONE`** - pass the event along
|
||||
* **`Xchat::EAT_XCHAT`** - don't let HexChat see this event
|
||||
* **`Xchat::EAT_PLUGIN`** - don't let other scripts and plugins see this event but xchat will still see it
|
||||
* **`Xchat::EAT_ALL`** - don't let anything else see this event
|
||||
|
||||
|
||||
#### Timer and fd hooks
|
||||
|
||||
* **`Xchat::KEEP`** - keep the timer going or hook watching the handle
|
||||
* **`Xchat::REMOVE`** - remove the timer or hook watching the handle
|
||||
|
||||
|
||||
### hook\_fd flags
|
||||
|
||||
* **`Xchat::FD_READ`** - invoke the callback when the handle is ready for reading
|
||||
* **`Xchat::FD_WRITE`** - invoke the callback when the handle is ready for writing
|
||||
* **`Xchat::FD_EXCEPTION`** - invoke the callback if an exception occurs
|
||||
* **`Xchat::FD_NOTSOCKET`** - indicate that the handle being hooked is not a socket
|
||||
|
||||
## Functions
|
||||
|
||||
### `Xchat::register( $name, $version, [$description,[$callback]] )`
|
||||
|
||||
* `$name` - The name of this script
|
||||
* `$version` - This script's version
|
||||
* `$description` - A description for this script
|
||||
* `$callback` - This is a function that will be called when the is script
|
||||
unloaded. This can be either a reference to a
|
||||
function or an anonymous sub reference.
|
||||
|
||||
This is the first thing to call in every script.
|
||||
|
||||
### `Xchat::hook_server( $message, $callback, [\%options] )`
|
||||
|
||||
### `Xchat::hook_command( $command, $callback, [\%options] )`
|
||||
|
||||
### `Xchat::hook_print( $event,$callback, [\%options] )`
|
||||
|
||||
### `Xchat::hook_timer( $timeout,$callback, [\%options | $data] )`
|
||||
|
||||
### `Xchat::hook_fd( $handle, $callback, [ \%options ] )`
|
||||
|
||||
These functions can be to intercept various events.
|
||||
hook\_server can be used to intercept any incoming message from the IRC server.
|
||||
hook\_command can be used to intercept any command, if the command doesn't currently exist then a new one is created.
|
||||
hook\_print can be used to intercept any of the events listed in _Setttings_ `->` _Text Events_.
|
||||
hook\_timer can be used to create a new timer
|
||||
|
||||
* **`$message`** - server message to hook such as PRIVMSG
|
||||
* **`$command`** - command to intercept, without the leading /
|
||||
* **`$event`** - one of the events listed in _Settings_ `->` _Text Events_
|
||||
* **`$timeout`** - timeout in milliseconds
|
||||
* **`$handle`** - the I/O handle you want to monitor with hook\_fd. This must be something that has a fileno. See perldoc -f fileno or [fileno](http://perldoc.perl.org/functions/fileno.html)
|
||||
* **`$callback`** - callback function, this is called whenever
|
||||
the hooked event is trigged, the following are
|
||||
the conditions that will trigger the different hooks.
|
||||
This can be either a reference to a
|
||||
function or an anonymous sub reference.
|
||||
* **`\%options`** - a hash reference containing addional options for the hooks
|
||||
|
||||
Valid keys for \%options:
|
||||
|
||||
<table border="1"> <tr>
|
||||
<td>data</td> <td>Additional data that is to be associated with the<br />
|
||||
hook. For timer hooks this value can be provided either as<br />
|
||||
<code>Xchat::hook_timer( $timeout, $cb,{data=>$data})</code><br />
|
||||
or <code>Xchat::hook_timer( $timeout, $cb, $data )</code>.<br />
|
||||
However, this means that hook_timer cannot be provided<br />
|
||||
with a hash reference containing data as a key.<br /> example:<br />
|
||||
my $options = { data => [@arrayOfStuff] };<br />
|
||||
Xchat::hook_timer( $timeout, $cb, $options );<br />
|
||||
<br />
|
||||
In this example, the timer's data will be<br />
|
||||
[@arrayOfStuff] and not { data => [@arrayOfStuff] }<br />
|
||||
<br />
|
||||
This key is valid for all of the hook functions.<br />
|
||||
<br />
|
||||
Default is undef.<br />
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>priority</td> <td>Sets the priority for the hook.<br />
|
||||
It can be set to one of the
|
||||
<code>Xchat::PRI_*</code> constants.<br />
|
||||
<br />
|
||||
This key only applies to server, command
|
||||
and print hooks.<br />
|
||||
<br />
|
||||
Default is <code>Xchat::PRI_NORM</code>.
|
||||
</td> </tr> <tr>
|
||||
<td>help_text</td> <td>Text displayed for /help $command.<br />
|
||||
<br />
|
||||
This key only applies to command hooks.<br />
|
||||
<br />
|
||||
Default is "".
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>flags</td> <td>Specify the flags for a fd hook.<br />
|
||||
<br />
|
||||
See <a href="#hook_fd_flags">hook fd flags</a> section for valid values.<br />
|
||||
<br />
|
||||
On Windows if the handle is a pipe you specify<br />
|
||||
Xchat::FD_NOTSOCKET in addition to any other flags you might be using.<br />
|
||||
<br />
|
||||
This key only applies to fd hooks.<br />
|
||||
Default is Xchat::FD_READ
|
||||
</td>
|
||||
</tr></table><p>
|
||||
|
||||
|
||||
#### When callbacks are invoked
|
||||
|
||||
Each of the hooks will be triggered at different times depending on the type
|
||||
of hook.
|
||||
|
||||
<table border="1"> <tr style="background-color: #dddddd">
|
||||
<td>Hook Type</td> <td>When the callback will be invoked</td>
|
||||
</tr> <tr>
|
||||
<td>server hooks</td> <td>a <code>$message</code> message is
|
||||
received from the server
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>command hooks</td> <td>the <code>$command</code> command is
|
||||
executed, either by the user or from a script
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>print hooks</td> <td>X-Chat is about to print the message for the
|
||||
<code>$event</code> event
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>timer hooks</td> <td>called every <code>$timeout</code> milliseconds
|
||||
(1000 millisecond is 1 second)<br />
|
||||
the callback will be executed in the same context where
|
||||
the hook_timer was called, if the context no longer exists
|
||||
then it will execute in a random context
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>fd hooks</td> <td>depends on the flags that were passed to hook_fd<br />
|
||||
See <a href="#hook_fd_flags">hook_fd flags</a> section.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
The value return from these hook functions can be passed to `Xchat::unhook` to remove the hook.
|
||||
|
||||
|
||||
#### Callback Arguments
|
||||
|
||||
All callback functions will receive their arguments in `@_` like every other Perl subroutine.
|
||||
|
||||
Server and command callbacks
|
||||
|
||||
`$_[0]` - array reference containing the IRC message or command and arguments broken into words
|
||||
example:
|
||||
/command arg1 arg2 arg3
|
||||
`$_[0][0]` - command
|
||||
`$_[0][1]` - arg1
|
||||
`$_[0][2]` - arg2
|
||||
`$_[0][3]` - arg3
|
||||
|
||||
`$_[1]` - array reference containing the Nth word to the last word
|
||||
example:
|
||||
/command arg1 arg2 arg3
|
||||
`$_[1][0]` - command arg1 arg2 arg3
|
||||
`$_[1][1]` - arg1 arg2 arg3
|
||||
`$_[1][2]` - arg2 arg3
|
||||
`$_[1][3]` - arg3
|
||||
|
||||
`$_[2]` - the data that was passed to the hook function
|
||||
|
||||
Print callbacks
|
||||
|
||||
`$_[0]` - array reference containing the values for the text event, see _Settings_ `->` _Text Events_
|
||||
`$_[1]` - the data that was passed to the hook function
|
||||
|
||||
Timer callbacks
|
||||
|
||||
`$_[0]` - the data that was passed to the hook function
|
||||
|
||||
fd callbacks
|
||||
|
||||
`$_[0]` - the handle that was passed to hook\_fd
|
||||
`$_[1]` - flags indicating why the callback was called
|
||||
`$_[2]` - the data that was passed to the hook function
|
||||
|
||||
|
||||
#### Callback return values
|
||||
|
||||
All server, command and print callbacks should return one of the `Xchat::EAT_*` constants.
|
||||
Timer callbacks can return `Xchat::REMOVE` to remove the timer or `Xchat::KEEP` to keep it going.
|
||||
|
||||
|
||||
#### Miscellaneous Hook Related Information
|
||||
|
||||
For server hooks, if `$message` is "RAW LINE" then `$cb`> will be called for every IRC message that HexChat receives.
|
||||
|
||||
For command hooks if `$command` is "" then `$cb` will be called for messages entered by the user that is not a command.
|
||||
|
||||
For print hooks besides those events listed in _Settings_ `->` _Text Events_, these additional events can be used.
|
||||
|
||||
<table border="1"> <tr style="background-color: #dddddd">
|
||||
<td>Event</td> <td>Description</td>
|
||||
</tr> <tr>
|
||||
<td>"Open Context"</td> <td>a new context is created</td>
|
||||
</tr> <tr>
|
||||
<td>"Close Context"</td> <td>a context has been close</td>
|
||||
</tr> <tr>
|
||||
<td>"Focus Tab"</td> <td>when a tab is brought to the front</td>
|
||||
</tr> <tr>
|
||||
<td>"Focus Window"</td> <td>when a top level window is focused or the
|
||||
main tab window is focused by the window manager
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>"DCC Chat Text"</td> <td>when text from a DCC Chat arrives.
|
||||
<code>$_[0]</code> will have these values<br />
|
||||
<br />
|
||||
<code>$_[0][0]</code> - Address<br />
|
||||
<code>$_[0][1]</code> - Port<br />
|
||||
<code>$_[0][2]</code> - Nick<br />
|
||||
<code>$_[0][3]</code> - Message<br />
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>"Key Press"</td> <td>used for intercepting key presses<br />
|
||||
$_[0][0] - key value<br />
|
||||
$_[0][1] - state bitfield, 1 - shift, 4 - control, 8 - alt<br />
|
||||
$_[0][2] - string version of the key which might be empty for unprintable keys<br />
|
||||
$_[0][3] - length of the string in $_[0][2]<br />
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
### `Xchat::unhook( $hook )`
|
||||
|
||||
|
||||
* **`$hook` - the hook that was previously returned by one of the `Xchat::hook_*` functions**
|
||||
|
||||
This function is used to removed a hook previously added with one of the `Xchat::hook_*` functions.
|
||||
|
||||
It returns the data that was passed to the `Xchat::hook_*` function when the hook was added.
|
||||
|
||||
|
||||
### `Xchat::print( $text | \@lines, [$channel,[$server]] )`
|
||||
|
||||
* **`$text` - the text to print**
|
||||
* **`\@lines` - array reference containing lines of text to be printed all the elements will be joined together before printing**
|
||||
* **`$channel` - channel or tab with the given name where `$text` will be printed**
|
||||
* **`$server` - specifies that the text will be printed in a channel or tab that is associated with `$server`**
|
||||
|
||||
The first argument can either be a string or an array reference of strings.
|
||||
Either or both of `$channel` and `$server` can be undef.
|
||||
|
||||
If called as `Xchat::print( $text )`, it will always return true.
|
||||
If called with either the channel or the channel and the server
|
||||
specified then it will return true if a context is found and
|
||||
false otherwise. The text will not be printed if the context
|
||||
is not found. The meaning of setting `$channel` or `$server` to
|
||||
undef is the same as find\_context.
|
||||
|
||||
|
||||
### `Xchat::printf( $format, LIST )`
|
||||
|
||||
* **`$format` - a format string, see "perldoc -f [sprintf](http://perldoc.perl.org/functions/sprintf.html)" for further details**
|
||||
* **`LIST` - list of values for the format fields**
|
||||
|
||||
|
||||
### `Xchat::command( $command | \@commands, [$channel,[$server]] )`
|
||||
|
||||
* **`$command` - the command to execute, without the leading /**
|
||||
* **`\@commands` - array reference containing a list of commands to execute**
|
||||
* **`$channel` - channel or tab with the given name where `$command` will be executed**
|
||||
* **`$server` - specifies that the command will be executed in a channel or tab that is associated with `$server`**
|
||||
|
||||
The first argument can either be a string or an array reference of strings.
|
||||
Either or both of `$channel` and `$server` can be undef.
|
||||
|
||||
If called as `Xchat::command( $command )`, it will always return true.
|
||||
If called with either the channel or the channel and the server
|
||||
specified then it will return true if a context is found and false
|
||||
otherwise. The command will not be executed if the context is not found.
|
||||
The meaning of setting `$channel` or `$server` to undef is the same as find\_context.
|
||||
|
||||
|
||||
### `Xchat::commandf( $format, LIST )`
|
||||
|
||||
* **`$format` - a format string, see "perldoc -f [sprintf](http://perldoc.perl.org/functions/sprintf.html)" for further details**
|
||||
* **`LIST` - list of values for the format fields**
|
||||
|
||||
|
||||
### `Xchat::find_context( [$channel, [$server]] )`
|
||||
|
||||
* **`$channel` - name of a channel**
|
||||
* **`$server` - name of a server**
|
||||
|
||||
Either or both of `$channel` and `$server` can be undef. Calling
|
||||
`Xchat::find_context()` is the same as calling `Xchat::find_context( undef, undef)` and
|
||||
`Xchat::find_context( $channel )` is the same as `Xchat::find_context( $channel, undef )`.
|
||||
|
||||
If `$server` is undef, find any channel named `$channel`. If `$channel` is undef, find the front most window
|
||||
or tab named `$server`.If both `$channel` and `$server` are undef, find the currently focused tab or window.
|
||||
|
||||
Return the context found for one of the above situations or undef if such
|
||||
a context cannot be found.
|
||||
|
||||
|
||||
### `Xchat::get_context()`
|
||||
|
||||
Returns the current context.
|
||||
|
||||
|
||||
### `Xchat::set_context( $context | $channel,[$server] )`
|
||||
|
||||
* **`$context` - context value as returned from `get_context`, `find_context` or one
|
||||
of the fields in the list of hashrefs returned by `list_get`**
|
||||
* **`$channel` - name of a channel you want to switch context to**
|
||||
* **`$server` - name of a server you want to switch context to**
|
||||
|
||||
See `find_context` for more details on `$channel` and `$server`.
|
||||
|
||||
Returns true on success, false on failure.
|
||||
|
||||
|
||||
### `Xchat::get_info( $id )`
|
||||
|
||||
* **`$id` - one of the following case sensitive values**
|
||||
|
||||
<table border="1"> <tr style="background-color: #dddddd">
|
||||
<td>ID</td>
|
||||
<td>Return value</td>
|
||||
<td>Associated Command(s)</td>
|
||||
</tr> <tr>
|
||||
<td>away</td>
|
||||
<td>away reason or undef if you are not away</td>
|
||||
<td>AWAY, BACK</td>
|
||||
</tr> <tr>
|
||||
<td>channel</td>
|
||||
<td>current channel name</td>
|
||||
<td>SETTAB</td>
|
||||
</tr> <tr>
|
||||
<td>charset</td>
|
||||
<td>character-set used in the current context</td>
|
||||
<td>CHARSET</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>configdir</td> <td>HexChat config directory encoded in UTF-8. Examples:<br />
|
||||
/home/user/.config/hexchat<br />
|
||||
C:\Users\user\Appdata\Roaming\HexChat
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>event_text <Event Name></td> <td>text event format string for <Event name><br />
|
||||
Example:
|
||||
<div class="example synNormal"><div class='line_number'>
|
||||
<div>1</div>
|
||||
</div>
|
||||
<div class='content'><pre><span class="synStatement">my</span> <span class="synIdentifier">$channel_msg_format</span> = Xchat::get_info( <span class="synStatement">"</span><span class="synConstant">event_text Channel Message</span><span class="synStatement">"</span> );
|
||||
</pre></div>
|
||||
</div>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host</td>
|
||||
<td>real hostname of the current server</td>
|
||||
<td></td>
|
||||
</tr><tr>
|
||||
<td>id</td>
|
||||
<td>connection id</td>
|
||||
<td></td>
|
||||
</tr><tr>
|
||||
<td>inputbox</td>
|
||||
<td>contents of the inputbox</td>
|
||||
<td>SETTEXT</td>
|
||||
</tr><tr>
|
||||
<td>libdirfs</td>
|
||||
<td>the system wide directory where xchat will look for plugins.
|
||||
this string is in the same encoding as the local file system</td>
|
||||
<td></td>
|
||||
</tr><tr>
|
||||
<td>modes</td>
|
||||
<td>the current channels modes or undef if not known</td>
|
||||
<td>MODE</td>
|
||||
</tr><tr>
|
||||
<td>network</td>
|
||||
<td>current network name or undef, this value is taken from the Network List</td>
|
||||
<td></td>
|
||||
</tr><tr>
|
||||
<td>nick</td>
|
||||
<td>current nick</td>
|
||||
<td>NICK</td>
|
||||
</tr><tr>
|
||||
<td>nickserv</td>
|
||||
<td>nickserv password for this network or undef, this value is taken from the Network List</td>
|
||||
<td></td>
|
||||
</tr><tr>
|
||||
<td>server</td> <td>current server name <br />
|
||||
(what the server claims to be) undef if not connected
|
||||
</td>
|
||||
<td></td>
|
||||
</tr><tr>
|
||||
<td>state\_cursor</td>
|
||||
<td>current inputbox cursor position in characters</td>
|
||||
<td>SETCURSOR</td>
|
||||
</tr><tr>
|
||||
<td>topic</td>
|
||||
<td>current channel topic</td>
|
||||
<td>TOPIC</td>
|
||||
</tr><tr>
|
||||
<td>version</td>
|
||||
<td>xchat version number</td>
|
||||
<td></td>
|
||||
</tr><tr>
|
||||
<td>win_status</td>
|
||||
<td>status of the xchat window, possible values are "active", "hidden"
|
||||
and "normal"</td>
|
||||
<td>GUI</td>
|
||||
</tr><tr>
|
||||
<td>win\_ptr</td> <td>native window pointer, GtkWindow * on Unix, HWND on Win32.<br />
|
||||
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.<br />
|
||||
Additionally when you have detached tabs, each of the windows will return a different win\_ptr for the different Gtk2::Window objects.<br />
|
||||
See <a href="http://xchat.cvs.sourceforge.net/viewvc/xchat/xchat2/plugins/perl/char_count.pl?view=markup">char\_count.pl</a> for a longer example of a script that uses this to show how many characters you currently have in your input box.
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>gtkwin_ptr</td>
|
||||
<td>similar to win_ptr except it will always be a GtkWindow *</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
This function is used to retrieve certain information about the current
|
||||
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 )`
|
||||
|
||||
* **`$name` - name of a HexChat setting (available through the /set command)**
|
||||
|
||||
This function provides a way to retrieve HexChat's setting information.
|
||||
|
||||
Returns `undef` if there is no setting called called `$name`.
|
||||
|
||||
|
||||
### `Xchat::emit_print( $event, LIST )`
|
||||
|
||||
* **`$event` - name from the Event column in _Settings_ `->` _Text Events_**
|
||||
* **`LIST` - this depends on the Description column on the bottom of _Settings_ `->` _Text Events_**
|
||||
|
||||
This functions is used to generate one of the events listed under _Settings_ `->` _Text Events_.
|
||||
|
||||
Note: when using this function you **must** return `Xchat::EAT_ALL` otherwise you will end up with duplicate events.
|
||||
One is the original and the second is the one you emit.
|
||||
|
||||
Returns true on success, false on failure.
|
||||
|
||||
|
||||
### `Xchat::send_modes( $target | \@targets, $sign, $mode, [ $modes_per_line ] )`
|
||||
|
||||
* **`$target` - a single nick to set the mode on**
|
||||
* **`\@targets` - an array reference of the nicks to set the mode on**
|
||||
* **`$sign` - the mode sign, either '+' or '-'**
|
||||
* **`$mode` - the mode character such as 'o' and 'v', this can only be one character long**
|
||||
* **`$modes_per_line` - an optional argument maximum number of modes to send per at once, pass 0 use the current server's maximum (default)**
|
||||
|
||||
Send multiple mode changes for the current channel. It may send multiple MODE lines if the request doesn't fit on one.
|
||||
|
||||
Example:
|
||||
|
||||
<pre>
|
||||
use strict;
|
||||
use warning;
|
||||
use Xchat qw(:all);
|
||||
|
||||
hook_command( "MODES", sub {
|
||||
my (undef, $who, $sign, $mode) = @{$_[0]};
|
||||
my @targets = split /,/, $who;
|
||||
if( @targets > 1 ) {
|
||||
send_modes( \@targets, $sign, $mode, 1 );
|
||||
} else {
|
||||
send_modes( $who, $sign, $mode );
|
||||
}
|
||||
return EAT_XCHAT;
|
||||
});
|
||||
</pre>
|
||||
|
||||
### `Xchat::nickcmp( $nick1, $nick2 )`
|
||||
|
||||
* **`$nick1, $nick2` - the two nicks or channel names that are to be compared**
|
||||
|
||||
The comparsion is based on the current server. Either an [RFC1459](http://www.ietf.org/rfc/rfc1459.txt)
|
||||
compliant string compare or plain ascii will be using depending on the server. The
|
||||
comparison is case insensitive.
|
||||
|
||||
Returns a number less than, equal to or greater than zero if `$nick1` is
|
||||
found respectively, to be less than, to match, or be greater than `$nick2`.
|
||||
|
||||
|
||||
### `Xchat::get_list( $name )`
|
||||
|
||||
* **`$name` - name of the list, one of the following: "channels", "dcc", "ignore", "notify", "users"**
|
||||
|
||||
This function will return a list of hash references. The hash references
|
||||
will have different keys depend on the list. An empty list is returned
|
||||
if there is no such list.
|
||||
|
||||
"channels" - list of channels, querys and their server
|
||||
|
||||
<table border="1"> <tr style="background-color: #dddddd">
|
||||
<td>Key</td> <td>Description</td>
|
||||
</tr> <tr>
|
||||
<td>channel</td> <td>tab name</td>
|
||||
</tr> <tr>
|
||||
<td>chantypes</td>
|
||||
<td>channel types supported by the server, typically "#&"</td>
|
||||
</tr> <tr>
|
||||
<td>context</td> <td>can be used with set_context</td>
|
||||
</tr> <tr>
|
||||
<td>flags</td> <td>Server Bits:<br />
|
||||
0 - Connected<br />
|
||||
1 - Connecting<br />
|
||||
2 - Away<br />
|
||||
3 - EndOfMotd(Login complete)<br />
|
||||
4 - Has WHOX<br />
|
||||
5 - Has IDMSG (FreeNode)<br />
|
||||
<br />
|
||||
<p>The following correspond to the /chanopt command</p>
|
||||
6 - Hide Join/Part Message (text_hidejoinpart)<br />
|
||||
7 - unused (was for color paste)<br />
|
||||
8 - Beep on message (alert_beep)<br />
|
||||
9 - Blink Tray (alert_tray)<br />
|
||||
10 - Blink Task Bar (alert_taskbar)<br />
|
||||
<p>Example of checking if the current context has Hide Join/Part messages set:</p>
|
||||
<div class="example synNormal"><div class='line_number'>
|
||||
<div>1</div>
|
||||
<div>2</div>
|
||||
<div>3</div>
|
||||
</div>
|
||||
<div class='content'><pre><span class="synStatement">if</span>( Xchat::context_info->{flags} & (<span class="synConstant">1</span> << <span class="synConstant">6</span>) ) {
|
||||
Xchat::<span class="synStatement">print</span>( <span class="synStatement">"</span><span class="synConstant">Hide Join/Part messages is enabled</span><span class="synStatement">"</span> );
|
||||
}
|
||||
</pre></div>
|
||||
</div> </td>
|
||||
</tr> <tr>
|
||||
<td>id</td> <td>Unique server ID </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>lag</td>
|
||||
<td>lag in milliseconds</td>
|
||||
</tr> <tr>
|
||||
<td>maxmodes</td> <td>Maximum modes per line</td>
|
||||
</tr> <tr>
|
||||
<td>network</td> <td>network name to which this channel belongs</td>
|
||||
</tr> <tr>
|
||||
<td>nickprefixes</td> <td>Nickname prefixes e.g. "+@"</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>nickmodes</td> <td>Nickname mode chars e.g. "vo"</td>
|
||||
</tr> <tr>
|
||||
<td>queue</td>
|
||||
<td>number of bytes in the send queue</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>server</td> <td>server name to which this channel belongs</td>
|
||||
</tr> <tr>
|
||||
<td>type</td> <td>the type of this context<br />
|
||||
1 - server<br />
|
||||
2 - channel<br />
|
||||
3 - dialog<br />
|
||||
4 - notices<br />
|
||||
5 - server notices<br />
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>users</td> <td>Number of users in this channel</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
"dcc" - list of DCC file transfers
|
||||
|
||||
<table border="1"> <tr style="background-color: #dddddd">
|
||||
<td>Key</td> <td>Value</td>
|
||||
</tr> <tr>
|
||||
<td>address32</td> <td>address of the remote user(ipv4 address)</td>
|
||||
</tr> <tr>
|
||||
<td>cps</td> <td>bytes per second(speed)</td>
|
||||
</tr> <tr>
|
||||
<td>destfile</td> <td>destination full pathname</td>
|
||||
</tr> <tr>
|
||||
<td>file</td> <td>file name</td>
|
||||
</tr> <tr>
|
||||
<td>nick</td>
|
||||
<td>nick of the person this DCC connection is connected to</td>
|
||||
</tr> <tr>
|
||||
<td>port</td> <td>TCP port number</td>
|
||||
</tr> <tr>
|
||||
<td>pos</td> <td>bytes sent/received</td>
|
||||
</tr> <tr>
|
||||
<td>poshigh</td> <td>bytes sent/received, high order 32 bits</td>
|
||||
</tr> <tr>
|
||||
<td>resume</td> <td>point at which this file was resumed<br />
|
||||
(zero if it was not resumed)
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>resumehigh</td> <td>point at which this file was resumed, high order 32 bits<br />
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>size</td> <td>file size in bytes low order 32 bits</td>
|
||||
</tr> <tr>
|
||||
<td>sizehigh</td> <td>file size in bytes, high order 32 bits (when the files is > 4GB)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>status</td> <td>DCC Status:<br />
|
||||
0 - queued<br />
|
||||
1 - active<br />
|
||||
2 - failed<br />
|
||||
3 - done<br />
|
||||
4 - connecting<br />
|
||||
5 - aborted
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>type</td> <td>DCC Type:<br />
|
||||
0 - send<br />
|
||||
1 - receive<br />
|
||||
2 - chatrecv<br />
|
||||
3 - chatsend
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
"ignore" - current ignore list
|
||||
|
||||
<table border="1"> <tr style="background-color: #dddddd">
|
||||
<td>Key</td> <td>Value</td>
|
||||
</tr> <tr>
|
||||
<td>mask</td> <td>ignore mask. e.g: *!*@*.aol.com</td>
|
||||
</tr> <tr>
|
||||
<td>flags</td> <td>Bit field of flags.<br />
|
||||
0 - private<br />
|
||||
1 - notice<br />
|
||||
2 - channel<br />
|
||||
3 - ctcp<br />
|
||||
4 - invite<br />
|
||||
5 - unignore<br />
|
||||
6 - nosave<br />
|
||||
7 - dcc<br />
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
"notify" - list of people on notify
|
||||
|
||||
<table border="1">
|
||||
<tr style="background-color: #dddddd">
|
||||
<td>Key</td> <td>Value</td>
|
||||
</tr> <tr>
|
||||
<td>networks</td>
|
||||
<td>comma separated list of networks where you will be notfified about this user's online/offline status or undef if you will be notificed on every network you are connected to</td>
|
||||
</tr> <tr>
|
||||
<td>nick</td> <td>nickname</td>
|
||||
</tr> <tr>
|
||||
<td>flags</td> <td>0 = is online</td>
|
||||
</tr> <tr>
|
||||
<td>on</td> <td>time when user came online</td>
|
||||
</tr> <tr>
|
||||
<td>off</td> <td>time when user went offline</td>
|
||||
</tr> <tr>
|
||||
<td>seen</td> <td>time when user was last verified still online</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
The values indexed by on, off and seen can be passed to localtime
|
||||
and gmtime, see perldoc -f [localtime](http://perldoc.perl.org/functions/localtime.html) and
|
||||
perldoc -f [gmtime](http://perldoc.perl.org/functions/gmtime.html) for more details.
|
||||
|
||||
"users" - list of users in the current channel
|
||||
|
||||
<table border="1">
|
||||
<tr style="background-color: #dddddd">
|
||||
<td>Key</td> <td>Value</td>
|
||||
</tr> <tr>
|
||||
<td>away</td> <td>away status(boolean)</td>
|
||||
</tr> <tr>
|
||||
<td>lasttalk</td>
|
||||
<td>last time a user was seen talking, this is the an epoch time(number of seconds since a certain date, that date depends on the OS)</td>
|
||||
</tr> <tr>
|
||||
<td>nick</td> <td>nick name</td>
|
||||
</tr> <tr>
|
||||
<td>host</td>
|
||||
<td>host name in the form: user@host or undef if not known</td>
|
||||
</tr> <tr>
|
||||
<td>prefix</td> <td>prefix character, .e.g: @ or +</td>
|
||||
</tr> <tr>
|
||||
<td>realname</td>
|
||||
<td>Real name or undef</td>
|
||||
</tr> <tr>
|
||||
<td>selected</td>
|
||||
<td>selected status in the user list, only works when retrieving the user list of the focused tab. You can use the /USELECT command to select the nicks</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
"networks" - list of networks and the associated settings from network list
|
||||
|
||||
<table border="1"> <tr style="background-color: #dddddd">
|
||||
<td>Key</td> <td>Value</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>autojoins</td> <td>An object with the following methods:<br />
|
||||
<table>
|
||||
<tr>
|
||||
<td>Method</td>
|
||||
<td>Description</td>
|
||||
</tr> <tr>
|
||||
<td>channels()</td>
|
||||
<td>returns a list of this networks' autojoin channels in list context, a count of the number autojoin channels in scalar context</td>
|
||||
</tr> <tr>
|
||||
<td>keys()</td>
|
||||
<td>returns a list of the keys to go with the channels, the order is the same as the channels, if a channel doesn't have a key, '' will be returned in it's place</td>
|
||||
</tr> <tr>
|
||||
<td>pairs()</td>
|
||||
<td>a combination of channels() and keys(), returns a list of (channels, keys) pairs. This can be assigned to a hash for a mapping from channel to key.</td>
|
||||
</tr> <tr>
|
||||
<td>as_hash()</td>
|
||||
<td>return the pairs as a hash reference</td>
|
||||
</tr> <tr>
|
||||
<td>as_string()</td>
|
||||
<td>the original string that was used to construct this autojoin object, this can be used with the JOIN command to join all the channels in the autojoin list</td>
|
||||
</tr> <tr>
|
||||
<td>as_array()</td>
|
||||
<td>return an array reference of hash references consisting of the keys "channel" and "key"</td>
|
||||
</tr> <tr>
|
||||
<td>as_bool()</td>
|
||||
<td>returns true if the network has autojoins and false otherwise</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>connect_commands</td> <td>An array reference containing the connect commands for a network. An empty array if there aren't any</td>
|
||||
</tr> <tr>
|
||||
<td>encoding</td> <td>the encoding for the network</td>
|
||||
</tr> <tr>
|
||||
<td>flags</td>
|
||||
<td>
|
||||
a hash reference corresponding to the checkboxes in the network edit window
|
||||
<table>
|
||||
<tr>
|
||||
<td>allow_invalid</td>
|
||||
<td>true if "Accept invalid SSL certificate" is checked</td>
|
||||
</tr> <tr>
|
||||
<td>autoconnect</td>
|
||||
<td>true if "Auto connect to this network at startup" is checked</td>
|
||||
</tr> <tr>
|
||||
<td>cycle</td>
|
||||
<td>true if "Connect to selected server only" is <strong>NOT</strong> checked</td>
|
||||
</tr> <tr>
|
||||
<td>use_global</td>
|
||||
<td>true if "Use global user information" is checked</td>
|
||||
</tr> <tr>
|
||||
<td>use_proxy</td>
|
||||
<td>true if "Bypass proxy server" is <strong>NOT</strong> checked</td>
|
||||
</tr> <tr>
|
||||
<td>use_ssl</td>
|
||||
<td>true if "Use SSL for all the servers on this network" is checked</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr> <tr>
|
||||
<td>irc_nick1</td>
|
||||
<td>Corresponds with the "Nick name" field in the network edit window</td>
|
||||
</tr> <tr>
|
||||
<td>irc_nick2</td>
|
||||
<td>Corresponds with the "Second choice" field in the network edit window</td>
|
||||
</tr> <tr>
|
||||
<td>irc_real_name</td>
|
||||
<td>Corresponds with the "Real name" field in the network edit window</td>
|
||||
</tr> <tr>
|
||||
<td>irc_user_name</td>
|
||||
<td>Corresponds with the "User name" field in the network edit window</td>
|
||||
</tr> <tr>
|
||||
<td>network</td>
|
||||
<td>Name of the network</td>
|
||||
</tr> <tr>
|
||||
<td>nickserv_password</td>
|
||||
<td>Corresponds with the "Nickserv password" field in the network edit window</td>
|
||||
</tr> <tr>
|
||||
<td>selected</td>
|
||||
<td>Index into the list of servers in the "servers" key, this is used if the "cycle" flag is false</td>
|
||||
</tr> <tr>
|
||||
<td>server_password</td>
|
||||
<td>Corresponds with the "Server password" field in the network edit window</td>
|
||||
</tr> <tr>
|
||||
<td>servers</td>
|
||||
<td>An array reference of hash references with a "host" and "port" key. If a port is not specified then 6667 will be used.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
### `Xchat::user_info( [$nick] )`
|
||||
|
||||
* **`$nick` - the nick to look for, if this is not given your own nick will be used as default**
|
||||
|
||||
This function is mainly intended to be used as a shortcut for when you need
|
||||
to retrieve some information about only one user in a channel. Otherwise it
|
||||
is better to use `get_list`. If `$nick` is found a hash reference containing
|
||||
the same keys as those in the "users" list of `get_list` is returned otherwise
|
||||
undef is returned. Since it relies on `get_list` this function can only be used in a
|
||||
channel context.
|
||||
|
||||
|
||||
### `Xchat::context_info( [$context] )`
|
||||
|
||||
* **`$context` - context returned from `get_context`, `find_context` and `get_list`, this is the context that you want infomation about. If this is omitted, it will default to current context.**
|
||||
|
||||
This function will return the information normally retrieved with `get_info`, except this
|
||||
is for the context that is passed in. The information will be returned in the form of a
|
||||
hash. The keys of the hash are the `$id` you would normally supply to `get_info` as well
|
||||
as all the keys that are valid for the items in the "channels" list from `get_list`. Use
|
||||
of this function is more efficient than calling get_list( "channels" ) and
|
||||
searching through the result.
|
||||
|
||||
Example:
|
||||
|
||||
<pre>
|
||||
use strict;
|
||||
use warnings;
|
||||
use Xchat qw(:all); # imports all the functions documented on this page
|
||||
|
||||
register( "User Count", "0.1",
|
||||
"Print out the number of users on the current channel" );
|
||||
hook_command( "UCOUNT", \&display_count );
|
||||
sub display_count {
|
||||
prnt "There are " . context_info()->{users} . " users in this channel.";
|
||||
return EAT_XCHAT;
|
||||
}
|
||||
</pre>
|
||||
|
||||
|
||||
### `Xchat::strip_code( $string )`
|
||||
|
||||
* **`$string` - string to remove codes from**
|
||||
|
||||
This function will remove bold, color, beep, reset, reverse and underline codes from `$string`.
|
||||
It will also remove ANSI escape codes which might get used by certain terminal based clients.
|
||||
If it is called in void context `$string` will be modified otherwise a modified copy of `$string` is returned.
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
### Asynchronous DNS resolution with hook\_fd
|
||||
|
||||
<pre>
|
||||
use strict;
|
||||
use warnings;
|
||||
use Xchat qw(:all);
|
||||
use Net::DNS;
|
||||
|
||||
hook_command( "BGDNS", sub {
|
||||
my $host = $_[0][1];
|
||||
my $resolver = Net::DNS::Resolver->new;
|
||||
my $sock = $resolver->bgsend( $host );
|
||||
|
||||
hook_fd( $sock, sub {
|
||||
my $ready_sock = $_[0];
|
||||
my $packet = $resolver->bgread( $ready_sock );
|
||||
|
||||
if( $packet->authority && (my @answers = $packet->answer ) ) {
|
||||
|
||||
if( @answers ) {
|
||||
prnt "$host:";
|
||||
my $padding = " " x (length( $host ) + 2);
|
||||
for my $answer ( @answers ) {
|
||||
prnt $padding . $answer->rdatastr . ' ' . $answer->type;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
prnt "Unable to resolve $host";
|
||||
}
|
||||
|
||||
return REMOVE;
|
||||
},
|
||||
{
|
||||
flags => FD_READ,
|
||||
});
|
||||
|
||||
return EAT_XCHAT;
|
||||
});
|
||||
</pre>
|
||||
|
||||
|
||||
## Contact Information
|
||||
|
||||
Contact Lian Wan Situ at <atmcmnky [at] yahoo.com> for questions, comments and
|
||||
corrections about this page or the Perl plugin itself. You can also find me in #xchat
|
||||
on freenode under the nick Khisanth.
|
||||
|
||||
<table border="0" width="100%" cellspacing="0" cellpadding="3">
|
||||
<tr><td class="block" style="background-color: #cccccc" valign="middle">
|
||||
<big><strong><span class="block"> X-Chat 2 Perl Interface</span></strong></big>
|
||||
</td></tr>
|
||||
</table>
|
||||
1145
share/doc/plugins.md
1145
share/doc/plugins.md
File diff suppressed because it is too large
Load Diff
@ -1,560 +0,0 @@
|
||||
# HexChat Python Interface
|
||||
|
||||
## Features
|
||||
|
||||
Here are some of the features of the python plugin interface:
|
||||
|
||||
* Comprehensive, consistent and straightforward API
|
||||
* Load, unload, reload, and autoload support
|
||||
* Per plugin independent interpreter state
|
||||
* Python interactive console
|
||||
* Python interactive command execution
|
||||
* Full thread support
|
||||
* Stdout and stderr redirected to HexChat console
|
||||
* Dynamic list management
|
||||
* Nice context treatment
|
||||
* Plugin preferences
|
||||
|
||||
## Commands
|
||||
|
||||
The following commands will be intercepted by the Python Plugin interface module, when it is loaded.
|
||||
|
||||
* **/py load <filename>:** Load module with given filename.
|
||||
* **/py unload <filename|module name>:** Unload module with given filename, or module name.
|
||||
* **/py reload <filename|module name>:** Reload module with given filename, or module name.
|
||||
* **/py list:** List Python modules loaded.
|
||||
* **/py exec <command>:** Execute given Python command interactively. For example:
|
||||
|
||||
<pre>
|
||||
/py exec import xchat
|
||||
/py exec print xchat.get_info('channel')
|
||||
</pre>
|
||||
|
||||
* **/py console:** Open the Python interactive console in a query (>>python<<).
|
||||
Every message sent will be intercepted by the Python plugin interface,
|
||||
and interpreted interactively. Notice that the console and /py exec
|
||||
commands live in the same interpreter state.
|
||||
|
||||
* **/py about:** Show some information about the Python plugin interface.
|
||||
|
||||
|
||||
## Autoloading modules
|
||||
|
||||
If you want some module to be autoloaded together with the Python plugin
|
||||
interface (which usually loads at startup time), just make sure it has a
|
||||
`.py` extension and put it in your HexChat directory (`~/.config/hexchat/addons`, `%APPDATA%\\HexChat\\addons`).
|
||||
|
||||
|
||||
## Context theory
|
||||
|
||||
Before starting to explain what the API offers, I'll do a short
|
||||
introduction about the HexChat context concept. Not because it's something
|
||||
hard to understand, but because you'll understand better the API
|
||||
explanations if you know what I'm talking about.
|
||||
|
||||
You can think about a context as an HexChat channel, server, or query tab.
|
||||
Each of these tabs, has its own context, and is related to a given
|
||||
server and channel (queries are a special kind of channel).
|
||||
|
||||
The *current* context is the one where HexChat passes control to the
|
||||
module. For example, when HexChat receives a command in a specific
|
||||
channel, and you have asked HexChat to tell you about this event, the
|
||||
current context will be set to this channel before your module is
|
||||
called.
|
||||
|
||||
|
||||
## Hello world
|
||||
|
||||
Here is the traditional _hello world_ example.
|
||||
|
||||
<pre>
|
||||
__module_name__ = "helloworld"
|
||||
__module_version__ = "1.0"
|
||||
__module_description__ = "Python module example"
|
||||
|
||||
print "Hello world!"
|
||||
</pre>
|
||||
|
||||
This module will print "Hello world!" in the HexChat console, and sleep
|
||||
forever until it's unloaded. It's a simple module, but already
|
||||
introduces some concepts. Notice how the module information is set. This
|
||||
information is obligatory, and will be shown when listing the loaded
|
||||
HexChat modules.
|
||||
|
||||
|
||||
## xchat module
|
||||
|
||||
The xchat module is your passport to every HexChat functionality offered
|
||||
by the Python plugin interface. Here's a simple example:
|
||||
|
||||
<pre>
|
||||
import xchat
|
||||
xchat.prnt("Hi everyone!")
|
||||
</pre>
|
||||
|
||||
The following functions are available in the xchat module.
|
||||
|
||||
|
||||
### Generic functions
|
||||
|
||||
|
||||
#### xchat.prnt(string)
|
||||
|
||||
This function will print string in the current context. It's mainly
|
||||
useful as a parameter to pass to some other function, since the usual
|
||||
print statement will have the same results. You have a usage example
|
||||
above.
|
||||
|
||||
This function is badly named because `"print"` is a reserved keyword of the Python language.
|
||||
|
||||
|
||||
#### xchat.emit\_print(event\_name, \*args)
|
||||
|
||||
This function will generate a *print event* with the given arguments. To
|
||||
check which events are available, and the number and meaning of
|
||||
arguments, have a look at the `Settings > Lists > Text Events` window.
|
||||
Here is one example:
|
||||
|
||||
<pre>
|
||||
xchat.emit_print("Channel Message", "John", "Hi there", "@")
|
||||
</pre>
|
||||
|
||||
|
||||
#### xchat.command(string)
|
||||
|
||||
Execute the given command in the current context. This has the same
|
||||
results as executing a command in the HexChat window, but notice that the
|
||||
`/` prefix is not used. Here is an example:
|
||||
|
||||
<pre>
|
||||
xchat.command("server irc.openprojects.net")
|
||||
</pre>
|
||||
|
||||
|
||||
#### xchat.nickcmp(s1, s2)
|
||||
|
||||
This function will do an RFC1459 compliant string comparing between `s1`
|
||||
and `s2`, and is useful to compare channels and nicknames. It returns an
|
||||
integer less than, equal to, or greater than zero if `s1` is found,
|
||||
respectively, to be less than, to match, or be greater than `s2`. For
|
||||
example:
|
||||
|
||||
<pre>
|
||||
if xchat.nickcmp(nick, "mynick") == 0:
|
||||
print "They are the same!"
|
||||
</pre>
|
||||
|
||||
|
||||
### Information retreiving functions
|
||||
|
||||
|
||||
#### xchat.get\_info(type)
|
||||
|
||||
Retrieve the information specified by the `type` string in the current
|
||||
context. At the moment of this writing, the following information types
|
||||
are available to be queried:
|
||||
|
||||
* **away:** Away reason or None if you are not away.
|
||||
* **channel:** Channel name of the current context.
|
||||
* **charset:** Charset in current context.
|
||||
* **configdir:** HexChat config directory e.g.: "~/.config/hexchat".
|
||||
* **event_name NAME:** Returns text event string for requested event.
|
||||
* **gtkwin_ptr:** Current Gtk Window.
|
||||
* **host:** Real hostname of the server you connected to.
|
||||
* **inputbox:** Contents of inputbox.
|
||||
* **network:** Current network name or None.
|
||||
* **nick:** Your current nick name.
|
||||
* **nickserv:** Current networks nickserv password or None.
|
||||
* **modes:** Current channel modes or None.
|
||||
* **server:** Current server name (what the server claims to be) or None if you are not connected.
|
||||
* **topic:** Current channel topic.
|
||||
* **win_status:** Returns status of window: 'active', 'hidden', or 'normal'.
|
||||
* **version:** HexChat version number.
|
||||
|
||||
Example:
|
||||
|
||||
<pre>
|
||||
if xchat.get_info("server") is None:
|
||||
print "Not connected!"
|
||||
</pre>
|
||||
|
||||
|
||||
#### xchat.get\_prefs(name)
|
||||
|
||||
Retrieve the HexChat setting information specified by the `name` string,
|
||||
as available by the `/set` command. For example:
|
||||
|
||||
<pre>
|
||||
print "Current preferred nick:", xchat.get_prefs("irc_nick1")
|
||||
</pre>
|
||||
|
||||
|
||||
#### xchat.get\_list(type)
|
||||
|
||||
With this function you may retrieve a list containing the selected
|
||||
information from the current context, like a DCC list, a channel list, a
|
||||
user list, etc. Each list item will have its attributes set dynamically
|
||||
depending on the information provided by the list type.
|
||||
|
||||
The example below is a rewrite of the example provided with HexChat's
|
||||
plugin API documentation. It prints a list of every DCC transfer
|
||||
happening at the moment. Notice how similar the interface is to the C
|
||||
API provided by HexChat.
|
||||
|
||||
<pre>
|
||||
list = xchat.get_list("dcc")
|
||||
if list:
|
||||
print "--- DCC LIST ------------------"
|
||||
print "File To/From KB/s Position"
|
||||
for i in list:
|
||||
print "%6s %10s %.2f %d" % (i.file, i.nick, i.cps/1024, i.pos)
|
||||
</pre>
|
||||
|
||||
Below you will find what each list type has to offer.
|
||||
|
||||
This information was taken from HexChat's plugin documentation. You may find any types not
|
||||
listed here, if they exist at all, in an updated HexChat documentation.
|
||||
Any list types accepted by HexChat should be dynamically accepted by the
|
||||
Python plugin interface.
|
||||
|
||||
|
||||
##### channels
|
||||
|
||||
The channels list type gives you access to the channels, queries and
|
||||
their servers. The folloing attributes are available in each list item:
|
||||
|
||||
* **channel:** Channel or query name.
|
||||
* **chantypes:** Channel types e.g. #!&.
|
||||
* **context:** A context object, giving access to that channel/server.
|
||||
* **id:** Unique server id.
|
||||
* **lag:** Latency in milliseconds.
|
||||
* **maxmodes:** Max modes per line.
|
||||
* **network:** Network name to which this channel belongs.
|
||||
* **nickprefixes:** Nickname prefixes e.g. @%+.
|
||||
* **nickmodes:** Nickname mode chars e.g. ov.
|
||||
* **queue:** Number of bytes in the send-queue.
|
||||
* **server:** Server name to which this channel belongs.
|
||||
* **users:** Number of users in the channel.
|
||||
* **type:** Type of context.
|
||||
* 1: Server
|
||||
* 2: Channel
|
||||
* 3: Dialog
|
||||
|
||||
* **flags:** Bit field of flags:
|
||||
* 0: Connected
|
||||
* 1: Connecting
|
||||
* 2: Away
|
||||
* 3: End of MOTD (Login Complete)
|
||||
* 4: Has WHOX
|
||||
* 5: Has IDMSG
|
||||
* 6: Join/Parts hidden
|
||||
* 7: Unused
|
||||
* 8: Beep on Message
|
||||
* 9: Blink Tray
|
||||
* 10: Blink Task Bar
|
||||
|
||||
|
||||
##### dcc
|
||||
|
||||
The dcc list type gives you access to a list of DCC file transfers. The
|
||||
following attributes are available in each list item:
|
||||
|
||||
* **address32:** Address of the remote user (ipv4 address, as an int).
|
||||
* **cps:** Bytes per second (speed).
|
||||
* **destfile:** Destination full pathname.
|
||||
* **file:** Filename.
|
||||
* **nick:** Nickname of person who the file is from/to.
|
||||
* **port:** TCP port number.
|
||||
* **pos:** Bytes sent/received.
|
||||
* **resume:** Point at which this file was resumed (or zero if it was not resumed).
|
||||
* **size:** File size in bytes.
|
||||
* **status:** DCC status:
|
||||
* 0: queued
|
||||
* 1: active
|
||||
* 2: failed
|
||||
* 3: done
|
||||
* 4: connecting
|
||||
* 5: aborted
|
||||
* **type:** DCC type:
|
||||
* 0: send
|
||||
* 1: receive
|
||||
* 2: chatrecv
|
||||
* 3: chatsend
|
||||
|
||||
|
||||
##### users
|
||||
|
||||
The users list type gives you access to a list of users in the current
|
||||
channel. The following attributes are available in each list item:
|
||||
|
||||
* **away:** Away status.
|
||||
* **lasttalk:** Last time the user was seen talking.
|
||||
* **host:** Host name in the form user@host (or None, if not known).
|
||||
* **nick:** Nick name.
|
||||
* **prefix:** Prefix character, .e.g: @ or +. Points to a single char.
|
||||
* **realname:** Real name.
|
||||
* **selected:** Selected status in the userlist.
|
||||
|
||||
|
||||
##### ignore
|
||||
|
||||
The ignore list type gives you access to the current ignored list. The
|
||||
following attributes are available in each list item:
|
||||
|
||||
* **mask:** Ignore mask (for example, "\*!\*@\*.aol.com").
|
||||
* **flags:** Bit field of flags:
|
||||
* 0: private
|
||||
* 1: notice
|
||||
* 2: channel
|
||||
* 3: ctcp
|
||||
* 4: invite
|
||||
* 5: unignore
|
||||
* 6: nosave
|
||||
* 7: dcc
|
||||
|
||||
|
||||
### Hook functions
|
||||
|
||||
These functions allow one to hook into HexChat events.
|
||||
|
||||
|
||||
#### Priorities
|
||||
|
||||
When a priority keyword parameter is accepted, it means that this
|
||||
callback may be hooked with five different priorities: PRI\_HIGHEST,
|
||||
PRI\_HIGH, PRI\_NORM, PRI\_LOW, and PRI\_LOWEST. The usage of these
|
||||
constants, which are available in the xchat module, will define the
|
||||
order in which your plugin will be called. Most of the time, you won't
|
||||
want to change its default value (PRI\_NORM).
|
||||
|
||||
|
||||
#### Parameters word and word_eol
|
||||
|
||||
These parameters, when available in a callback, are lists of strings
|
||||
which contain the parameters the user entered for the particular
|
||||
command. For example, if you executed:
|
||||
|
||||
<pre>
|
||||
/command NICK Hi there!
|
||||
</pre>
|
||||
|
||||
* **word[0]** is `command`
|
||||
* **word[1]** is `NICK`
|
||||
* **word[2]** is `Hi`
|
||||
* **word[3]** is `there!`
|
||||
* **word\_eol[0]** is `command NICK Hi there!`
|
||||
* **word\_eol[1]** is `NICK Hi there!`
|
||||
* **word\_eol[2]** is `Hi there!`
|
||||
* **word\_eol[3]** is `there!`
|
||||
|
||||
|
||||
#### Parameter userdata
|
||||
|
||||
The parameter userdata, if given, allows you to pass a custom object to
|
||||
your callback.
|
||||
|
||||
#### Callback return constants (EAT\_*)
|
||||
|
||||
When a callback is supposed to return one of the EAT\_\* macros, it is
|
||||
able control how HexChat will proceed after the callback returns. These
|
||||
are the available constants, and their meanings:
|
||||
|
||||
* **EAT_PLUGIN:** Don't let any other plugin receive this event.
|
||||
* **EAT_XCHAT:** Don't let HexChat treat this event as usual.
|
||||
* **EAT_ALL:** Eat the event completely.
|
||||
* **EAT_NONE:** Let everything happen as usual.
|
||||
|
||||
Returning `None` is the same as returning `EAT_NONE`.
|
||||
|
||||
|
||||
#### xchat.hook\_command(name, callback, userdata=None, priority=PRI\_NORM, help=None)
|
||||
|
||||
This function allows you to hook into the name HexChat command. It means
|
||||
that everytime you type `/name ...`, `callback` will be called.
|
||||
Parameters `userdata` and `priority` have their meanings explained
|
||||
above, and the parameter help, if given, allows you to pass a help text
|
||||
which will be shown when `/help name` is executed. This function returns
|
||||
a hook handler which may be used in the `xchat.unhook()` function. For
|
||||
example:
|
||||
|
||||
<pre>
|
||||
def onotice_cb(word, word_eol, userdata):
|
||||
if len(word) < 2:
|
||||
print "Second arg must be the message!"
|
||||
else:
|
||||
xchat.command("NOTICE @%s %s" % (xchat.get_info("channel"), word_eol[1]))
|
||||
return xchat.EAT_ALL
|
||||
|
||||
xchat.hook_command("ONOTICE", onotice_cb, help="/ONOTICE <message> Sends a notice to all ops")
|
||||
</pre>
|
||||
|
||||
You may return one of `EAT_*` constants in the callback, to control
|
||||
HexChat's behavior, as explained above.
|
||||
|
||||
|
||||
#### xchat.hook\_print(name, callback, userdata=None, priority=PRI\_NORM)
|
||||
|
||||
This function allows you to register a callback to trap any print
|
||||
events. The event names are available in the _Edit Event Texts_ window.
|
||||
Parameters `userdata` and `priority` have their meanings explained
|
||||
above. This function returns a hook handler which may be used in the
|
||||
`xchat.unhook()` function. For example:
|
||||
|
||||
<pre>
|
||||
def youpart_cb(word, word_eol, userdata):
|
||||
print "You have left channel", word[2]
|
||||
return xchat.EAT_XCHAT # Don't let HexChat do its normal printing
|
||||
|
||||
xchat.hook_print("You Part", youpart_cb)
|
||||
</pre>
|
||||
|
||||
You may return one of `EAT_*` constants in the callback, to control
|
||||
HexChat's behavior, as explained above.
|
||||
|
||||
|
||||
#### xchat.hook\_server(name, callback, userdata=None, priority=PRI\_NORM)
|
||||
|
||||
This function allows you to register a callback to be called when a
|
||||
certain server event occurs. You can use this to trap `PRIVMSG`,
|
||||
`NOTICE`, `PART`, a server numeric, etc. Parameters `userdata` and
|
||||
`priority` have their meanings explained above. This function returns a
|
||||
hook handler which may be used in the `xchat.unhook()` function. For
|
||||
example:
|
||||
|
||||
<pre>
|
||||
def kick_cb(word, word_eol, userdata):
|
||||
print "%s was kicked from %s (%s)" % (word[3], word[2], word_eol[4])
|
||||
# Don't eat this event, let other plugins and HexChat see it too
|
||||
return xchat.EAT_NONE
|
||||
|
||||
xchat.hook_server("KICK", kick_cb)
|
||||
</pre>
|
||||
|
||||
You may return one of `EAT_*` constants in the callback, to control
|
||||
HexChat's behavior, as explained above.
|
||||
|
||||
|
||||
#### xchat.hook\_timer(timeout, callback, userdata=None)
|
||||
|
||||
This function allows you to register a callback to be called every
|
||||
timeout milliseconds. Parameters userdata and priority have their
|
||||
meanings explained above. This function returns a hook handler which may
|
||||
be used in the `xchat.unhook()` function. For example:
|
||||
|
||||
<pre>
|
||||
myhook = None
|
||||
|
||||
def stop_cb(word, word_eol, userdata):
|
||||
global myhook
|
||||
if myhook is not None:
|
||||
xchat.unhook(myhook)
|
||||
myhook = None
|
||||
print "Timeout removed!"
|
||||
|
||||
def timeout_cb(userdata):
|
||||
print "Annoying message every 5 seconds! Type /STOP to stop it."
|
||||
return 1 # Keep the timeout going
|
||||
|
||||
myhook = xchat.hook_timer(5000, timeout_cb)
|
||||
xchat.hook_command("STOP", stop_cb)
|
||||
</pre>
|
||||
|
||||
If you return a true value from the callback, the timer will be keeped,
|
||||
otherwise it is removed.
|
||||
|
||||
|
||||
#### xchat.hook\_unload(timeout, callback, userdata=None)
|
||||
|
||||
This function allows you to register a callback to be called when the
|
||||
plugin is going to be unloaded. Parameters `userdata` and `priority`
|
||||
have their meanings explained above. This function returns a hook
|
||||
handler which may be used in the `xchat.unhook()` function. For example:
|
||||
|
||||
<pre>
|
||||
def unload_cb(userdata):
|
||||
print "We're being unloaded!"
|
||||
|
||||
xchat.hook_unload(unload_cb)
|
||||
</pre>
|
||||
|
||||
|
||||
#### xchat.unhook(handler)
|
||||
|
||||
Unhooks any hook registered with the hook functions above.
|
||||
|
||||
|
||||
### Plugin preferences
|
||||
|
||||
You can use pluginpref to easily store and retrieve settings. This was added in the Python plugin version 0.9
|
||||
|
||||
#### xchat.set\_pluginpref(name, value)
|
||||
|
||||
If neccessary creates a .conf file in the HexChat config folder named addon\_python.conf and stores the value in it. Returns 1 on success, 0 on failure.
|
||||
|
||||
> Note: Until the plugin uses different a conf file per script it's recommened to use 'PluginName-SettingName' to avoid conflicts.
|
||||
|
||||
|
||||
#### xchat.get\_pluginpref(name)
|
||||
|
||||
This will return the value of the variable of that name. If there is none by this name it will return `None`. Numbers are always returned as Integers.
|
||||
|
||||
|
||||
#### xchat.del\_pluginpref(name)
|
||||
|
||||
Deletes the specified variable. Returns 1 on success (or never existing), 0 on failure.
|
||||
|
||||
|
||||
#### xchat.list\_pluginpref()
|
||||
|
||||
Returns a list of all currently set preferences.
|
||||
|
||||
|
||||
### Context handling
|
||||
|
||||
Below you will find information about how to work with contexts.
|
||||
|
||||
|
||||
#### Context objects
|
||||
|
||||
As explained in the Context theory session above, contexts give access
|
||||
to a specific channel/query/server tab of HexChat. Every function
|
||||
available in the xchat module will be evaluated in the current context,
|
||||
which will be specified by HexChat itself before passing control to the
|
||||
module. Sometimes you may want to work in a specific context, and that's
|
||||
where context objects come into play.
|
||||
|
||||
You may create a context object using the `xchat.get_context()` or
|
||||
`xchat.find_context()`, functions as explained below, or trough the
|
||||
`xchat.get_list()` function, as explained in its respective session.
|
||||
|
||||
Each context object offers the following methods:
|
||||
|
||||
* **context.set():** Changes the current context to be the one represented by this context object.
|
||||
* **context.prnt(string):** Does the same as the xchat.prnt() function, but in the given context.
|
||||
* **context.emit\_print(event\_name, \*args):** Does the same as the emit\_print() function, but in the given context.
|
||||
* **context.command(string):** Does the same as the xchat.command() function, but in the given context.
|
||||
* **context.get\_info(type):** Does the same as the xchat.get\_info() function, but in the given context.
|
||||
* **context.get\_list(type):** Does the same as the xchat.get\_list() function, but in the given context.
|
||||
|
||||
|
||||
#### xchat.get\_context()
|
||||
|
||||
Returns a context object corresponding the the current context.
|
||||
|
||||
#### xchat.find\_context(server=None, channel=None)
|
||||
|
||||
Finds a context based on a channel and servername. If `server` is
|
||||
`None`, it finds any channel (or query) by the given name. If `channel`
|
||||
is `None`, it finds the front-most tab/window of the given server. For
|
||||
example:
|
||||
|
||||
<pre>
|
||||
cnc = xchat.find_context(channel='#conectiva')
|
||||
cnc.command('whois niemeyer')
|
||||
</pre>
|
||||
|
||||
***
|
||||
|
||||
Original Author: Gustavo Niemeyer [gustavo@niemeyer.net](mailto:gustavo@niemeyer.net)
|
||||
|
||||
For purty html: `pandoc --toc python.md -s --highlight-style haddock -o python.html`
|
||||
3632
share/doc/tcl.md
3632
share/doc/tcl.md
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user