view doc/gtkblist-signals.dox @ 11211:03a244acce57

[gaim-migrate @ 13342] (14:28:27) Christopher O'Brien (siege): ArdentlyGnarly, gaim_proxy_connect's docs lie (14:28:36) Christopher O'Brien (siege): it doesn't return a fd (14:28:52) Christopher O'Brien (siege): it returns a status code ... (14:37:58) rlaager: siege, ArdentlyGnarly: We should correct the docs for gaim_proxy_connect... how does this sound? "@return zero for success, any other value for failure" ... (14:39:22) Jonathan Clark (ArdentlyGnarly): we really don't know whether or not the call was successful at the time it returns (14:39:55) Jonathan Clark (ArdentlyGnarly): we get that information when things get back around to the callback passed to gaim_proxy_connect (14:42:08) Jonathan Clark (ArdentlyGnarly): perhaps: @return zero indicates connection is pending, any other value for failure committer: Tailor Script <[e-mail]>

/** @page gtkblist-signals GtkBlist Signals

 @signals
  @signal gtkblist-created
  @signal drawing-tooltip
 @endsignals

 <hr>

 @signaldef gtkblist-created
  @signalproto
void (*gtkblist-created)(GaimBuddyList *blist);
  @endsignalproto
  @signaldesc
   Emitted when the buddy list is created.
  @param blist The buddy list.
 @endsignaldef

 @signaldef drawing-tooltip
  @signalproto
void (*drawing-tooltip)(GaimBlistNode *node, GString *text);
  @endsignalproto
  @signaldesc
   Emitted just before a tooltip is displayed.
   @a text is a standard GString, so the plugin can modify the text that
   will be displayed.
  @note
   Make sure to free @a *text before you replace it!
  @param node The blist node for the tooltip.
  @param text A pointer to the text that will be displayed.
 @endsignaldef
*/