doc/gtkconv-signals.dox

   1 /** @page gtkconv-signals GtkConv Signals
   2
   3  @signals
   4   @signal conversation-dragging
   5   @signal conversation-timestamp
   6   @signal displaying-im-msg
   7   @signal displayed-im-msg
   8   @signal displaying-chat-msg
   9   @signal displayed-chat-msg
  10   @signal conversation-switched
  11   @signal conversation-hiding
  12   @signal conversation-displayed
  13  @endsignals
  14
  15  @see gtkconv.h
  16
  17  <hr>
  18
  19  @signaldef conversation-dragging
  20   @signalproto
  21 void (*conversation_dragging)(PidginWindow *source, PidginWindow *destination);
  22   @endsignalproto
  23   @signaldesc
  24    Emitted when a conversation is being drag and dropped between windows.
  25   @param source The window where the conversation is.
  26   @param destination The window where the conversation will be moved to.
  27  @endsignaldef
  28
  29  @signaldef conversation-timestamp
  30   @signalproto
  31 char *(*conversation_timestamp)(PurpleConversation *conv, time_t when,
  32                                 gboolean show_date);
  33   @endsignalproto
  34   @signaldesc
  35    Emitted to allow plugins to customize the timestamp on a message.
  36   @param conv      The conversation the message belongs to.
  37   @param when      The time to be converted to a string.
  38   @param show_date Whether the date should be displayed.
  39   @return A textual representation of the time, or @c NULL to use a
  40           default format.
  41  @endsignaldef
  42
  43
  44  @signaldef displaying-im-msg
  45   @signalproto
  46 gboolean (*displaying_im_msg)(PurpleAccount *account, const char *who,
  47                               char **message, PurpleConversation *conv,
  48                               PurpleMessageFlags flags);
  49   @endsignalproto
  50   @signaldesc
  51    Emitted just before a message is displayed in an IM conversation.
  52    @a message is a pointer to a string, so the plugin can replace the
  53    message that will be displayed. This can also be used to cancel displaying
  54    a message by returning @c TRUE.
  55   @note
  56    Make sure to free @a *message before you replace it!
  57   @param account The account.
  58   @param who     The name of the user.
  59   @param message A pointer to the message.
  60   @param conv    The conversation.
  61   @param flags   Flags for this message.
  62   @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
  63  @endsignaldef
  64
  65  @signaldef displayed-im-msg
  66   @signalproto
  67 void (*displayed_im_msg)(PurpleAccount *account, const char *who,
  68                          char *message, PurpleConversation *conv,
  69                          PurpleMessageFlags flags);
  70   @endsignalproto
  71   @signaldesc
  72    Emitted after a message is displayed in an IM conversation.
  73   @param account The account.
  74   @param who     The name of the user.
  75   @param message The message.
  76   @param conv    The conversation.
  77   @param flags   Flags for this message.
  78  @endsignaldef
  79
  80  @signaldef displaying-chat-msg
  81   @signalproto
  82 gboolean (*displaying_chat_msg)(PurpleAccount *account, const char *who,
  83                                 char **message, PurpleConversation *conv,
  84                                 PurpleMessageFlags flags);
  85   @endsignalproto
  86   @signaldesc
  87    Emitted just before a message is displayed in a chat.
  88    @a message is a pointer to a string, so the plugin can replace the
  89    message that will be displayed. This can also be used to cancel displaying
  90    a message by returning @c TRUE.
  91   @note
  92    Make sure to free @a *message before you replace it!
  93   @param account The account the message is being displayed and sent on.
  94   @param who     The name of the user.
  95   @param message A pointer to the message that will be displayed and sent.
  96   @param conv    The conversation the message is being displayed and sent on.
  97   @param flags   Flags for this message.
  98   @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
  99  @endsignaldef
 100
 101  @signaldef displayed-chat-msg
 102   @signalproto
 103 void (*displayed_chat_msg)(PurpleAccount *account, const char *who,
 104                            char *message, PurpleConversation *conv,
 105                            PurpleMessageFlags flags);
 106   @endsignalproto
 107   @signaldesc
 108    Emitted after a message is displayed in a chat conversation.
 109   @param account The account the message is being displayed and sent on.
 110   @param who     The name of the user.
 111   @param message A pointer to the message that will be displayed and sent.
 112   @param conv    The conversation the message is being displayed and sent on.
 113   @param flags   Flags for this message.
 114  @endsignaldef
 115
 116  @signaldef conversation-switched
 117   @signalproto
 118 void (*conversation_switched)(PurpleConversation *conv);
 119   @endsignalproto
 120   @signaldesc
 121    Emitted when a window switched from one conversation to another.
 122   @param new_conv The now active conversation.
 123  @endsignaldef
 124
 125  @signaldef conversation-hiding
 126   @signalproto
 127 void (*conversation_hiding)(PidginConversation *gtkconv);
 128   @endsignalproto
 129   @signaldesc
 130    Emitted immediately before an existing conversation is hidden.
 131   @param gtkconv  The PidginConversation
 132   @since 2.2.0
 133  @endsignaldef
 134
 135  @signaldef conversation-displayed
 136   @signalproto
 137 void (*conversation_displayed)(PidginConversation *gtkconv);
 138   @endsignalproto
 139   @signaldesc
 140    Emitted right after the Pidgin UI is attached to a new or a hidden conversation.
 141   @param gtkconv  The PidginConversation
 142   @since 2.2.0
 143  @endsignaldef
 144
 145 */
 146 // vim: syntax=c.doxygen tw=75 et