Mercurial > pidgin
annotate src/dbus-server.h @ 12116:e75ef7aa913e
[gaim-migrate @ 14416]
" This patch implements a replacement for the queuing
system from 1.x. It also obsoletes a previous patch
[#1338873] I submitted to prioritize the unseen states
in gtk conversations.
The attached envelope.png is ripped from the
msgunread.png already included in gaim. It should be
dropped in the pixmaps directory (Makefile.am is
updated accordingly in this patch).
The two separate queuing preferences from 1.x, queuing
messages while away and queuing all new messages (from
docklet), are replaced with a single 3-way preference
for conversations. The new preference is "Hide new IM
conversations". This preference can be set to never,
away and always.
When a gtk conversation is created, it may be placed in
a hidden conversation window instead of being placed
normally. This decision is based upon the preference
and possibly the away state of the account the
conversation is being created for. This *will* effect
conversations the user explicitly requests to be
created, so in these cases the caller must be sure to
present the conversation to the user, using
gaim_gtkconv_present_conversation(). This is done
already in gtkdialogs.c which handles creating
conversations requested by the user from gaim proper
(menus, double-clicking on budy in blist, etc.).
The main advantage to not queuing messages is that the
conversations exist, the message is written to the
conversation (and logged if appropriate) and the unseen
state is set on the conversation. This means no
additional features are needed to track whether there
are queued messages or not, just use the unseen state
on conversations.
Since conversations may not be visible (messages
"queued"), gaim proper needs some notification that
there are messages waiting. I opted for a menutray icon
that shows up when an im conversation has an unseen
message. Clicking this icon will focus (and show if
hidden) the first conversation with an unseen message.
This is essentially the same behavior of the docklet in
cvs right now, except that the icon is only visible
when there is a conversation with an unread message.
The api that is added is flexible enough to allow
either the docklet or the new blist menutray icon to be
visible for conversations of any/all types and for
unseen messages >= any state. Currently they are set to
only IM conversations and only unseen states >= TEXT
(system messages and no log messages will not trigger
blinking the docklet or showing the blist tray icon),
but these could be made preferences relatively easily
in the future. Other plugins could probably benefit as
well: gaim_gtk_conversations_get_first_unseen().
There is probably some limit to comment size, so I'll
stop rambling now. If anyone has more
questions/comments, catch me in #gaim, here or on
gaim-devel."
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Wed, 16 Nov 2005 18:17:01 +0000 |
parents | c9312177821a |
children | 2078f65a8e98 |
rev | line source |
---|---|
11055 | 1 /** |
2 * @file dbus-server.h Gaim DBUS Server | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
7 * Gaim is the legal property of its developers, whose names are too numerous | |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
10 * | |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 * | |
25 */ | |
26 | |
27 #ifndef _GAIM_DBUS_SERVER_H_ | |
28 #define _GAIM_DBUS_SERVER_H_ | |
29 | |
11080 | 30 #include "value.h" |
11067 | 31 |
11171 | 32 |
11055 | 33 G_BEGIN_DECLS |
34 | |
11171 | 35 /** |
36 Types of pointers are identified by the ADDRESS of a GaimDbusType | |
37 object. This way, plugins can easily access types defined in gaim | |
38 proper as well as introduce their own types that will not conflict | |
39 with those introduced by other plugins. | |
40 | |
11501
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
41 The structure GaimDbusType has only one element (GaimDBusType::parent), a |
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
42 contains a pointer to the parent type, or @c NULL if the type has no |
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
43 parent. Parent means the same as the base class in object oriented |
11171 | 44 programming. |
11501
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
45 */ |
11171 | 46 |
47 typedef struct _GaimDBusType GaimDBusType; | |
48 | |
49 struct _GaimDBusType { | |
50 GaimDBusType *parent; | |
51 }; | |
11067 | 52 |
11171 | 53 /* By convesion, the GaimDBusType variable representing each structure |
54 GaimSomeStructure has the name GAIM_DBUS_TYPE_GaimSomeStructure. | |
55 The following macros facilitate defining such variables | |
11067 | 56 |
11171 | 57 #GAIM_DBUS_DECLARE_TYPE declares an extern variable representing a |
58 given type, for use in header files. | |
59 | |
60 #GAIM_DBUS_DEFINE_TYPE defines a variable representing a given | |
61 type, use in .c files. It defines a new type without a parent; for | |
62 types with a parent use #GAIM_DBUS_DEFINE_INHERITING_TYPE. | |
63 */ | |
11080 | 64 |
11171 | 65 #define GAIM_DBUS_TYPE(type) (&GAIM_DBUS_TYPE_##type) |
66 | |
67 | |
68 #define GAIM_DBUS_DECLARE_TYPE(type) \ | |
69 extern GaimDBusType GAIM_DBUS_TYPE_##type; | |
11067 | 70 |
11171 | 71 #define GAIM_DBUS_DEFINE_TYPE(type) \ |
72 GaimDBusType GAIM_DBUS_TYPE_##type = { NULL }; | |
11080 | 73 |
11171 | 74 #define GAIM_DBUS_DEFINE_INHERITING_TYPE(type, parent) \ |
75 GaimDBusType GAIM_DBUS_TYPE_##type = { GAIM_DBUS_TYPE(parent) }; | |
76 | |
11055 | 77 |
11067 | 78 /** |
79 Initializes gaim dbus pointer registration engine. | |
80 | |
81 Remote dbus applications need a way of addressing objects exposed | |
82 by gaim to the outside world. In gaim itself, these objects (such | |
83 as GaimBuddy and company) are identified by pointers. The gaim | |
84 dbus pointer registration engine converts pointers to handles and | |
85 back. | |
86 | |
87 In order for an object to participate in the scheme, it must | |
88 register itself and its type with the engine. This registration | |
89 allocates an integer id which can be resolved to the pointer and | |
90 back. | |
91 | |
92 Handles are not persistent. They are reissued every time gaim is | |
93 started. This is not good; external applications that use gaim | |
94 should work even whether gaim was restarted in the middle of the | |
95 interaction. | |
96 | |
97 Pointer registration is only a temporary solution. When GaimBuddy | |
98 and similar structures have been converted into gobjects, this | |
99 registration will be done automatically by objects themselves. | |
100 | |
101 By the way, this kind of object-handle translation should be so | |
102 common that there must be a library (maybe even glib) that | |
103 implements it. I feel a bit like reinventing the wheel here. | |
104 */ | |
105 void gaim_dbus_init_ids(void); | |
106 | |
107 /** | |
108 Registers a typed pointer. | |
109 | |
11129 | 110 @param node The pointer to register. |
111 @param type Type of that pointer. | |
11067 | 112 */ |
11171 | 113 void gaim_dbus_register_pointer(gpointer node, GaimDBusType *type); |
11067 | 114 |
115 /** | |
116 Unregisters a pointer previously registered with | |
117 gaim_dbus_register_pointer. | |
118 | |
11129 | 119 @param node The pointer to register. |
11067 | 120 */ |
121 void gaim_dbus_unregister_pointer(gpointer node); | |
122 | |
11080 | 123 |
124 | |
125 /** | |
126 Emits a dbus signal. | |
127 | |
11171 | 128 @param name The name of the signal ("bla-bla-blaa") |
11080 | 129 @param num_values The number of parameters. |
130 @param values Array of pointers to #GaimValue objects representing | |
131 the types of the parameters. | |
132 @param vargs A va_list containing the actual parameters. | |
11171 | 133 */ |
11903 | 134 void gaim_dbus_signal_emit_gaim(const char *name, int num_values, |
11171 | 135 GaimValue **values, va_list vargs); |
11080 | 136 |
11171 | 137 /** |
138 * Starts the gaim DBUS server. It is responsible for handling DBUS | |
139 * requests from other applications. | |
140 * | |
141 * @return TRUE if successful, FALSE otherwise. | |
142 */ | |
143 gboolean gaim_dbus_init(void); | |
144 | |
11080 | 145 |
146 | |
11171 | 147 /** |
148 | |
149 Macro #DBUS_EXPORT expands to nothing. It is used to indicate to the | |
11501
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
150 dbus-analize-functions.py script that the given function should be |
11171 | 151 available to other applications through DBUS. If |
11501
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
152 dbus-analize-functions.py is run without the "--export-only" option, |
11171 | 153 this prefix is ignored. |
154 | |
155 */ | |
156 | |
157 #define DBUS_EXPORT | |
158 | |
159 /* | |
160 Here we include the list of #GAIM_DBUS_DECLARE_TYPE statements for | |
161 all structs defined in gaim. This file has been generated by the | |
162 #dbus-analize-types.py script. | |
163 */ | |
164 | |
165 #include "dbus-types.h" | |
11067 | 166 |
11055 | 167 G_END_DECLS |
168 | |
169 #endif /* _GAIM_DBUS_SERVER_H_ */ |