finch/gntaccount.h

Thu, 13 Aug 2020 21:10:22 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Thu, 13 Aug 2020 21:10:22 -0500
changeset 40508
2ebcb8eb5c01
parent 40359
ca141ea93b83
child 41123
089c8a3a9ff4
permissions
-rw-r--r--

create a global header for finch

create a global include file for finch

protect all the finch header files and update the plugins to use the global header

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

39887
9c8f874c74a0 Clean up all of the license headers
Gary Kramlich <grim@reaperworld.com>
parents: 39885
diff changeset
1 /*
9c8f874c74a0 Clean up all of the license headers
Gary Kramlich <grim@reaperworld.com>
parents: 39885
diff changeset
2 * finch
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
3 *
15931
716b5fac1895 Re-sed the copyright notices so they don't all talk about Purple.
Richard Laager <rlaager@pidgin.im>
parents: 15906
diff changeset
4 * Finch is the legal property of its developers, whose names are too numerous
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
5 * to list here. Please refer to the COPYRIGHT file distributed with this
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
6 * source distribution.
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
7 *
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
8 * This program is free software; you can redistribute it and/or modify
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
9 * it under the terms of the GNU General Public License as published by
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
10 * the Free Software Foundation; either version 2 of the License, or
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
11 * (at your option) any later version.
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
12 *
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
13 * This program is distributed in the hope that it will be useful,
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
16 * GNU General Public License for more details.
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
17 *
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
18 * You should have received a copy of the GNU General Public License
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
19 * 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: 16255
diff changeset
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
21 */
35487
494f09f7f331 Move section blocks inside inclusion guards -- otherwise g-ir-scanner yells
Ankit Vani <a@nevitus.org>
parents: 35486
diff changeset
22
40508
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents: 40359
diff changeset
23 #if !defined(FINCH_GLOBAL_HEADER_INSIDE) && !defined(FINCH_COMPILATION)
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents: 40359
diff changeset
24 # error "only <finch.h> may be included directly"
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents: 40359
diff changeset
25 #endif
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents: 40359
diff changeset
26
39885
b1b266896ec1 Fix the header guards for finch
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
27 #ifndef FINCH_ACCOUNT_H
b1b266896ec1 Fix the header guards for finch
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
28 #define FINCH_ACCOUNT_H
b1b266896ec1 Fix the header guards for finch
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
29
35449
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
30 /**
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
31 * SECTION:gntaccount
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
32 * @section_id: finch-gntaccount
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
33 * @short_description: <filename>gntaccount.h</filename>
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
34 * @title: Account API
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
35 */
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
36
40359
ca141ea93b83 Make all of finch use purple.h
Gary Kramlich <grim@reaperworld.com>
parents: 39887
diff changeset
37 #include <purple.h>
13969
0541f389442e [gaim-migrate @ 16402]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
38
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
39 /**********************************************************************
35472
474e26199560 Removed @name
Ankit Vani <a@nevitus.org>
parents: 35449
diff changeset
40 * GNT Account API
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
41 **********************************************************************/
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
42
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
43 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
44 * finch_accounts_get_ui_ops:
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
45 *
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
46 * Get the ui-functions.
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
47 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 32438
diff changeset
48 * Returns: The PurpleAccountUiOps structure populated with the appropriate functions.
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
49 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15878
diff changeset
50 PurpleAccountUiOps *finch_accounts_get_ui_ops(void);
13969
0541f389442e [gaim-migrate @ 16402]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
51
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
52 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
53 * finch_accounts_init:
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
54 *
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
55 * Perform necessary initializations.
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
56 */
15878
f52832b611fe renamed gaim-text to finch
Sean Egan <seanegan@pidgin.im>
parents: 14620
diff changeset
57 void finch_accounts_init(void);
13969
0541f389442e [gaim-migrate @ 16402]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
58
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
59 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
60 * finch_accounts_uninit:
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
61 *
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
62 * Perform necessary uninitializations.
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
63 */
15878
f52832b611fe renamed gaim-text to finch
Sean Egan <seanegan@pidgin.im>
parents: 14620
diff changeset
64 void finch_accounts_uninit(void);
14041
6afba85cfc30 [gaim-migrate @ 16540]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 13969
diff changeset
65
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
66 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
67 * finch_accounts_show_all:
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
68 *
14620
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
69 * Show the account-manager dialog.
90d599495d65 [gaim-migrate @ 17281]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 14260
diff changeset
70 */
15878
f52832b611fe renamed gaim-text to finch
Sean Egan <seanegan@pidgin.im>
parents: 14620
diff changeset
71 void finch_accounts_show_all(void);
14041
6afba85cfc30 [gaim-migrate @ 16540]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 13969
diff changeset
72
19969
53aca1037b2c Instead of just notifying the user about a connection error, give him options
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 19859
diff changeset
73 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
74 * finch_account_dialog_show:
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
75 * @account: The account to edit, or %NULL to create a new account.
19969
53aca1037b2c Instead of just notifying the user about a connection error, give him options
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 19859
diff changeset
76 *
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
77 * Show the edit dialog for an account.
19969
53aca1037b2c Instead of just notifying the user about a connection error, give him options
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 19859
diff changeset
78 */
53aca1037b2c Instead of just notifying the user about a connection error, give him options
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 19859
diff changeset
79 void finch_account_dialog_show(PurpleAccount *account);
53aca1037b2c Instead of just notifying the user about a connection error, give him options
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 19859
diff changeset
80
39885
b1b266896ec1 Fix the header guards for finch
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
81 #endif /* FINCH_ACCOUNT_H */
b1b266896ec1 Fix the header guards for finch
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
82

mercurial