Mercurial > pidgin.yaz
annotate doc/gtkconv-signals.dox @ 16341:786edf5e2144
The core portion of the migration code. This is implemented as I described
in my e-mail a while back. If we have ~/.gaim and not ~/.purple (or we
have ~/.purple, but the "migrating" file exists, indicating an incomplete
previous migration), we copy all the files from ~/.gaim to ~/.purple and
move and symlink directories, except for plugins and icons. For icons,
we move and symlink any subdirectories, as a special case for the Album
plugin (written by me).
For this to work, it needs to be called by the UIs. Also, the icon
migration code is not included in this commit, so I highly recommend you
not test this on your main .gaim directory if you want a clean migration.
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Mon, 23 Apr 2007 16:57:12 +0000 |
parents | 8cf53d7a0887 |
children | 7971aadbf56c |
rev | line source |
---|---|
9001 | 1 /** @page gtkconv-signals GtkConv Signals |
2 | |
3 @signals | |
12053 | 4 @signal conversation-dragging |
12737
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
5 @signal conversation-timestamp |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
6 @signal displaying-im-msg |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
7 @signal displayed-im-msg |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
8 @signal displaying-chat-msg |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
9 @signal displayed-chat-msg |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
10 @signal conversation-switched |
9001 | 11 @endsignals |
12 | |
13 <hr> | |
14 | |
12053 | 15 @signaldef conversation-dragging |
9001 | 16 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
17 void (*conversation_dragging)(PidginWindow *source, PidginWindow *destination); |
9001 | 18 @endsignalproto |
19 @signaldesc | |
12053 | 20 Emitted when a conversation is being drag and dropped between windows. |
21 @param source The window where the conversation is. | |
22 @param destination The window where the conversation will be moved to. | |
9001 | 23 @endsignaldef |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
24 |
12737
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
25 @signaldef conversation-timestamp |
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
26 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
27 char *(*conversation_timestamp)(PurpleConversation *conv, time_t when); |
12737
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
28 @endsignalproto |
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
29 @signaldesc |
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
30 Emitted to allow plugins to customize the timestamp on a message. |
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
31 @param conv The conversation the message belongs to. |
13987
f94309c7c480
[gaim-migrate @ 16559]
Richard Laager <rlaager@wiktel.com>
parents:
13233
diff
changeset
|
32 @param when The time to be converted to a string. |
12737
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
33 @return A textual representation of the time, or @c NULL to use a |
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
34 default format. |
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
35 @endsignaldef |
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
36 |
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
37 |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
38 @signaldef displaying-im-msg |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
39 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
40 gboolean (*displaying_im_msg)(PurpleAccount *account, const char *who, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
41 char **message, PurpleConversation *conv, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
42 PurpleMessageFlags flags); |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
43 @endsignalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
44 @signaldesc |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
45 Emitted just before a message is displayed in an IM conversation. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
46 @a message is a pointer to a string, so the plugin can replace the |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
47 message that will be displayed. This can also be used to cancel displaying |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
48 a message by returning @c TRUE. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
49 @note |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
50 Make sure to free @a *message before you replace it! |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
51 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
52 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
53 @param message A pointer to the message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
54 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
55 @param flags Flags for this message. |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
56 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
57 @endsignaldef |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
58 |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
59 @signaldef displayed-im-msg |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
60 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
61 void (*displayed_im_msg)(PurpleAccount *account, const char *who, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
62 char *message, PurpleConversation *conv, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
63 PurpleMessageFlags flags); |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
64 @endsignalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
65 @signaldesc |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
66 Emitted after a message is displayed in an IM conversation. |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
67 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
68 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
69 @param message The message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
70 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
71 @param flags Flags for this message. |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
72 @endsignaldef |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
73 |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
74 @signaldef displaying-chat-msg |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
75 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
76 gboolean (*displaying_chat_msg)(PurpleAccount *account, const char *who, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
77 char **message, PurpleConversation *conv, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
78 PurpleMessageFlags flags); |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
79 @endsignalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
80 @signaldesc |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
81 Emitted just before a message is displayed in a chat. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
82 @a message is a pointer to a string, so the plugin can replace the |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
83 message that will be displayed. This can also be used to cancel displaying |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
84 a message by returning @c TRUE. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
85 @note |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
86 Make sure to free @a *message before you replace it! |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
87 @param account The account the message is being displayed and sent on. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
88 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
89 @param message A pointer to the message that will be displayed and sent. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
90 @param conv The conversation the message is being displayed and sent on. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
91 @param flags Flags for this message. |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
92 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
93 @endsignaldef |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
94 |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
95 @signaldef displayed-chat-msg |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
96 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
97 void (*displayed_chat_msg)(PurpleAccount *account, const char *who, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
98 char *message, PurpleConversation *conv, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
99 PurpleMessageFlags flags); |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
100 @endsignalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
101 @signaldesc |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
102 Emitted after a message is displayed in a chat conversation. |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
103 @param account The account the message is being displayed and sent on. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
104 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
105 @param message A pointer to the message that will be displayed and sent. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
106 @param conv The conversation the message is being displayed and sent on. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12737
diff
changeset
|
107 @param flags Flags for this message. |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
108 @endsignaldef |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
109 |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
110 @signaldef conversation-switched |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
111 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13987
diff
changeset
|
112 void (*conversation_switched)(PurpleConversation *conv); |
12639
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
113 @endsignalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
114 @signaldesc |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
115 Emitted when a window switched from one conversation to another. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
116 @param new_conv The now active conversation. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
117 @endsignaldef |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
118 |
9001 | 119 */ |
12291
5bc3d67ceb24
[gaim-migrate @ 14595]
Etan Reisner <pidgin@unreliablesource.net>
parents:
12053
diff
changeset
|
120 // vim: syntax=c tw=75 et |