diff src/event.h @ 5205:fefad67de2c7

[gaim-migrate @ 5573] I had a damn good commit message, but it was eaten. Let's try it again. Announcing, Gaim Plugin API version 2.0, or GPAPIV2.0 for short. There are lots'a cool thingies here. Okay now, this isn't as cool as the previous message, but: 1) There's now a single entry function for all plugin types. It returns a detailed information structure on the plugin. This removes a lot of the ugliness from old plugins. Oh yeah, libicq wasn't converted to this, so if you use it, well, you shouldn't have used it anyway, but now you can't! bwahahaha. Use AIM/ICQ. 2) There are now 3 types of plugins: Standard, Loader, and Protocol plugins. Standard plugins are, well, standard, compiled plugins. Loader plugins load other plugins. For example, the perl support is now a loader plugin. It loads perl scripts. In the future, we'll have Ruby and Python loader plugins. Protocol plugins are, well, protocol plugins... yeah... 3) Plugins have unique IDs, so they can be referred to or automatically updated from a plugin database in the future. Neat, huh? 4) Plugins will have dependency support in the future, and can be hidden, so if you have, say, a logging core plugin, it won't have to show up, but then you load the GTK+ logging plugin and it'll auto-load the core plugin. Core/UI split plugins! 5) There will eventually be custom plugin signals and RPC of some sort, for the core/ui split plugins. So, okay, back up .gaimrc. I'd like to thank my parents for their support, javabsp for helping convert a bunch of protocol plugins, and Etan for helping convert a bunch of standard plugins. Have fun. If you have any problems, please let me know, but you probably won't have anything major happen. You will have to convert your plugins, though, and I'm not guaranteeing that all perl scripts will still work. I'll end up changing the perl script API eventually, so I know they won't down the road. Don't worry, though. It'll be mass cool. faceprint wants me to just commit the damn code already. So, here we go!!! .. .. I need a massage. From a young, cute girl. Are there any young, cute girls in the audience? IM me plz k thx. committer: Tailor Script <[e-mail]>

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/event.h	Fri Apr 25 06:47:33 2003 +0000
@@ -0,0 +1,146 @@
+/**
+ * @file event.h Event API
+ * @ingroup core
+ *
+ * gaim
+ *
+ * Copyright (C) 2003 Christian Hammond <[e-mail]>
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+#ifndef _GAIM_EVENT_H_
+#define _GAIM_EVENT_H_
+
+#include <glib.h>
+
+/**
+ * Event types
+ */
+typedef enum gaim_event
+{
+	event_signon = 0,
+	event_signoff,
+	event_away,
+	event_back,
+	event_im_recv,
+	event_im_send,
+	event_buddy_signon,
+	event_buddy_signoff,
+	event_buddy_away,
+	event_buddy_back,
+	event_buddy_idle,
+	event_buddy_unidle,
+	event_blist_update,
+	event_chat_invited,
+	event_chat_join,
+	event_chat_leave,
+	event_chat_buddy_join,
+	event_chat_buddy_leave,
+	event_chat_recv,
+	event_chat_send,
+	event_warned,
+	event_error,
+	event_quit,
+	event_new_conversation,
+	event_set_info,
+	event_draw_menu,
+	event_im_displayed_sent,
+	event_im_displayed_rcvd,
+	event_chat_send_invite,
+	event_got_typing,
+	event_del_conversation,
+	event_connecting,
+	/* any others? it's easy to add... */
+
+} GaimEvent;
+
+typedef int (*GaimSignalBroadcastFunc)(GaimEvent event, void *data,
+									   va_list args);
+
+/**
+ * Connects a signal handler to a gaim event.
+ *
+ * @param module The optional module handle.
+ * @param event  The event to connect to.
+ * @param func   The callback function.
+ * @param data   The data to pass to the callback function.
+ *
+ * @see gaim_signal_disconnect()
+ */
+void gaim_signal_connect(void *module, GaimEvent event,
+						 void *func, void *data);
+
+/**
+ * Disconnects a signal handler from a gaim event.
+ *
+ * @param module The optional module handle.
+ * @param event  The event to disconnect from.
+ * @param func   The registered function to disconnect.
+ *
+ * @see gaim_signal_connect()
+ */
+void gaim_signal_disconnect(void *module, GaimEvent event,
+							void *func);
+
+/**
+ * Removes all callbacks associated with a handle.
+ *
+ * @param handle The handle.
+ */
+void gaim_signals_disconnect_by_handle(void *handle);
+
+/**
+ * Registers a function that re-broadcasts events.
+ *
+ * @param func The function.
+ * @param data Data to be passed to the callback.
+ */
+void gaim_signals_register_broadcast_func(GaimSignalBroadcastFunc func,
+										  void *data);
+
+/**
+ * Unregisters a function that re-broadcasts events.
+ *
+ * @param func The function.
+ */
+void gaim_signals_unregister_broadcast_func(GaimSignalBroadcastFunc func);
+
+/**
+ * Broadcasts an event to all registered signal handlers.
+ *
+ * @param event The event to broadcast
+ *
+ * @see gaim_signal_connect()
+ * @see gaim_signal_disconnect()
+ */
+int gaim_event_broadcast(GaimEvent event, ...);
+
+/**
+ * Returns a human-readable representation of an event name.
+ *
+ * @param event The event.
+ *
+ * @return A human-readable string of the name.
+ */
+const char *gaim_event_get_name(GaimEvent event);
+
+/**
+ * Returns a list of all signal callbacks.
+ *
+ * @return A list of all signal callbacks.
+ */
+GList *gaim_get_callbacks(void);
+
+#endif /* _GAIM_EVENT_H_ */