doc/blist-signals.dox

Tue, 06 Sep 2005 03:04:07 +0000

author
Richard Laager <rlaager@pidgin.im>
date
Tue, 06 Sep 2005 03:04:07 +0000
changeset 11454
a604c2097a6e
parent 9111
e5e3fca89af4
child 11935
1d95c7294577
permissions
-rw-r--r--

[gaim-migrate @ 13693]
This commit includes a number of changes:
1. Aliases are now used consistently in chats. If the prpl uses unique screen names for chats (e.g. Jabber), then aliases are not used at all.
2. The chat list is now colorized to match the colors used in the chat itself.
3. Buddies are bolded in the chat user list.
4. Buddies are sorted above non-buddies in the chat user list.
5. The chat user list is ellipsized when possible (i.e. on GTK+ 2.6.0 or above).
6. I've accepted patch #1178248, by Matt Amato to add "buddy-added" and "buddy-removed" signals. These were used in my implementation of #3 and #4, to update the GUI when users are added or removed from the buddy list.
7. I've added a "blist-node-aliased" signal that is emitted when a buddy, contact, or chat is aliased.
8. Since it was hard to separate and I need it at some point, I'm letting it slip in... I've changed GaimConversation.log to be a GList named logs. This way, we can have multiple logs for a single conversation. This will be necessary to implement unnamed chat logging in some reasonable fasion (see my notes in the TODO file).

/** @page blist-signals Buddy List Signals

 @signals
  @signal buddy-away
  @signal buddy-back
  @signal buddy-idle
  @signal buddy-unidle
  @signal buddy-signed-on
  @signal buddy-signed-off
  @signal update-idle
  @signal blist-node-extended-menu
  @signal buddy-added
  @signal buddy-removed
  @signal blist-node-aliased
 @endsignals

 <hr>

 @signaldef buddy-away
  @signalproto
void (*buddy_away)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list goes away.
  @param buddy The buddy that went away.
 @endsignaldef

 @signaldef buddy-back
  @signalproto
void (*buddy_back)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list comes back from being away.
  @param buddy The buddy that came back from being away.
 @endsignaldef

 @signaldef buddy-idle
  @signalproto
void (*buddy_idle)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list becomes idle.
  @param buddy The buddy that became idle.
 @endsignaldef

 @signaldef buddy-unidle
  @signalproto
void (*buddy_unidle)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list returns from being idle.
  @param buddy The buddy that returned from being idle.
 @endsignaldef

 @signaldef buddy-idle-updated
  @signalproto
void (*buddy_idle_updated)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy's idle time changes. The exceptions are when the
   buddy goes from being idle to being unidle, or from unidle to idle.
  @param buddy The buddy whose idle time changed.
 @endsignaldef

 @signaldef buddy-signed-on
  @signalproto
void (*buddy_signed_on)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list signs on.
  @param buddy The buddy that signed on.
 @endsignaldef

 @signaldef buddy-signed-off
  @signalproto
void (*buddy_signed_off)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list signs off.
  @param buddy The buddy that signed off.
 @endsignaldef

 @signaldef update-idle
  @signalproto
void (*update_idle)();
  @endsignalproto
  @signaldesc
   Emitted when the buddy list is refreshed and the idle times are updated.
 @endsignaldef

 @signaldef blist-node-extended-menu
  @signalproto
void (*blist_node_extended_menu)(GaimBlistNode *node, GList **menu)
  @endsignalproto
  @signaldesc
   Emitted when a buddlist menu is being constructed @a menu is a pointer to
   a GList of GaimBlistNodeAction's allowing a plugin to add menu items
 @endsignaldef

 @signaldef buddy-added
  @signalproto
void (*buddy_added)(GaimBuddy *buddy)
  @endsignalproto
  @signaldesc
   Emitted when a new buddy is added to the buddy list.
  @endsignaldef

 @signaldef buddy-removed
  @signalproto
void (*buddy_removed)(GaimBuddy *buddy)
  @endsignalproto
  @signaldesc
   Emitted when a buddy is removed from the buddy list.
  @endsignaldef

 @signaldef blist-node-aliased
  @signalproto
void (*blist_node_aliased)(GaimBlistNode *node, const char *old_alias)
  @endsignalproto
  @signaldesc
   Emitted when a blist node (buddy, chat, or contact) is aliased.
  @endsignaldef

 */
// vim: syntax=c tw=75 et

mercurial