annotate pidgin/pidgin.h @ 28278:ff801b5e51ec

Use my name rather than my handle.
author maiku@pidgin.im
date Tue, 18 Aug 2009 02:32:43 +0000
parents cfb4e3dc7a23
children 2dcff225172e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
1 /**
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
2 * @file pidgin.h UI definitions and includes
16193
247e421c4fa6 Rename the Doxygen group from gtkui to pidgin.
Richard Laager <rlaager@wiktel.com>
parents: 16064
diff changeset
3 * @ingroup pidgin
20074
6bf32c9e15a7 remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents: 19680
diff changeset
4 */
6bf32c9e15a7 remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents: 19680
diff changeset
5
6bf32c9e15a7 remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents: 19680
diff changeset
6 /* pidgin
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
7 *
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
8 * Pidgin is the legal property of its developers, whose names are too numerous
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
9 * to list here. Please refer to the COPYRIGHT file distributed with this
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
10 * source distribution.
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
11 *
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
12 * This program is free software; you can redistribute it and/or modify
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
13 * it under the terms of the GNU General Public License as published by
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
14 * the Free Software Foundation; either version 2 of the License, or
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
15 * (at your option) any later version.
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
16 *
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
17 * This program is distributed in the hope that it will be useful,
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
20 * GNU General Public License for more details.
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
21 *
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
22 * You should have received a copy of the GNU General Public License
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
23 * along with this program; if not, write to the Free Software
19680
44b4e8bd759b The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 19478
diff changeset
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
25 */
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
26 /* #warning ***pidgin*** */
15632
a830f9756f23 Some more pidgininfication
Daniel Atallah <daniel.atallah@gmail.com>
parents: 15539
diff changeset
27 #ifndef _PIDGIN_H_
a830f9756f23 Some more pidgininfication
Daniel Atallah <daniel.atallah@gmail.com>
parents: 15539
diff changeset
28 #define _PIDGIN_H_
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
29
20105
b5e35cce4f85 Fix include ordering so GDK_WINDOWING_X11 is defined with older Gtk
Stu Tomlinson <stu@nosnilmot.com>
parents: 20074
diff changeset
30 #include <gtk/gtk.h>
b5e35cce4f85 Fix include ordering so GDK_WINDOWING_X11 is defined with older Gtk
Stu Tomlinson <stu@nosnilmot.com>
parents: 20074
diff changeset
31
19478
b2578b2d4bc4 Remove X11 specifics from configure.ac. Allows to build against native, non-X11 Quartz
Sean Egan <seanegan@gmail.com>
parents: 16954
diff changeset
32 #ifdef GDK_WINDOWING_X11
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
33 # include <gdk/gdkx.h>
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
34 #endif
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
35
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
36 #ifdef _WIN32
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
37 # include "gtkwin32dep.h"
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
38 #endif
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
39
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
40 /**
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
41 * Our UI's identifier.
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
42 */
16056
fccb6b33aba6 Revert to internal UI name of gtk-gaim to preserve UI prefs on upgrade
Stu Tomlinson <stu@nosnilmot.com>
parents: 15871
diff changeset
43 /* leave this as gtk-gaim until we have a decent way to migrate UI-prefs */
fccb6b33aba6 Revert to internal UI name of gtk-gaim to preserve UI prefs on upgrade
Stu Tomlinson <stu@nosnilmot.com>
parents: 15871
diff changeset
44 #define PIDGIN_UI "gtk-gaim"
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
45
16062
07554cc5d090 Rename /purple/gtk preferences back to /gaim/gtk to allow for smooth upgrades
Stu Tomlinson <stu@nosnilmot.com>
parents: 16056
diff changeset
46 /* change this only when we have a sane upgrade path for old prefs */
16427
4999bbc52881 Works for me! Renames prefs: /core to /purple, /gaim/gtk to /pidgin, /gaim/gnt to /finch
Sean Egan <seanegan@gmail.com>
parents: 16193
diff changeset
47 #define PIDGIN_PREFS_ROOT "/pidgin"
16062
07554cc5d090 Rename /purple/gtk preferences back to /gaim/gtk to allow for smooth upgrades
Stu Tomlinson <stu@nosnilmot.com>
parents: 16056
diff changeset
48
16954
816759ae9644 Clarify the comments on the names for translators.
Richard Laager <rlaager@wiktel.com>
parents: 16932
diff changeset
49 /* Translators may want to transliterate the name.
816759ae9644 Clarify the comments on the names for translators.
Richard Laager <rlaager@wiktel.com>
parents: 16932
diff changeset
50 It is not to be translated. */
16932
b668951121d8 Change the PIDGIN_NAME stuff to allow translators to transliterate the
Richard Laager <rlaager@wiktel.com>
parents: 16427
diff changeset
51 #define PIDGIN_NAME _("Pidgin")
b668951121d8 Change the PIDGIN_NAME stuff to allow translators to transliterate the
Richard Laager <rlaager@wiktel.com>
parents: 16427
diff changeset
52
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
53 #ifndef _WIN32
15821
cebfc6af3eb5 More Gaim to Pidgin stuff
Sean Egan <seanegan@gmail.com>
parents: 15632
diff changeset
54 # define PIDGIN_ALERT_TITLE ""
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
55 #else
15821
cebfc6af3eb5 More Gaim to Pidgin stuff
Sean Egan <seanegan@gmail.com>
parents: 15632
diff changeset
56 # define PIDGIN_ALERT_TITLE PIDGIN_NAME
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
57 #endif
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
58
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
59 /*
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
60 * This is backwards-compatibility code for older versions of GTK+ (< 2.4.x)
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
61 * It defines the new wrap behavior (unknown in earlier versions)
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
62 * as the old (slightly buggy) wrap behavior.
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
63 * It also includes our back-ported GtkExpander
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
64 */
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
65 /** @cond */
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
66 #if (!GTK_CHECK_VERSION(2,4,0))
15539
7ae72b7c02b1 sf patch #1640011, from Celso Pinto
Mark Doliner <mark@kingant.net>
parents: 15514
diff changeset
67 # define GTK_WRAP_WORD_CHAR GTK_WRAP_WORD
7ae72b7c02b1 sf patch #1640011, from Celso Pinto
Mark Doliner <mark@kingant.net>
parents: 15514
diff changeset
68 # include "gtkexpander.h"
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
69 #endif
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
70 /** @endcond */
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
71
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
72 /*
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
73 * We include the sources for GtkComboBox and GtkCellView because
15539
7ae72b7c02b1 sf patch #1640011, from Celso Pinto
Mark Doliner <mark@kingant.net>
parents: 15514
diff changeset
74 * they don't exist in older versions of GTK+, and we use them
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
75 * in a few places.
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
76 */
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
77 #if !GTK_CHECK_VERSION(2,6,0)
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
78 # include "gtkcellview.h"
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
79 # include "gtkcellviewmenuitem.h"
16052
605da11e8535 uvwarning noticed that this include was wrong
Daniel Atallah <daniel.atallah@gmail.com>
parents: 15871
diff changeset
80 # include "pidgincombobox.h"
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
81 # if !GTK_CHECK_VERSION(2,4,0)
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
82 # include "gtkcelllayout.h"
15539
7ae72b7c02b1 sf patch #1640011, from Celso Pinto
Mark Doliner <mark@kingant.net>
parents: 15514
diff changeset
83 # endif /* Less than GTK+ 2.4 */
7ae72b7c02b1 sf patch #1640011, from Celso Pinto
Mark Doliner <mark@kingant.net>
parents: 15514
diff changeset
84 #endif /* Less than GTK+ 2.6 */
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
85
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
86 /*
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
87 * Spacings between components, as defined by the
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
88 * GNOME Human Interface Guidelines.
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
89 */
15821
cebfc6af3eb5 More Gaim to Pidgin stuff
Sean Egan <seanegan@gmail.com>
parents: 15632
diff changeset
90 #define PIDGIN_HIG_CAT_SPACE 18
cebfc6af3eb5 More Gaim to Pidgin stuff
Sean Egan <seanegan@gmail.com>
parents: 15632
diff changeset
91 #define PIDGIN_HIG_BORDER 12
cebfc6af3eb5 More Gaim to Pidgin stuff
Sean Egan <seanegan@gmail.com>
parents: 15632
diff changeset
92 #define PIDGIN_HIG_BOX_SPACE 6
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
93
24989
cfb4e3dc7a23 pidgin.h is a public header file. Therefore, we should continue to provide
Richard Laager <rlaager@wiktel.com>
parents: 24988
diff changeset
94 #if !GTK_CHECK_VERSION(2,16,0) || !defined(PIDGIN_DISABLE_DEPRECATED)
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
95 /*
24988
087419df2cfe Two minor cleanups to the message about the invisible character in pidgin.h.
Richard Laager <rlaager@wiktel.com>
parents: 24987
diff changeset
96 * Older versions of GNOME defaulted to using an asterisk as the invisible
24987
17b840986607 GTK+ 2.16.0 will set the invisible character to a nice bullet instead of
Mark Doliner <mark@kingant.net>
parents: 20105
diff changeset
97 * character. But this is ugly and we want to use something nicer.
17b840986607 GTK+ 2.16.0 will set the invisible character to a nice bullet instead of
Mark Doliner <mark@kingant.net>
parents: 20105
diff changeset
98 *
24988
087419df2cfe Two minor cleanups to the message about the invisible character in pidgin.h.
Richard Laager <rlaager@wiktel.com>
parents: 24987
diff changeset
99 * The default invisible character was changed in GNOME revision 21446
24987
17b840986607 GTK+ 2.16.0 will set the invisible character to a nice bullet instead of
Mark Doliner <mark@kingant.net>
parents: 20105
diff changeset
100 * (GTK+ 2.16) from an asterisk to the first available character out of
17b840986607 GTK+ 2.16.0 will set the invisible character to a nice bullet instead of
Mark Doliner <mark@kingant.net>
parents: 20105
diff changeset
101 * 0x25cf, 0x2022, 0x2731, 0x273a. See GNOME bugs 83935 and 307304 for
17b840986607 GTK+ 2.16.0 will set the invisible character to a nice bullet instead of
Mark Doliner <mark@kingant.net>
parents: 20105
diff changeset
102 * discussion leading up to the change.
17b840986607 GTK+ 2.16.0 will set the invisible character to a nice bullet instead of
Mark Doliner <mark@kingant.net>
parents: 20105
diff changeset
103 *
17b840986607 GTK+ 2.16.0 will set the invisible character to a nice bullet instead of
Mark Doliner <mark@kingant.net>
parents: 20105
diff changeset
104 * Here's the change:
17b840986607 GTK+ 2.16.0 will set the invisible character to a nice bullet instead of
Mark Doliner <mark@kingant.net>
parents: 20105
diff changeset
105 * http://svn.gnome.org/viewvc/gtk%2B?view=revision&revision=21446
17b840986607 GTK+ 2.16.0 will set the invisible character to a nice bullet instead of
Mark Doliner <mark@kingant.net>
parents: 20105
diff changeset
106 *
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
107 */
24987
17b840986607 GTK+ 2.16.0 will set the invisible character to a nice bullet instead of
Mark Doliner <mark@kingant.net>
parents: 20105
diff changeset
108 #define PIDGIN_INVISIBLE_CHAR (gunichar)0x25cf
17b840986607 GTK+ 2.16.0 will set the invisible character to a nice bullet instead of
Mark Doliner <mark@kingant.net>
parents: 20105
diff changeset
109 #endif /* Less than GTK+ 2.16 */
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
110
15632
a830f9756f23 Some more pidgininfication
Daniel Atallah <daniel.atallah@gmail.com>
parents: 15539
diff changeset
111 #endif /* _PIDGIN_H_ */
15514
535f002e7b0f More pidgin changes
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
112