pidgin/pidginplugininfo.h

Tue, 19 Oct 2021 02:49:28 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Tue, 19 Oct 2021 02:49:28 -0500
changeset 41124
95555046173e
parent 40894
80d9d7a73a60
child 41138
dcfc73ec61c7
permissions
-rw-r--r--

Convert pidgin from gtk-doc to gi-docgen

Testing Done:
Ran the docs locally and in convey.

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

40221
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
1 /* pidgin
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
2 *
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
3 * Pidgin is the legal property of its developers, whose names are too numerous
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
4 * to list here. Please refer to the COPYRIGHT file distributed with this
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
5 * source distribution.
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
6 *
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
7 * This program is free software; you can redistribute it and/or modify
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
8 * it under the terms of the GNU General Public License as published by
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
9 * the Free Software Foundation; either version 2 of the License, or
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
10 * (at your option) any later version.
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
11 *
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful,
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
15 * GNU General Public License for more details.
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
16 *
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
18 * along with this program; if not, write to the Free Software
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
20 */
40502
875489636847 pidgin.h phase3: create pidgin.h and force its usage
Gary Kramlich <grim@reaperworld.com>
parents: 40496
diff changeset
21
875489636847 pidgin.h phase3: create pidgin.h and force its usage
Gary Kramlich <grim@reaperworld.com>
parents: 40496
diff changeset
22 #if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
875489636847 pidgin.h phase3: create pidgin.h and force its usage
Gary Kramlich <grim@reaperworld.com>
parents: 40496
diff changeset
23 # error "only <pidgin.h> may be included directly"
875489636847 pidgin.h phase3: create pidgin.h and force its usage
Gary Kramlich <grim@reaperworld.com>
parents: 40496
diff changeset
24 #endif
875489636847 pidgin.h phase3: create pidgin.h and force its usage
Gary Kramlich <grim@reaperworld.com>
parents: 40496
diff changeset
25
40221
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
26 #ifndef PIDGIN_PLUGIN_INFO_H
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
27 #define PIDGIN_PLUGIN_INFO_H
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
28
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
29 #include <gtk/gtk.h>
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
30
40894
80d9d7a73a60 Convert the Pidgin plugins to use GPLUGIN_NATIVE_PLUGIN_DECLARE
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
31 #include <gplugin.h>
80d9d7a73a60 Convert the Pidgin plugins to use GPLUGIN_NATIVE_PLUGIN_DECLARE
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
32
40221
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
33 #include <purple.h>
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
34
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
35 G_BEGIN_DECLS
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
36
41124
95555046173e Convert pidgin from gtk-doc to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40894
diff changeset
37 /**
95555046173e Convert pidgin from gtk-doc to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40894
diff changeset
38 * PidginPluginInfo:
95555046173e Convert pidgin from gtk-doc to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40894
diff changeset
39 *
95555046173e Convert pidgin from gtk-doc to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40894
diff changeset
40 * A #GPluginPluginInfo subclass that adds some Pidgin specific properties.
95555046173e Convert pidgin from gtk-doc to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40894
diff changeset
41 *
95555046173e Convert pidgin from gtk-doc to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40894
diff changeset
42 * Since: 3.0.0
95555046173e Convert pidgin from gtk-doc to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40894
diff changeset
43 */
95555046173e Convert pidgin from gtk-doc to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40894
diff changeset
44
40221
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
45 #define PIDGIN_TYPE_PLUGIN_INFO (pidgin_plugin_info_get_type())
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
46 G_DECLARE_FINAL_TYPE(PidginPluginInfo, pidgin_plugin_info, PIDGIN, PLUGIN_INFO, PurplePluginInfo)
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
47
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
48 /**
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
49 * pidgin_plugin_info_new:
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
50 * @first_property: The first property name
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
51 * @...: The value of the first property, followed optionally by more
40224
6b658d1458c8 Fix a handful of issues found in review
Gary Kramlich <grim@reaperworld.com>
parents: 40221
diff changeset
52 * name/value pairs, followed by %NULL
40221
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
53 *
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
54 * Creates a new #PidginPluginInfo instance to be returned from
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
55 * #plugin_query of a pidgin plugin, using the provided name/value
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
56 * pairs.
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
57 *
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
58 * See purple_plugin_info_new() for a list of available property names.
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
59 * Additionally, you can provide the property
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
60 * <literal>"gtk-config-frame-cb"</literal>, which should be a callback that
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
61 * returns a #GtkWidget for the plugin's configuration
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
62 * (see #PidginPluginConfigFrameCb).
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
63 *
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
64 * See purple_plugin_info_new().
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
65 *
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
66 * Returns: A new #PidginPluginInfo instance.
40225
b6f1592a07ec Clean up some reference counting, doc comments and a build tweak
Gary Kramlich <grim@reaperworld.com>
parents: 40224
diff changeset
67 *
b6f1592a07ec Clean up some reference counting, doc comments and a build tweak
Gary Kramlich <grim@reaperworld.com>
parents: 40224
diff changeset
68 * Since: 3.0.0
40221
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
69 */
40894
80d9d7a73a60 Convert the Pidgin plugins to use GPLUGIN_NATIVE_PLUGIN_DECLARE
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
70 GPluginPluginInfo *pidgin_plugin_info_new(const char *first_property, ...) G_GNUC_NULL_TERMINATED;
40221
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
71
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
72 G_END_DECLS
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
73
e34d79e34f9f Move PidginPluginInfo to it's own file and remove references to the broken gtk config frame code. This is going to be overhauled in an upcomming commit
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
74 #endif /* PIDGIN_PLUGIN_INFO_H */

mercurial