changeset 12053:1ec93dd2f359

[gaim-migrate @ 14348] doxygen and ChangeLog.API updates from Casey Harkins committer: Tailor Script <tailor@pidgin.im>
author Nathan Walp <nwalp@pidgin.im>
date Sat, 12 Nov 2005 16:49:10 +0000
parents d676eec43d13
children 2cb1beb9da51
files doc/Makefile.am doc/account-signals.dox doc/cipher-signals.dox doc/conversation-signals.dox doc/core-signals.dox doc/dbus-server-signals.dox doc/gtkconv-signals.dox doc/plugin-signals.dox plugins/ChangeLog.API src/blist.h
diffstat 10 files changed, 161 insertions(+), 54 deletions(-) [+]
line wrap: on
line diff
--- a/doc/Makefile.am	Sat Nov 12 16:49:03 2005 +0000
+++ b/doc/Makefile.am	Sat Nov 12 16:49:10 2005 +0000
@@ -9,8 +9,12 @@
 	account-signals.dox \
 	blist-signals.dox \
 	buddyicon-signals.dox \
+	cipher-signals.dox \
 	connection-signals.dox \
 	conversation-signals.dox \
+	core-signals.dox \
+	dbus-server-signals.dox \
+	file-transfer-signals.dox \
 	gaim.1.in \
 	gaims_funniest_home_convos.txt \
 	gtkaccount-signals.dox \
@@ -18,5 +22,6 @@
 	gtkconv-signals.dox \
 	gtkimhtml-signals.dox \
 	plugin-ids.dox \
+	plugin-signals.dox \
 	the_penguin.txt \
 	xfer-signals.dox
--- a/doc/account-signals.dox	Sat Nov 12 16:49:03 2005 +0000
+++ b/doc/account-signals.dox	Sat Nov 12 16:49:10 2005 +0000
@@ -1,7 +1,9 @@
 /** @page account-signals Account Signals
 
  @signals
+  @signal account-added
   @signal account-connecting
+  @signal account-removed
   @signal account-setting-info
   @signal account-set-info
   @signal account-status-changed
@@ -9,6 +11,15 @@
 
  <hr>
 
+ @signaldef account-added
+  @signalproto
+void (*account_added)(GaimAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when an account is added.
+  @param account The account that was added.
+ @endsignaldef
+
  @signaldef account-connecting
   @signalproto
 void (*account_connecting)(GaimAccount *account);
@@ -18,6 +29,15 @@
   @param account The account in the process of connecting.
  @endsignaldef
 
+ @signaldef account-removed
+  @signalproto
+void (*account_removed)(GaimAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when an account is removed.
+  @param account The account that was removed.
+ @endsignaldef
+
  @signaldef account-setting-info
   @signalproto
 void (*account_setting_info)(GaimAccount *account, const char *new_info);
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/cipher-signals.dox	Sat Nov 12 16:49:10 2005 +0000
@@ -0,0 +1,29 @@
+/** @page cipher-signals Cipher Signals
+
+ @signals
+  @signal cipher-added
+  @signal cipher-removed
+ @endsignals
+
+ <hr>
+
+ @signaldef cipher-added
+  @signalproto
+void (*cipher_added)(GaimCipher *cipher);
+  @endsignalproto
+  @signaldesc
+   Emitted when a cipher is added.
+  @param cipher The cipher that was added.
+ @endsignaldef
+
+ @signaldef cipher-removed
+  @signalproto
+void (*cipher_removed)(GaimCipher *cipher);
+  @endsignalproto
+  @signaldesc
+   Emitted when a cipher is removed.
+  @param cipher The cipher that was removed.
+ @endsignaldef
+
+ */
+// vim: syntax=c tw=75 et
--- a/doc/conversation-signals.dox	Sat Nov 12 16:49:03 2005 +0000
+++ b/doc/conversation-signals.dox	Sat Nov 12 16:49:10 2005 +0000
@@ -20,11 +20,13 @@
   @signal conversation-switching
   @signal conversation-switched
   @signal conversation-created
+  @signal conversation-updated
   @signal deleting-conversation
   @signal buddy-typing
   @signal buddy-typing-stopped
   @signal chat-buddy-joining
   @signal chat-buddy-joined
+  @signal chat-buddy-flags
   @signal chat-buddy-leaving
   @signal chat-buddy-left
   @signal chat-inviting-user
@@ -306,6 +308,17 @@
   @param conv The new conversation.
  @endsignaldef
 
+ @signaldef conversation-updated
+  @signalproto
+void (*conversation_updated)(GaimConversation *conv, 
+                             GaimConvUpdateType type);
+  @endsignalproto
+  @signaldesc
+   Emitted when a conversation is updated.
+  @param conv The conversation that was updated.
+  @param type The type of update that was made.
+ @endsignaldef
+
  @signaldef deleting-conversation
   @signalproto
 void (*deleting_conversation)(GaimConversation *conv);
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/core-signals.dox	Sat Nov 12 16:49:10 2005 +0000
@@ -0,0 +1,18 @@
+/** @page core-signals Core Signals
+
+ @signals
+  @signal quitting
+ @endsignals
+
+ <hr>
+
+ @signaldef quitting
+  @signalproto
+void (*quitting)();
+  @endsignalproto
+  @signaldesc
+   Emitted when gaim is quitting.
+ @endsignaldef
+
+ */
+// vim: syntax=c tw=75 et
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/dbus-server-signals.dox	Sat Nov 12 16:49:10 2005 +0000
@@ -0,0 +1,32 @@
+/** @page dbus-server-signals DBus Server Signals
+
+ @signals
+  @signal dbus-method-called
+  @signal dbus-introspect
+ @endsignals
+
+ <hr>
+
+ @signaldef dbus-method-called
+  @signalproto
+gboolean (*dbus_method_called)(DBusConnection *connection,
+                               DBusMessage *message);
+  @endsignalproto
+  @signaldesc
+   Emitted when a dbus method is going to be called.
+  @param connection The DBus connection.
+  @param message The DBus message.
+  @return TRUE if signal handler handled the method. ???
+ @endsignaldef
+
+ @signaldef dbus-introspect
+  @signalproto
+void (*dbus_introspect)(GList **bidings_list);
+  @endsignalproto
+  @signaldesc
+   ???
+  @param bindings_list ???
+ @endsignaldef
+
+ */
+// vim: syntax=c tw=75 et
--- a/doc/gtkconv-signals.dox	Sat Nov 12 16:49:03 2005 +0000
+++ b/doc/gtkconv-signals.dox	Sat Nov 12 16:49:10 2005 +0000
@@ -1,18 +1,18 @@
 /** @page gtkconv-signals GtkConv Signals
 
  @signals
-  @signal conversation-drag-ended
+  @signal conversation-dragging
  @endsignals
 
  <hr>
 
- @signaldef conversation-drag-ended
+ @signaldef conversation-dragging
   @signalproto
-void (*conversation-drag-ended)(GaimConvWindow *source, GaimConvWindow *destination);
+void (*conversation_dragging)(GaimGtkWindow *source, GaimGtkWindow *destination);
   @endsignalproto
   @signaldesc
-   Emitted when a conversation drag and drop has finished.
-  @param source The conversation that has been moved.
-  @param destination Where the conversation is now.
+   Emitted when a conversation is being drag and dropped between windows.
+  @param source The window where the conversation is.
+  @param destination The window where the conversation will be moved to.
  @endsignaldef
 */
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/plugin-signals.dox	Sat Nov 12 16:49:10 2005 +0000
@@ -0,0 +1,29 @@
+/** @page plugin-signals Plugin Signals
+
+ @signals
+  @signal plugin-load
+  @signal plugin-unload
+ @endsignals
+
+ <hr>
+
+ @signaldef plugin-load
+  @signalproto
+void (*plugin_load)(GaimPlugin *plugin);
+  @endsignalproto
+  @signaldesc
+   Emitted when a plugin is loaded.
+  @param plugin The plugin that was loaded.
+ @endsignaldef
+
+ @signaldef plugin-unload
+  @signalproto
+void (*plugin_unload)(GaimPlugin *plugin);
+  @endsignalproto
+  @signaldesc
+   Emitted when a plugin is unloaded.
+  @param plugin The plugin that was unloaded.
+ @endsignaldef
+
+ */
+// vim: syntax=c tw=75 et
--- a/plugins/ChangeLog.API	Sat Nov 12 16:49:03 2005 +0000
+++ b/plugins/ChangeLog.API	Sat Nov 12 16:49:10 2005 +0000
@@ -166,6 +166,12 @@
 		the user is on the buddy list.
 
 	Signals - Added:
+	* "account-status-changed": Account status changed; see Doxygen docs for full details.
+	* "cipher-added": Cipher was added; see Doxygen docs for full details.
+	* "cipher-removed": Cipher was removed; see Doxygen docs for full details.
+	* "dbus-method-called": See Doxygen docs for full details.
+	* "dbus-introspect": See Doxygen docs for full details.
+	* "cipher-removed": Cipher was removed; see Doxygen docs for full details.
 	* "file-recv-accept": See Doxygen docs for details.
 	* "file-recv-start": See Doxygen docs for details.
 	* "file-recv-cancel": See Doxygen docs for details.
@@ -180,10 +186,13 @@
 	* "buddy-status-changed": A buddy changed status; see Doxygen docs for full details.
 	* "buddy-idle-changed": A buddy's idle status changed; see Doxygen docs for full details.
 		See Doxygen docs for details.
+	* "buddy-icon-cached": A buddy icon was cached; see Doxygen docs for full details.
 	* "gtkblist-hiding": See Doxygen docs for details.
 	* "gtkblist-unhiding": See Doxygen docs for details.
 
 	Signals - Removed:
+	* "account-away": replaced by account-status-changed
+	* "account-warned": ???
 	* "buddy-away": replaced by buddy-status-changed
 	* "buddy-back": replaced by buddy-status-changed
 	* "buddy-idle": replaced by buddy-idle-changed
--- a/src/blist.h	Sat Nov 12 16:49:03 2005 +0000
+++ b/src/blist.h	Sat Nov 12 16:49:10 2005 +0000
@@ -151,37 +151,10 @@
 struct _GaimBuddyList {
 	GaimBlistNode *root;          /**< The first node in the buddy list */
 	GHashTable *buddies;          /**< Every buddy in this list */
-	GaimBlistUiOps *ui_ops;       /**< The UI operations for the buddy list */
 
 	void *ui_data;                /**< UI-specific data. */
 };
 
-/**
- * Buddy list UI operations.
- *
- * Any UI representing a buddy list must assign a filled-out GaimBlistUiOps
- * structure to the buddy list core.
- */
-struct _GaimBlistUiOps
-{
-	void (*new_list)(GaimBuddyList *list); /**< Sets UI-specific data on a buddy list. */
-	void (*new_node)(GaimBlistNode *node); /**< Sets UI-specific data on a node. */
-	void (*show)(GaimBuddyList *list);     /**< The core will call this when it's finished doing its core stuff */
-	void (*update)(GaimBuddyList *list,
-		       GaimBlistNode *node);       /**< This will update a node in the buddy list. */
-	void (*remove)(GaimBuddyList *list,
-		       GaimBlistNode *node);       /**< This removes a node from the list */
-	void (*destroy)(GaimBuddyList *list);  /**< When the list gets destroyed, this gets called to destroy the UI. */
-	void (*set_visible)(GaimBuddyList *list,
-			    gboolean show);            /**< Hides or unhides the buddy list */
-	void (*request_add_buddy)(GaimAccount *account, const char *username,
-							  const char *group, const char *alias);
-	void (*request_add_chat)(GaimAccount *account, GaimGroup *group,
-							 const char *alias, const char *name);
-	void (*request_add_group)(void);
-};
-
-
 struct _GaimBlistNodeAction {
 	char *label;
 	void (*callback)(GaimBlistNode *, gpointer);
@@ -854,27 +827,6 @@
 
 
 /**************************************************************************/
-/** @name UI Registration Functions                                       */
-/**************************************************************************/
-/*@{*/
-
-/**
- * Sets the UI operations structure to be used for the buddy list.
- *
- * @param ops The ops struct.
- */
-void gaim_blist_set_ui_ops(GaimBlistUiOps *ops);
-
-/**
- * Returns the UI operations structure to be used for the buddy list.
- *
- * @return The UI operations structure.
- */
-GaimBlistUiOps *gaim_blist_get_ui_ops(void);
-
-/*@}*/
-
-/**************************************************************************/
 /** @name Buddy List Subsystem                                            */
 /**************************************************************************/
 /*@{*/