doc/reference/libpurple/signals_core.md

Tue, 23 Jan 2024 01:24:59 -0600

author
Gary Kramlich <grim@reaperworld.com>
date
Tue, 23 Jan 2024 01:24:59 -0600
changeset 42581
73eda937c387
parent 42095
01e68f28576f
permissions
-rw-r--r--

Add purple_contact_info_get_menu and PurpleContactInfo::populate-menu

This is the replacement for the blist-node-extended-menu signal in purple 2.

This uses BirbActionMenu which means libpurple now depends on birb.

Testing Done:
Ran the unit tests under valgrind.

Reviewed at https://reviews.imfreedom.org/r/2837/

41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
1 Title: Core Signals
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
2 Slug: core-signals
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
3
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
4 ## Core Signals
35389
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
5
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
6 ### Signal List
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
7
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
8 * [core-uri-handler](#uri-handler)
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
9
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
10 ### Signal Details
35389
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
11
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
12 #### uri-handler
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
13
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
14 ```c
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
15 gboolean user_function(const gchar *proto,
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
16 const gchar *cmd,
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
17 GHashTable *params,
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
18 gpointer user_data);
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
19 ```
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
20
35389
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
21 Emitted when handling a registered URI.
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
22
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
23 **Parameters:**
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
24
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
25 **proto**
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
26 : The protocol of the URI.
35389
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
27
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
28 **cmd**
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
29 : The 'command' of the URI.
35389
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
30
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
31 **params**
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
32 : Any key/value parameters from the URI.
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
33
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
34 **user_data**
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 37033
diff changeset
35 : User data set when the signal handler was connected.

mercurial