@@ -307,7 +307,7 @@ For example:
MENU -e0 ADD "FServe/Do Something" "fs action"
-In the example above, it would be recommended to execute _MENU DEL FServe_ inside your _xchat\_plugin\_deinit_ function. The special item with name "-" will add a separator line.
+In the example above, it would be recommended to execute _MENU DEL FServe_ inside your _hexchat\_plugin\_deinit_ function. The special item with name "-" will add a separator line.
Parameters and flags:
@@ -407,7 +407,7 @@ ctcp_cb (char *word[], char *word_eol[], void *userdata)
get_file_name (nick, word[2]);
}
- return HEXCHAT_EAT_XCHAT;
+ return HEXCHAT_EAT_hexchat;
}
static void
@@ -465,26 +465,26 @@ get_file_name (char *nick, char *fname)
***
-### xchat\_hook\_command ()
+### hexchat\_hook\_command ()
-**Prototype:** xchat\_hook \*xchat\_hook\_command (xchat\_plugin \*ph, const char \*name, int pri, xchat\_cmd\_cb \*callb, const char \*help\_text, void \*userdata);
+**Prototype:** hexchat\_hook \*hexchat\_hook\_command (hexchat\_plugin \*ph, const char \*name, int pri, hexchat\_cmd\_cb \*callb, const char \*help\_text, void \*userdata);
**Description:** Adds a new _/command_. This allows your program to
handle commands entered at the input box. To capture text without a "/" at
-the start (non-commands), you may hook a special name of "". i.e _xchat\_hook\_command (ph, "", ...);_.
+the start (non-commands), you may hook a special name of "". i.e _hexchat\_hook\_command (ph, "", ...);_.
Commands hooked that begin with a period ('.') will be hidden in _/HELP_ and _/HELP -l_.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **name:** Name of the command (without the forward slash).
- * **pri:** Priority of this command. Use _XCHAT\_PRI\_NORM_.
+ * **pri:** Priority of this command. Use _hexchat\_PRI\_NORM_.
* **callb:** Callback function. This will be called when the user executes the given command name.
* **help\_text:** String of text to display when the user executes _/HELP_ for this command. May be NULL if you're lazy.
* **userdata:** Pointer passed to the callback function.
-**Returns:** Pointer to the hook. Can be passed to _xchat\_unhook ()_.
+**Returns:** Pointer to the hook. Can be passed to _hexchat\_unhook ()_.
**Example:**
@@ -507,34 +507,34 @@ hexchat_hook_command (ph, "ONOTICE", HEXCHAT_PRI_NORM, onotice_cb, "Usage: ONOTI
***
-### xchat\_hook\_fd ()
+### hexchat\_hook\_fd ()
-**Prototype:** xchat\_hook \*xchat\_hook\_fd (xchat\_plugin \*ph, int fd, int flags, xchat\_fd\_cb \*callb, void \*userdata);
+**Prototype:** hexchat\_hook \*hexchat\_hook\_fd (hexchat\_plugin \*ph, int fd, int flags, hexchat\_fd\_cb \*callb, void \*userdata);
**Description:** Hooks a socket or file descriptor. WIN32: Passing a pipe from MSVCR71, MSVCR80 or other variations is not supported at this time.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **fd:** The file descriptor or socket.
- * **flags:** One or more of _XCHAT\_FD\_READ_, _XCHAT\_FD\_WRITE_, _XCHAT\_FD\_EXCEPTION_, _XCHAT\_FD\_NOTSOCKET_. Use bitwise OR to combine them. _XCHAT\_FD\_NOTSOCKET_ tells HexChat that the provided _fd__ is not a socket, but an "MSVCRT.DLL" pipe.
+ * **flags:** One or more of _hexchat\_FD\_READ_, _hexchat\_FD\_WRITE_, _hexchat\_FD\_EXCEPTION_, _hexchat\_FD\_NOTSOCKET_. Use bitwise OR to combine them. _hexchat\_FD\_NOTSOCKET_ tells HexChat that the provided _fd__ is not a socket, but an "MSVCRT.DLL" pipe.
* **callb:** Callback function. This will be called when the socket is available for reading/writing or exception (depending on your chosen _flags_)
* **userdata:** Pointer passed to the callback function.
-**Returns:** Pointer to the hook. Can be passed to _xchat\_unhook ()_.
+**Returns:** Pointer to the hook. Can be passed to _hexchat\_unhook ()_.
***
-### xchat\_hook\_print ()
+### hexchat\_hook\_print ()
-**Prototype:** xchat\_hook \*xchat\_hook\_print (xchat\_plugin \*ph, const char \*name, int pri, xchat\_print\_cb \*callb, void \*userdata);
+**Prototype:** hexchat\_hook \*hexchat\_hook\_print (hexchat\_plugin \*ph, const char \*name, int pri, hexchat\_print\_cb \*callb, void \*userdata);
**Description:** Registers a function to trap any print events.
The event names may be any available in the "Advanced > Text Events" window.
There are also some extra "special" events you may hook using this function.
Currently they are:
- * "Open Context": Called when a new xchat\_context is created.
- * "Close Context": Called when a xchat\_context pointer is closed.
+ * "Open Context": Called when a new hexchat\_context is created.
+ * "Close Context": Called when a hexchat\_context pointer is closed.
* "Focus Tab": Called when a tab is brought to front.
* "Focus Window": Called a toplevel window is focused, or the main tab-window is focused by the window manager.
* "DCC Chat Text": Called when some text from a DCC Chat arrives. It provides these elements in the _word[]_ array:
@@ -554,13 +554,13 @@ Currently they are:
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **name:** Name of the print event (as in _Edit Event Texts_ window).
- * **pri:** Priority of this command. Use XCHAT\_PRI\_NORM.
+ * **pri:** Priority of this command. Use HEXCHAT\_PRI\_NORM.
* **callb:** Callback function. This will be called when this event name is printed.
* **userdata:** Pointer passed to the callback function.
-**Returns:** Pointer to the hook. Can be passed to _xchat\_unhook ()_.
+**Returns:** Pointer to the hook. Can be passed to _hexchat\_unhook ()_.
**Example:**
@@ -569,7 +569,7 @@ static int
youpart_cb (char *word[], void *userdata)
{
hexchat_printf (ph, "You have left channel %s\n", word[3]);
- return HEXCHAT_EAT_XCHAT; /* dont let HexChat do its normal printing */
+ return HEXCHAT_EAT_hexchat; /* dont let HexChat do its normal printing */
}
hexchat_hook_print (ph, "You Part", HEXCHAT_PRI_NORM, youpart_cb, NULL);
@@ -577,9 +577,9 @@ hexchat_hook_print (ph, "You Part", HEXCHAT_PRI_NORM, youpart_cb, NULL);
***
-### xchat\_hook\_server ()
+### hexchat\_hook\_server ()
-**Prototype:** xchat\_hook \*xchat\_hook\_server (xchat\_plugin \*ph, const char \*name, int pri, xchat\_serv\_cb \*callb, void \*userdata);
+**Prototype:** hexchat\_hook \*hexchat\_hook\_server (hexchat\_plugin \*ph, const char \*name, int pri, hexchat\_serv\_cb \*callb, void \*userdata);
**Description:** Registers a function to be called when a certain server event occurs. You can
use this to trap _PRIVMSG_, _NOTICE_, _PART_, a server numeric, etc. If you want to
@@ -587,13 +587,13 @@ hook every line that comes from the IRC server, you may use the special name of
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **name:** Name of the server event.
- * **pri:** Priority of this command. Use XCHAT\_PRI\_NORM.
+ * **pri:** Priority of this command. Use HEXCHAT\_PRI\_NORM.
* **callb:** Callback function. This will be called when this event is received from the server.
* **userdata:** Pointer passed to the callback function.
-**Returns:** Pointer to the hook. Can be passed to _xchat\_unhook_.
+**Returns:** Pointer to the hook. Can be passed to _hexchat\_unhook_.
**Example:**
@@ -609,15 +609,15 @@ hexchat_hook_server (ph, "KICK", HEXCHAT_PRI_NORM, kick_cb, NULL);
***
-### xchat\_hook\_timer ()
+### hexchat\_hook\_timer ()
-**Prototype:** xchat\_hook \*xchat\_hook\_timer (xchat\_plugin \*ph, int timeout, xchat\_timer\_cb \*callb, void \*userdata);
+**Prototype:** hexchat\_hook \*hexchat\_hook\_timer (hexchat\_plugin \*ph, int timeout, hexchat\_timer\_cb \*callb, void \*userdata);
**Description:** Registers a function to be called every "timeout" milliseconds.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **timeout:** Timeout in milliseconds (1000 is 1 second).
* **callb:** Callback function. This will be called every "timeout" milliseconds.
* **userdata:** Pointer passed to the callback function.
@@ -655,81 +655,81 @@ hexchat_hook_command (ph, "STOP", HEXCHAT_PRI_NORM, stop_cb, NULL, NULL);
***
-### xchat\_unhook ()
+### hexchat\_unhook ()
-**Prototype:** void \*xchat\_unhook (xchat\_plugin \*ph, xchat\_hook \*hook);
+**Prototype:** void \*hexchat\_unhook (hexchat\_plugin \*ph, hexchat\_hook \*hook);
-**Description:** Unhooks any hook registered with xchat\_hook\_print/server/timer/command. When plugins are unloaded, all of its hooks are automatically removed, so you don't need to call this within your xchat\_plugin\_deinit () function.
+**Description:** Unhooks any hook registered with hexchat\_hook\_print/server/timer/command. When plugins are unloaded, all of its hooks are automatically removed, so you don't need to call this within your hexchat\_plugin\_deinit () function.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
- * **hook:** Pointer to the hook, as returned by xchat\_hook\_*.
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
+ * **hook:** Pointer to the hook, as returned by hexchat\_hook\_*.
-**Returns:** The userdata you originally gave to xchat\_hook\_*.
+**Returns:** The userdata you originally gave to hexchat\_hook\_*.
***
-### xchat\_command ()
+### hexchat\_command ()
-**Prototype:** void xchat\_command (xchat\_plugin \*ph, const char \*command);
+**Prototype:** void hexchat\_command (hexchat\_plugin \*ph, const char \*command);
**Description:** Executes a command as if it were typed in HexChat's input box.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **command:** Command to execute, without the forward slash "/".
***
-### xchat\_commandf ()
+### hexchat\_commandf ()
-**Prototype:** void xchat\_commandf (xchat\_plugin \*ph, const char \*format, ...);
+**Prototype:** void hexchat\_commandf (hexchat\_plugin \*ph, const char \*format, ...);
**Description:** Executes a command as if it were typed in HexChat's input box and provides string formatting like _printf ()_.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **format:** The format string.
***
-### xchat\_print ()
+### hexchat\_print ()
-**Prototype:** void xchat\_print (xchat\_plugin \*ph, const char \*text);
+**Prototype:** void hexchat\_print (hexchat\_plugin \*ph, const char \*text);
**Description:** Prints some text to the current tab/window.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **text:** Text to print. May contain mIRC color codes.
***
-### xchat\_printf ()
+### hexchat\_printf ()
-**Prototype:** void xchat\_printf (xchat\_plugin \*ph, const char \*format, ...);
+**Prototype:** void hexchat\_printf (hexchat\_plugin \*ph, const char \*format, ...);
**Description:** Prints some text to the current tab/window and provides formatting like _printf ()_.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **format:** The format string.
***
-### xchat\_emit\_print ()
-**Prototype:** int xchat\_emit\_print (xchat\_plugin \*ph, const char \*event\_name, ...);
+### hexchat\_emit\_print ()
+**Prototype:** int hexchat\_emit\_print (hexchat\_plugin \*ph, const char \*event\_name, ...);
-**Description:** Generates a print event. This can be any event found in the Preferences > Advanced > Text Events window. The vararg parameter list **must** always be NULL terminated. Special care should be taken when calling this function inside a print callback (from xchat\_hook\_print), as not to cause endless recursion.
+**Description:** Generates a print event. This can be any event found in the Preferences > Advanced > Text Events window. The vararg parameter list **must** always be NULL terminated. Special care should be taken when calling this function inside a print callback (from hexchat\_hook\_print), as not to cause endless recursion.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **event_name:** Text event to print.
**Returns:**
@@ -745,9 +745,9 @@ hexchat_emit_print (ph, "Channel Message", "John", "Hi there", "@", NULL);
***
-### xchat\_send\_modes ()
+### hexchat\_send\_modes ()
-**Prototype:** void xchat\_send\_modes (xchat\_plugin \*ph, const char \*targets[], int ntargets, int modes_per_line, char sign, char mode)
+**Prototype:** void hexchat\_send\_modes (hexchat\_plugin \*ph, const char \*targets[], int ntargets, int modes_per_line, char sign, char mode)
**Description:** Sends a number of channel mode changes to the current channel. For example, you can Op a whole
group of people in one go. It may send multiple MODE lines if the request doesn't fit on one. Pass 0 for
@@ -756,7 +756,7 @@ in a channel context.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **targets:** Array of targets (strings). The names of people whom the action will be performed on.
* **ntargets:** Number of elements in the array given.
* **modes_per_line:** Maximum modes to send per line.
@@ -772,9 +772,9 @@ hexchat_send_modes (ph, names_to_Op, 3, 0, '+', 'o');
***
-### xchat\_find\_context ()
+### hexchat\_find\_context ()
-**Prototype:** xchat\_context \*xchat\_find\_context (xchat\_plugin \*ph, const char \*servname, const char \*channel);
+**Prototype:** hexchat\_context \*hexchat\_find\_context (hexchat\_plugin \*ph, const char \*servname, const char \*channel);
**Description:** Finds a context based on a channel and servername. If _servname_ is NULL, it finds any channel (or query) by the given name. If _channel_ is NULL, it finds the front-most tab/window of the given _servname_. If NULL is given for both arguments, the currently focused tab/window will be returned.
@@ -782,37 +782,37 @@ Changed in 2.6.1. If _servname_ is NULL, it finds the channel (or query) by the
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **servname:** Server name or NULL.
* **channel:** Channel name or NULL.
-**Returns:** Context pointer (for use with _xchat\_set\_context_) or NULL.
+**Returns:** Context pointer (for use with _hexchat\_set\_context_) or NULL.
***
-### xchat\_get\_context ()
+### hexchat\_get\_context ()
-**Prototype:** xchat\_context \*xchat\_get\_context (xchat\_plugin \*ph);
+**Prototype:** hexchat\_context \*hexchat\_get\_context (hexchat\_plugin \*ph);
-**Description:** Returns the current context for your plugin. You can use this later with _xchat\_set\_context ()_.
+**Description:** Returns the current context for your plugin. You can use this later with _hexchat\_set\_context ()_.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
-**Returns:** Context pointer (for use with _xchat\_set\_context_).
+**Returns:** Context pointer (for use with _hexchat\_set\_context_).
***
-### xchat\_get\_info ()
+### hexchat\_get\_info ()
-**Prototype:** const char \*xchat\_get\_info (xchat\_plugin \*ph, const char \*id);
+**Prototype:** const char \*hexchat\_get\_info (hexchat\_plugin \*ph, const char \*id);
**Description:** Returns information based on your current context.
**Arguments:**
- * **ph:** Plugin handle (as given to _xchat\_plugin\_init ()_).
+ * **ph:** Plugin handle (as given to _hexchat\_plugin\_init ()_).
* **id:** ID of the information you want. Currently supported IDs are (case sensitive):
@@ -824,29 +824,29 @@ Changed in 2.6.1. If _servname_ is NULL, it finds the channel (or query) by the
| gtkwin_ptr | (GtkWindow *) (since 2.8.9). |
| host | real hostname of the server you connected to. |
| inputbox | the input-box contents, what the user has typed (since 2.4.1). |
- | libdirfs | library directory. e.g. /usr/lib/xchat. The same directory used for auto-loading plugins (since 2.4.0).This string isn't necessarily UTF-8, but local file system encoding. |
+ | libdirfs | library directory. e.g. /usr/lib/hexchat. The same directory used for auto-loading plugins (since 2.4.0).This string isn't necessarily UTF-8, but local file system encoding. |
| modes | channel modes, if known, or NULL (since 2.8.1). |
| network | current network name or NULL. |
| nick | your current nick name. |
| nickserv | nickserv password for this network or NULL (since 2.4.3). |
| server | current server name (what the server claims to be). NULL if you are not connected. |
| topic | current channel topic. |
- | version | xchat version number. |
+ | version | HexChat version number. |
| win_ptr | native window pointer. Unix: (GtkWindow *) Win32: HWND (since 2.6.0). |
| win_status | window status: "active", "hidden" or "normal" (since 2.0.9). |
-
| xchatdir | xchat config directory, e.g.: /home/user/.xchat2 This string is encoded in UTF-8, which means you _should_ convert it to "locale" encoding before using functions like open() or OpenFile(). For best Unicode support on Linux, convert this string using g_filename_from_utf8 and on Windows convert this string to UTF-16LE (wide) and use OpenFileW() etc. |
- | xchatdirfs | xchat config directory, e.g.: /home/user/.xchat2 (since 2.0.9).This string is encoded in local file system encoding, making it ideal for direct use with functions like open() or OpenFile(). For real Unicode support on Windows, it's best not to use HexChatdirfs, but HexChatdir instead. |
+ | xchatdir | HexChat config directory, e.g.: /home/user/.config/hexchat This string is encoded in UTF-8, which means you _should_ convert it to "locale" encoding before using functions like open() or OpenFile(). For best Unicode support on Linux, convert this string using g_filename_from_utf8 and on Windows convert this string to UTF-16LE (wide) and use OpenFileW() etc. |
+ | xchatdirfs | HexChat config directory, e.g.: /home/user/.config/hexchat (since 2.0.9).This string is encoded in local file system encoding, making it ideal for direct use with functions like open() or OpenFile(). For real Unicode support on Windows, it's best not to use xchatdirfs, but xchatdir instead. |