pidgin/pidgincore.h

Fri, 14 Feb 2025 13:10:24 -0600

author
Elliott Sales de Andrade <quantum.analyst@gmail.com>
date
Fri, 14 Feb 2025 13:10:24 -0600
changeset 43177
595a5f31003a
parent 42649
6986f5428d30
permissions
-rw-r--r--

Annotate Pidgin constructors that return base types

In that case, annotating the actual type will help bindings use the correct type.

Testing Done:
Compared the gir before and after, and types were more specific:
```diff
--- Pidgin-3.0.gir 2025-02-14 01:13:40.813791641 -0500
+++ build/pidgin/Pidgin-3.0.gir 2025-02-14 03:05:58.968098262 -0500
@@ -54,8 +54,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginabout.h"
- line="58">A new instance of the about dialog.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="58">The new about dialog.</doc>
+ <type name="AboutDialog" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="application"
@@ -100,12 +100,13 @@
<doc xml:space="preserve"
filename="pidgin/pidginaccountchooser.h"
line="52">Creates a combo box filled with accounts.</doc>
- <source-position filename="pidgin/pidginaccountchooser.h" line="62"/>
+ <source-position filename="pidgin/pidginaccountchooser.h" line="63"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginaccountchooser.h"
- line="57">The account chooser combo box.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="57">The new account
+ chooser combo box.</doc>
+ <type name="AccountChooser" c:type="GtkWidget*"/>
</return-value>
</constructor>
<method name="get_filter"
@@ -258,12 +259,13 @@
<doc xml:space="preserve"
filename="pidgin/pidginaccountdisplay.h"
line="52">Creates a display for an account.</doc>
- <source-position filename="pidgin/pidginaccountdisplay.h" line="63"/>
+ <source-position filename="pidgin/pidginaccountdisplay.h" line="64"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginaccountdisplay.h"
- line="58">The account display.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="58">The new account
+ display.</doc>
+ <type name="AccountDisplay" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="account" transfer-ownership="none">
@@ -371,8 +373,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginaccounteditor.h"
- line="61">The new instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="61">The new account editor.</doc>
+ <type name="AccountEditor" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="account"
@@ -542,8 +544,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginaccountfilterconnected.h"
- line="60">The new #PidginAccountFilterConnected instance.</doc>
- <type name="Gtk.Filter" c:type="GtkFilter*"/>
+ line="60">The new filter.</doc>
+ <type name="AccountFilterConnected" c:type="GtkFilter*"/>
</return-value>
</constructor>
</class>
@@ -585,8 +587,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginaccountfilterprotocol.h"
- line="61">The new #PidginAccountFilterProtocol instance.</doc>
- <type name="Gtk.Filter" c:type="GtkFilter*"/>
+ line="61">The new filter.</doc>
+ <type name="AccountFilterProtocol" c:type="GtkFilter*"/>
</return-value>
<parameters>
<parameter name="protocol_id" transfer-ownership="none">
@@ -673,7 +675,7 @@
<doc xml:space="preserve"
filename="pidgin/pidginaccountmanager.h"
line="58">The dialog.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ <type name="AccountManager" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="application"
@@ -770,7 +772,7 @@
<doc xml:space="preserve"
filename="pidgin/pidginaccountmanagerrow.h"
line="58">The new account row.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ <type name="AccountManagerRow" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="account"
@@ -887,7 +889,7 @@
<doc xml:space="preserve"
filename="pidgin/pidginaccountrow.h"
line="62">The new instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ <type name="AccountRow" c:type="GtkWidget*"/>
</return-value>
</constructor>
<method name="get_account"
@@ -1056,8 +1058,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginaccountsdisabledmenu.h"
- line="60">The new menu instance.</doc>
- <type name="Gio.MenuModel" c:type="GMenuModel*"/>
+ line="60">The new instance.</doc>
+ <type name="AccountsDisabledMenu" c:type="GMenuModel*"/>
</return-value>
</constructor>
</class>
@@ -1097,8 +1099,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginaccountsenabledmenu.h"
- line="60">The new menu instance.</doc>
- <type name="Gio.MenuModel" c:type="GMenuModel*"/>
+ line="60">The new instance.</doc>
+ <type name="AccountsEnabledMenu" c:type="GMenuModel*"/>
</return-value>
</constructor>
</class>
@@ -1137,8 +1139,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginapplication.h"
- line="59">The new #PidginApplication instance.</doc>
- <type name="Gio.Application" c:type="GApplication*"/>
+ line="59">The new instance.</doc>
+ <type name="Application" c:type="GApplication*"/>
</return-value>
</constructor>
<method name="add_action_group"
@@ -1237,8 +1239,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginautoadjustment.h"
- line="61">The new #PidginAutoAdjustment instance.</doc>
- <type name="Gtk.Adjustment" c:type="GtkAdjustment*"/>
+ line="61">The new instance.</doc>
+ <type name="AutoAdjustment" c:type="GtkAdjustment*"/>
</return-value>
</constructor>
<method name="decrement"
@@ -1314,8 +1316,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginavatar.h"
- line="59">The new #PidginAvatar instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="59">The new instance.</doc>
+ <type name="Avatar" c:type="GtkWidget*"/>
</return-value>
</constructor>
<method name="get_animate"
@@ -1544,8 +1546,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/prefs/pidginawayprefs.h"
- line="58">The new #PidginAwayPrefs instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="58">The new instance.</doc>
+ <type name="AwayPrefs" c:type="GtkWidget*"/>
</return-value>
</constructor>
</class>
@@ -1583,7 +1585,7 @@
<doc xml:space="preserve"
filename="pidgin/pidginbadges.h"
line="59">The new widget.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ <type name="Badges" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="badges" transfer-ownership="none">
@@ -1696,8 +1698,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginchanneljoindialog.h"
- line="56">The widget.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="56">The new widget.</doc>
+ <type name="ChannelJoinDialog" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="application"
@@ -1750,8 +1752,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidgincontactlist.h"
- line="62">The new #PidginContactList instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="62">The new instance.</doc>
+ <type name="ContactList" c:type="GtkWidget*"/>
</return-value>
</constructor>
</class>
@@ -1791,7 +1793,7 @@
<doc xml:space="preserve"
filename="pidgin/pidginconversation.h"
line="62">The new widget.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ <type name="Conversation" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="conversation" transfer-ownership="none">
@@ -1914,12 +1916,13 @@
filename="pidgin/pidginconversationmember.h"
line="52">Creates a display for a conversation member.</doc>
<source-position filename="pidgin/pidginconversationmember.h"
- line="63"/>
+ line="64"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginconversationmember.h"
- line="58">The conversation member display.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="58">The conversation
+ member display.</doc>
+ <type name="ConversationMember" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="conversation_member" transfer-ownership="none">
@@ -2033,8 +2036,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/prefs/pidginconversationprefs.h"
- line="58">The new #PidginConversationPrefs instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="58">The new instance.</doc>
+ <type name="ConversationPrefs" c:type="GtkWidget*"/>
</return-value>
</constructor>
</class>
@@ -2077,8 +2080,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/prefs/pidgincredentialprefs.h"
- line="66">The new #PidginCredentialPrefs instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="66">The new instance.</doc>
+ <type name="CredentialPrefs" c:type="GtkWidget*"/>
</return-value>
</constructor>
</class>
@@ -2116,20 +2119,21 @@
version="3.0">
<doc xml:space="preserve"
filename="pidgin/prefs/pidgincredentialproviderrow.h"
- line="63">Creates a new #PidginCredentialProviderRow instance.</doc>
+ line="65">Creates a new #PidginCredentialProviderRow instance.</doc>
<source-position filename="pidgin/prefs/pidgincredentialproviderrow.h"
- line="74"/>
+ line="77"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/prefs/pidgincredentialproviderrow.h"
- line="69">The new #PidginCredentialProviderRow instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="71">The new
+ instance.</doc>
+ <type name="CredentialProviderRow" c:type="GtkWidget*"/>
</return-value>
@@ -2835,8 +2839,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidgindisplaywindow.h"
- line="60">The new #PidginDisplayWindow instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="60">The new instance.</doc>
+ <type name="DisplayWindow" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="application"
@@ -3163,8 +3167,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidgininfopane.h"
- line="60">The new #PidginInfoPane instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="60">The new instance.</doc>
+ <type name="InfoPane" c:type="GtkWidget*"/>
</return-value>
</constructor>
<method name="get_child"
@@ -3395,7 +3399,7 @@
<doc xml:space="preserve"
filename="pidgin/pidginkeypad.h"
line="57">The new instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ <type name="Keypad" c:type="GtkWidget*"/>
</return-value>
</constructor>
<method name="set_key_capture_widget"
@@ -3478,7 +3482,7 @@
<doc xml:space="preserve"
filename="pidgin/pidginmessage.h"
line="59">The new instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ <type name="Message" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="message"
@@ -3586,8 +3590,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/prefs/pidginnetworkprefs.h"
- line="58">The new #PidginNetworkPrefs instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="58">The new instance.</doc>
+ <type name="NetworkPrefs" c:type="GtkWidget*"/>
</return-value>
</constructor>
</class>
@@ -3735,7 +3739,7 @@
<doc xml:space="preserve"
filename="pidgin/pidginnotification.h"
line="74">The new instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ <type name="Notification" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="notification" transfer-ownership="none">
@@ -3885,9 +3889,9 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginnotificationaddcontact.h"
- line="66">The new #PidginNotificationAddContact
+ line="66">The new
instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ <type name="NotificationAddContact" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="notification" transfer-ownership="none">
@@ -3941,9 +3945,9 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginnotificationauthorizationrequest.h"
- line="66">The new #PidginNotificationAuthorizationRequest
- instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="66">The
+ new instance.</doc>
+ <type name="NotificationAuthorizationRequest" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="notification" transfer-ownership="none">
@@ -4006,12 +4010,13 @@
line="60">Creates a new #PidginNotificationConnectionError instance that will display
@notification.</doc>
<source-position filename="pidgin/pidginnotificationconnectionerror.h"
- line="72"/>
+ line="73"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginnotificationconnectionerror.h"
- line="67">The new instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="67">The new
+ instance.</doc>
+ <type name="NotificationConnectionError" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="notification" transfer-ownership="none">
@@ -4063,8 +4068,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginnotificationlink.h"
- line="64">The new #PidginNotificationLink instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="64">The new instance.</doc>
+ <type name="NotificationLink" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="notification" transfer-ownership="none">
@@ -4114,8 +4119,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginnotificationlist.h"
- line="59">The new #PidginNotificationList instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="59">The new instance.</doc>
+ <type name="NotificationList" c:type="GtkWidget*"/>
</return-value>
</constructor>
</class>
@@ -4161,8 +4166,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginpluginsmenu.h"
- line="56">The new #PidginPluginsMenu instance.</doc>
- <type name="Gio.MenuModel" c:type="GMenuModel*"/>
+ line="56">The new instance.</doc>
+ <type name="PluginsMenu" c:type="GMenuModel*"/>
</return-value>
</constructor>
</class>
@@ -4232,7 +4237,7 @@
<doc xml:space="preserve"
filename="pidgin/pidginpresenceicon.h"
line="61">The new presence icon.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ <type name="PresenceIcon" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="presence"
@@ -4475,12 +4480,13 @@
<doc xml:space="preserve"
filename="pidgin/pidginprotocolchooser.h"
line="54">Creates a drop down for a user to select a protocol from.</doc>
- <source-position filename="pidgin/pidginprotocolchooser.h" line="64"/>
+ <source-position filename="pidgin/pidginprotocolchooser.h" line="65"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/pidginprotocolchooser.h"
- line="59">The protocol chooser drop down.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="59">The protocol chooser
+ drop down.</doc>
+ <type name="ProtocolChooser" c:type="GtkWidget*"/>
</return-value>
</constructor>
<method name="get_protocol"
@@ -4581,8 +4587,8 @@
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="pidgin/prefs/pidginproxyprefs.h"
- line="58">The new #PidginProxyPrefs instance.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ line="58">The new instance.</doc>
+ <type name="ProxyPrefs" c:type="GtkWidget*"/>
</return-value>
</constructor>
</class>
@@ -4624,7 +4630,7 @@
<doc xml:space="preserve"
filename="pidgin/pidgintypinglabel.h"
line="60">The new widget.</doc>
- <type name="Gtk.Widget" c:type="GtkWidget*"/>
+ <type name="TypingLabel" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="conversation" transfer-ownership="none">
@@ -4745,7 +4751,7 @@
<doc xml:space="preserve"
filename="pidgin/pidginui.h"
line="60">The new instance.</doc>
- <type name="Purple.Ui" c:type="PurpleUi*"/>
+ <type name="Ui" c:type="PurpleUi*"/>
</return-value>
</constructor>
</class>
```

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

20330
650a7af9c238 remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@pidgin.im>
parents: 19859
diff changeset
1 /* pidgin
9791
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
2 *
15572
e069b22c1fc4 headers to pidgin
Sean Egan <seanegan@pidgin.im>
parents: 15562
diff changeset
3 * Pidgin is the legal property of its developers, whose names are too numerous
9791
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
4 * to list here. Please refer to the COPYRIGHT file distributed with this
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
5 * source distribution.
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
6 *
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
7 * This program is free software; you can redistribute it and/or modify
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
8 * it under the terms of the GNU General Public License as published by
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
9 * the Free Software Foundation; either version 2 of the License, or
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
10 * (at your option) any later version.
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
11 *
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful,
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
15 * GNU General Public License for more details.
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
16 *
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
18 * along with this program; if not, write to the Free Software
19859
71d37b57eff2 The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 19656
diff changeset
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
9791
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
20 */
35487
494f09f7f331 Move section blocks inside inclusion guards -- otherwise g-ir-scanner yells
Ankit Vani <a@nevitus.org>
parents: 35451
diff changeset
21
40502
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
40496
6941fece679b phase2 of pidgin.h: move existing file to pidgincore.h
Gary Kramlich <grim@reaperworld.com>
parents: 40490
diff changeset
26 #ifndef PIDGIN_CORE_H
6941fece679b phase2 of pidgin.h: move existing file to pidgincore.h
Gary Kramlich <grim@reaperworld.com>
parents: 40490
diff changeset
27 #define PIDGIN_CORE_H
35451
206524351826 Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35405
diff changeset
28
40496
6941fece679b phase2 of pidgin.h: move existing file to pidgincore.h
Gary Kramlich <grim@reaperworld.com>
parents: 40490
diff changeset
29 #include <glib.h>
20360
4cfcbb5dbf5e Fix include ordering so GDK_WINDOWING_X11 is defined with older Gtk
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 20330
diff changeset
30
40553
892459990bb7 Create a proper GtkApplication subclass for Pidgin and use it.
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
31 #include <purple.h>
892459990bb7 Create a proper GtkApplication subclass for Pidgin and use it.
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
32
42464
5de142a471e0 Add Since tags and visibility for Pidgin 2.x symbols
Elliott Sales de Andrade <quantum.analyst@gmail.com>
parents: 41867
diff changeset
33 #include "pidginversion.h"
5de142a471e0 Add Since tags and visibility for Pidgin 2.x symbols
Elliott Sales de Andrade <quantum.analyst@gmail.com>
parents: 41867
diff changeset
34
14636
5306c329992c [gaim-migrate @ 17298]
Daniel Atallah <datallah@pidgin.im>
parents: 14411
diff changeset
35 #ifdef _WIN32
35856
1777950ff49f cross-win32: fix pidgin code warnings and errors
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 35487
diff changeset
36 # include "win32/gtkwin32dep.h"
14636
5306c329992c [gaim-migrate @ 17298]
Daniel Atallah <datallah@pidgin.im>
parents: 14411
diff changeset
37 #endif
5306c329992c [gaim-migrate @ 17298]
Daniel Atallah <datallah@pidgin.im>
parents: 14411
diff changeset
38
42649
6986f5428d30 Add a doc check unit test to Pidgin and fix the issues it found
Gary Kramlich <grim@reaperworld.com>
parents: 42620
diff changeset
39 /**
6986f5428d30 Add a doc check unit test to Pidgin and fix the issues it found
Gary Kramlich <grim@reaperworld.com>
parents: 42620
diff changeset
40 * PIDGIN_PREFS_ROOT:
6986f5428d30 Add a doc check unit test to Pidgin and fix the issues it found
Gary Kramlich <grim@reaperworld.com>
parents: 42620
diff changeset
41 *
6986f5428d30 Add a doc check unit test to Pidgin and fix the issues it found
Gary Kramlich <grim@reaperworld.com>
parents: 42620
diff changeset
42 * A constants for the root of the preferences tree.
6986f5428d30 Add a doc check unit test to Pidgin and fix the issues it found
Gary Kramlich <grim@reaperworld.com>
parents: 42620
diff changeset
43 *
6986f5428d30 Add a doc check unit test to Pidgin and fix the issues it found
Gary Kramlich <grim@reaperworld.com>
parents: 42620
diff changeset
44 * Since: 2.0
6986f5428d30 Add a doc check unit test to Pidgin and fix the issues it found
Gary Kramlich <grim@reaperworld.com>
parents: 42620
diff changeset
45 */
16123
8b98683319e7 Rename /purple/gtk preferences back to /gaim/gtk to allow for smooth upgrades
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 16117
diff changeset
46 /* change this only when we have a sane upgrade path for old prefs */
16478
19107605c565 Works for me! Renames prefs: /core to /purple, /gaim/gtk to /pidgin, /gaim/gnt to /finch
Sean Egan <seanegan@pidgin.im>
parents: 16254
diff changeset
47 #define PIDGIN_PREFS_ROOT "/pidgin"
16123
8b98683319e7 Rename /purple/gtk preferences back to /gaim/gtk to allow for smooth upgrades
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 16117
diff changeset
48
17001
09ceabd6b129 Clarify the comments on the names for translators.
Richard Laager <rlaager@pidgin.im>
parents: 16977
diff changeset
49 /* Translators may want to transliterate the name.
09ceabd6b129 Clarify the comments on the names for translators.
Richard Laager <rlaager@pidgin.im>
parents: 16977
diff changeset
50 It is not to be translated. */
42464
5de142a471e0 Add Since tags and visibility for Pidgin 2.x symbols
Elliott Sales de Andrade <quantum.analyst@gmail.com>
parents: 41867
diff changeset
51 #define PIDGIN_NAME _("Pidgin") PIDGIN_AVAILABLE_MACRO_IN_2_1
16977
c9cb49bea66d Change the PIDGIN_NAME stuff to allow translators to transliterate the
Richard Laager <rlaager@pidgin.im>
parents: 16478
diff changeset
52
40711
3ec3eae31fe4 Fix a number of issues with the pidgin api reference
Gary Kramlich <grim@reaperworld.com>
parents: 40553
diff changeset
53 /**
3ec3eae31fe4 Fix a number of issues with the pidgin api reference
Gary Kramlich <grim@reaperworld.com>
parents: 40553
diff changeset
54 * PIDGIN_ALERT_TITLE:
3ec3eae31fe4 Fix a number of issues with the pidgin api reference
Gary Kramlich <grim@reaperworld.com>
parents: 40553
diff changeset
55 *
3ec3eae31fe4 Fix a number of issues with the pidgin api reference
Gary Kramlich <grim@reaperworld.com>
parents: 40553
diff changeset
56 * The title that should be used for alert dialogs.
3ec3eae31fe4 Fix a number of issues with the pidgin api reference
Gary Kramlich <grim@reaperworld.com>
parents: 40553
diff changeset
57 */
9791
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
58 #ifndef _WIN32
15882
1dbd5756b7bf More Gaim to Pidgin stuff
Sean Egan <seanegan@pidgin.im>
parents: 15692
diff changeset
59 # define PIDGIN_ALERT_TITLE ""
9791
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
60 #else
15882
1dbd5756b7bf More Gaim to Pidgin stuff
Sean Egan <seanegan@pidgin.im>
parents: 15692
diff changeset
61 # define PIDGIN_ALERT_TITLE PIDGIN_NAME
9791
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
62 #endif
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
63
35387
c516874b0d14 Prepare files for gtk-doc conversion.
Ankit Vani <a@nevitus.org>
parents: 33683
diff changeset
64 /**
35405
d3f9e6dad44b Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents: 35387
diff changeset
65 * pidgin_start:
40711
3ec3eae31fe4 Fix a number of issues with the pidgin api reference
Gary Kramlich <grim@reaperworld.com>
parents: 40553
diff changeset
66 * @argc: The argc from main() (or 0 if argv is %NULL).
3ec3eae31fe4 Fix a number of issues with the pidgin api reference
Gary Kramlich <grim@reaperworld.com>
parents: 40553
diff changeset
67 * @argv: The argv from main(), or %NULL.
35405
d3f9e6dad44b Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents: 35387
diff changeset
68 *
35387
c516874b0d14 Prepare files for gtk-doc conversion.
Ankit Vani <a@nevitus.org>
parents: 33683
diff changeset
69 * Start pidgin with the given command line arguments.
42467
2b1d9d0770f2 Add Since and symbol visibility on remaining Pidgin API
Elliott Sales de Andrade <quantum.analyst@gmail.com>
parents: 42464
diff changeset
70 *
42649
6986f5428d30 Add a doc check unit test to Pidgin and fix the issues it found
Gary Kramlich <grim@reaperworld.com>
parents: 42620
diff changeset
71 * Returns: The exit code for the program.
6986f5428d30 Add a doc check unit test to Pidgin and fix the issues it found
Gary Kramlich <grim@reaperworld.com>
parents: 42620
diff changeset
72 *
42620
72178a341eb8 Remove minor versions from Since tags in Pidgin
Elliott Sales de Andrade <quantum.analyst@gmail.com>
parents: 42467
diff changeset
73 * Since: 3.0
35387
c516874b0d14 Prepare files for gtk-doc conversion.
Ankit Vani <a@nevitus.org>
parents: 33683
diff changeset
74 */
42467
2b1d9d0770f2 Add Since and symbol visibility on remaining Pidgin API
Elliott Sales de Andrade <quantum.analyst@gmail.com>
parents: 42464
diff changeset
75 PIDGIN_AVAILABLE_IN_3_0
35387
c516874b0d14 Prepare files for gtk-doc conversion.
Ankit Vani <a@nevitus.org>
parents: 33683
diff changeset
76 int pidgin_start(int argc, char *argv[]);
c516874b0d14 Prepare files for gtk-doc conversion.
Ankit Vani <a@nevitus.org>
parents: 33683
diff changeset
77
40496
6941fece679b phase2 of pidgin.h: move existing file to pidgincore.h
Gary Kramlich <grim@reaperworld.com>
parents: 40490
diff changeset
78 #endif /* PIDGIN_CORE_H */
9791
f5c5bda0b96b [gaim-migrate @ 10659]
Gary Kramlich <grim@pidgin.im>
parents:
diff changeset
79

mercurial