Mercurial > pidgin
annotate doc/gtkconv-signals.dox @ 12737:a1e241dd50b6
[gaim-migrate @ 15082]
Conversation and Logging Message Timestamp Formatting...
The idea here is that we should honor the user's locale for message timestamps in the conversation window and in the logs.
I've added a signal and created a plugin that allows one to override this. The plugin is named "Message Timestamp Formats". Enabling that will by default change the timestamps back to the format we had before this commit. (That is to say, it forces the old format and ignores the locale.) The plugin also has options to show dates in the timestamps "Always", "In Chats", or "For Delayed Messages" (the default behavior).
This addresses all requests for 12 hour timestamps, allows people to continue with the 24 hour timestamps we have, even if their locale says differently, enables plugin authors to override the message timestamp formats in any way they choose, and addresses requests for complete dates in logs.
To recap, if you don't like the format string your locale has, enabled the "Message Timestamp Formats" plugin.
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Thu, 05 Jan 2006 20:17:36 +0000 |
parents | 366326fa9cb4 |
children | f09c6e8df82c |
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 |
12053 | 17 void (*conversation_dragging)(GaimGtkWindow *source, GaimGtkWindow *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 |
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
27 char *(*conversation_timestamp)(GaimConversation *conv, struct tm *tm); |
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. |
a1e241dd50b6
[gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
32 @param tm The time to be converted to a string. |
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 |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
40 gboolean (*displaying_im_msg)(GaimAccount *account, GaimConversation *conv, |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
41 char **message, GaimMessageFlags flags); |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
42 @endsignalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
43 @signaldesc |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
44 Emitted just before a message is displayed in an IM conversation. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
45 @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
|
46 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
|
47 a message by returning @c TRUE. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
48 @note |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
49 Make sure to free @a *message before you replace it! |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
50 @param account The account the message is being displayed on. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
51 @param conv The conversation the message is being displayed on. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
52 @param message A pointer to the message that will be displayed. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
53 @param flags The message flags. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
54 @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
|
55 @endsignaldef |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
56 |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
57 @signaldef displayed-im-msg |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
58 @signalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
59 void (*displayed_im_msg)(GaimAccount *account, GaimConversation *conv, |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
60 const char *message, GaimMessageFlags flags); |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
61 @endsignalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
62 @signaldesc |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
63 Emitted after a message is displayed in an IM conversation. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
64 @param account The account the message was displayed on. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
65 @param conv The conversation the message was displayed on. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
66 @param message The message that was displayed. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
67 @param flags The message flags. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
68 @endsignaldef |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
69 |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
70 @signaldef displaying-chat-msg |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
71 @signalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
72 gboolean (*displaying_chat_msg)(GaimAccount *account, GaimConversation *conv, |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
73 char **message, GaimMessageFlags flags); |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
74 @endsignalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
75 @signaldesc |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
76 Emitted just before a message is displayed in a chat. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
77 @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
|
78 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
|
79 a message by returning @c TRUE. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
80 @note |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
81 Make sure to free @a *message before you replace it! |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
82 @param account The account the message is being displayed on. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
83 @param conv The conversation the message is being displayed on. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
84 @param message A pointer to the message that will be displayed. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
85 @param flags The message flags. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
86 @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
|
87 @endsignaldef |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
88 |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
89 @signaldef displayed-chat-msg |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
90 @signalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
91 void (*displayed_chat_msg)(GaimAccount *account, GaimConversation *conv, |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
92 const char *message, GaimMessageFlags flags); |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
93 @endsignalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
94 @signaldesc |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
95 Emitted after a message is displayed in a chat conversation. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
96 @param account The account the message was displayed on. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
97 @param conv The conversation the message was displayed on. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
98 @param message The message that was displayed. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
99 @param flags The message flags. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
100 @endsignaldef |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
101 |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
102 @signaldef conversation-switched |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
103 @signalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
104 void (*conversation_switched)(GaimConversation *conv); |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
105 @endsignalproto |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
106 @signaldesc |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
107 Emitted when a window switched from one conversation to another. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
108 @param new_conv The now active conversation. |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
109 @endsignaldef |
366326fa9cb4
[gaim-migrate @ 14975]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
110 |
9001 | 111 */ |
12291
5bc3d67ceb24
[gaim-migrate @ 14595]
Etan Reisner <pidgin@unreliablesource.net>
parents:
12053
diff
changeset
|
112 // vim: syntax=c tw=75 et |