GNOME.org
 

gedit r6733 - in branches/message_system: docs/reference docs/reference/tmpl gedit

Author: jessevdk
Date: Sat Dec 27 17:33:03 2008
New Revision: 6733
URL: http://svn.gnome.org/viewvc/gedit?rev=6733&view=rev

Log:
Removed Private structs from doc sections
Added description and examples for GeditMessageBus


Modified:
   branches/message_system/docs/reference/gedit-sections.txt
   branches/message_system/docs/reference/tmpl/gedit-app.sgml
   branches/message_system/docs/reference/tmpl/gedit-document.sgml
   branches/message_system/docs/reference/tmpl/gedit-encodings-option-menu.sgml
   branches/message_system/docs/reference/tmpl/gedit-file-chooser-dialog.sgml
   branches/message_system/docs/reference/tmpl/gedit-message-area.sgml
   branches/message_system/docs/reference/tmpl/gedit-message-type.sgml
   branches/message_system/docs/reference/tmpl/gedit-notebook.sgml
   branches/message_system/docs/reference/tmpl/gedit-panel.sgml
   branches/message_system/docs/reference/tmpl/gedit-progress-message-area.sgml
   branches/message_system/docs/reference/tmpl/gedit-statusbar.sgml
   branches/message_system/docs/reference/tmpl/gedit-tab.sgml
   branches/message_system/docs/reference/tmpl/gedit-unused.sgml
   branches/message_system/docs/reference/tmpl/gedit-view.sgml
   branches/message_system/docs/reference/tmpl/gedit-window.sgml
   branches/message_system/gedit/gedit-message-bus.c

Modified: branches/message_system/docs/reference/gedit-sections.txt
==============================================================================
--- branches/message_system/docs/reference/gedit-sections.txt	(original)
+++ branches/message_system/docs/reference/gedit-sections.txt	Sat Dec 27 17:33:03 2008
@@ -1,6 +1,5 @@
 <SECTION>
 <FILE>gedit-app</FILE>
-GeditAppPrivate
 <TITLE>GeditApp</TITLE>
 GeditApp
 GeditLockdownMask
@@ -24,7 +23,6 @@
 <SECTION>
 <FILE>gedit-document</FILE>
 GeditSearchFlags
-GeditDocumentPrivate
 <TITLE>GeditDocument</TITLE>
 GeditDocument
 GeditDocumentSaveFlags
@@ -72,7 +70,6 @@
 
 <SECTION>
 <FILE>gedit-encodings-option-menu</FILE>
-GeditEncodingsOptionMenuPrivate
 <TITLE>GeditEncodingsOptionMenu</TITLE>
 GeditEncodingsOptionMenu
 gedit_encodings_option_menu_new
@@ -90,7 +87,6 @@
 
 <SECTION>
 <FILE>gedit-file-chooser-dialog</FILE>
-GeditFileChooserDialogPrivate
 <TITLE>GeditFileChooserDialog</TITLE>
 GeditFileChooserDialog
 gedit_file_chooser_dialog_new
@@ -107,7 +103,6 @@
 
 <SECTION>
 <FILE>gedit-message-area</FILE>
-GeditMessageAreaPrivate
 <TITLE>GeditMessageArea</TITLE>
 GeditMessageArea
 gedit_message_area_new
@@ -214,7 +209,6 @@
 
 <SECTION>
 <FILE>gedit-notebook</FILE>
-GeditNotebookPrivate
 <TITLE>GeditNotebook</TITLE>
 GeditNotebook
 gedit_notebook_new
@@ -240,7 +234,6 @@
 
 <SECTION>
 <FILE>gedit-panel</FILE>
-GeditPanelPrivate
 <TITLE>GeditPanel</TITLE>
 GeditPanel
 gedit_panel_new
@@ -287,7 +280,6 @@
 
 <SECTION>
 <FILE>gedit-print-job-preview</FILE>
-GeditPrintJobPreviewPrivate
 <TITLE>GeditPrintJobPreview</TITLE>
 GeditPrintJobPreview
 gedit_print_job_preview_new
@@ -320,7 +312,6 @@
 
 <SECTION>
 <FILE>gedit-progress-message-area</FILE>
-GeditProgressMessageAreaPrivate
 <TITLE>GeditProgressMessageArea</TITLE>
 GeditProgressMessageArea
 gedit_progress_message_area_new
@@ -341,7 +332,6 @@
 
 <SECTION>
 <FILE>gedit-statusbar</FILE>
-GeditStatusbarPrivate
 <TITLE>GeditStatusbar</TITLE>
 GeditStatusbar
 gedit_statusbar_new
@@ -364,7 +354,6 @@
 <SECTION>
 <FILE>gedit-tab</FILE>
 GeditTabState
-GeditTabPrivate
 <TITLE>GeditTab</TITLE>
 GeditTab
 gedit_tab_get_view
@@ -387,7 +376,6 @@
 
 <SECTION>
 <FILE>gedit-view</FILE>
-GeditViewPrivate
 <TITLE>GeditView</TITLE>
 GeditView
 gedit_view_new
@@ -412,7 +400,6 @@
 <SECTION>
 <FILE>gedit-window</FILE>
 GeditWindowState
-GeditWindowPrivate
 <TITLE>GeditWindow</TITLE>
 GeditWindow
 gedit_window_create_tab
@@ -433,6 +420,7 @@
 gedit_window_get_statusbar
 gedit_window_get_ui_manager
 gedit_window_get_state
+gedit_window_get_message_bus
 gedit_window_get_tab_from_uri
 <SUBSECTION Standard>
 GEDIT_WINDOW

Modified: branches/message_system/docs/reference/tmpl/gedit-app.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-app.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-app.sgml	Sat Dec 27 17:33:03 2008
@@ -17,12 +17,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GeditAppPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditApp ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-document.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-document.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-document.sgml	Sat Dec 27 17:33:03 2008
@@ -26,12 +26,6 @@
 @GEDIT_SEARCH_ENTIRE_WORD: 
 @GEDIT_SEARCH_CASE_SENSITIVE: 
 
-<!-- ##### STRUCT GeditDocumentPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditDocument ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-encodings-option-menu.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-encodings-option-menu.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-encodings-option-menu.sgml	Sat Dec 27 17:33:03 2008
@@ -17,12 +17,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GeditEncodingsOptionMenuPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditEncodingsOptionMenu ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-file-chooser-dialog.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-file-chooser-dialog.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-file-chooser-dialog.sgml	Sat Dec 27 17:33:03 2008
@@ -17,12 +17,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GeditFileChooserDialogPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditFileChooserDialog ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-message-area.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-message-area.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-message-area.sgml	Sat Dec 27 17:33:03 2008
@@ -17,12 +17,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GeditMessageAreaPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditMessageArea ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-message-type.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-message-type.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-message-type.sgml	Sat Dec 27 17:33:03 2008
@@ -9,13 +9,11 @@
 
 </para>
 
-
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
 </para>
 
-
 <!-- ##### SECTION Stability_Level ##### -->
 
 

Modified: branches/message_system/docs/reference/tmpl/gedit-notebook.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-notebook.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-notebook.sgml	Sat Dec 27 17:33:03 2008
@@ -17,12 +17,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GeditNotebookPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditNotebook ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-panel.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-panel.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-panel.sgml	Sat Dec 27 17:33:03 2008
@@ -17,12 +17,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GeditPanelPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditPanel ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-progress-message-area.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-progress-message-area.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-progress-message-area.sgml	Sat Dec 27 17:33:03 2008
@@ -17,12 +17,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GeditProgressMessageAreaPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditProgressMessageArea ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-statusbar.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-statusbar.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-statusbar.sgml	Sat Dec 27 17:33:03 2008
@@ -17,12 +17,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GeditStatusbarPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditStatusbar ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-tab.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-tab.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-tab.sgml	Sat Dec 27 17:33:03 2008
@@ -38,12 +38,6 @@
 @GEDIT_TAB_STATE_EXTERNALLY_MODIFIED_NOTIFICATION: 
 @GEDIT_TAB_NUM_OF_STATES: 
 
-<!-- ##### STRUCT GeditTabPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditTab ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-unused.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-unused.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-unused.sgml	Sat Dec 27 17:33:03 2008
@@ -351,12 +351,42 @@
 </para>
 
 
+<!-- ##### STRUCT GeditAppPrivate ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### ARG GeditDocument:has-selection ##### -->
 <para>
 
 </para>
 
 
+<!-- ##### STRUCT GeditDocumentPrivate ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GeditEncodingsOptionMenuPrivate ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GeditFileChooserDialogPrivate ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GeditMessageAreaPrivate ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### STRUCT GeditMessageBusPrivate ##### -->
 <para>
 
@@ -369,6 +399,18 @@
 </para>
 
 
+<!-- ##### STRUCT GeditNotebookPrivate ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GeditPanelPrivate ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### STRUCT GeditPrintJobPreview ##### -->
 <para>
 
@@ -393,6 +435,36 @@
 </para>
 
 
+<!-- ##### STRUCT GeditProgressMessageAreaPrivate ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GeditStatusbarPrivate ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GeditTabPrivate ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GeditViewPrivate ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GeditWindowPrivate ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### FUNCTION gedit_message_get_key_type ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-view.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-view.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-view.sgml	Sat Dec 27 17:33:03 2008
@@ -17,12 +17,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GeditViewPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditView ##### -->
 <para>
 

Modified: branches/message_system/docs/reference/tmpl/gedit-window.sgml
==============================================================================
--- branches/message_system/docs/reference/tmpl/gedit-window.sgml	(original)
+++ branches/message_system/docs/reference/tmpl/gedit-window.sgml	Sat Dec 27 17:33:03 2008
@@ -29,12 +29,6 @@
 @GEDIT_WINDOW_STATE_ERROR: 
 @GEDIT_WINDOW_STATE_SAVING_SESSION: 
 
-<!-- ##### STRUCT GeditWindowPrivate ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### STRUCT GeditWindow ##### -->
 <para>
 
@@ -251,6 +245,15 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION gedit_window_get_message_bus ##### -->
+<para>
+
+</para>
+
+ window: 
+ Returns: 
+
+
 <!-- ##### FUNCTION gedit_window_get_tab_from_uri ##### -->
 <para>
 

Modified: branches/message_system/gedit/gedit-message-bus.c
==============================================================================
--- branches/message_system/gedit/gedit-message-bus.c	(original)
+++ branches/message_system/gedit/gedit-message-bus.c	Sat Dec 27 17:33:03 2008
@@ -14,6 +14,82 @@
  * when a message is received (see #gedit_message_bus_connect).
  *
  */
+
+/**
+ * SECTION:gedit-message-bus
+ * @short_description: internal message communication bus
+ * @include: gedit/gedit-message-bus.h
+ *
+ * gedit has a communication bus very similar to DBus. Its primary use is to
+ * allow easy communication between plugins, but it can also be used to expose
+ * gedit functionality to external applications by providing DBus bindings for
+ * the internal gedit message bus.
+ *
+ * There are two different communication busses available. The default bus
+ * (see gedit_message_bus_get_default()) is an application wide communication
+ * bus. In addition, each #GeditWindow has a separate, private bus
+ * (see gedit_window_get_message_bus()). This makes it easier for plugins to
+ * communicate to other plugins in the same window.
+ *
+ * The concept of the message bus is very simple. You can register a message
+ * type on the bus, specified as a Method at a specific Object Path with a
+ * certain set of Method Arguments. You can then connect callback functions
+ * for this message type on the bus. Whenever a message with the Object Path
+ * and Method for which callbacks are connected is sent over the bus, the
+ * callbacks are called. There is no distinction between Methods and Signals
+ * (signals are simply messages where sender and receiver have switched places).
+ *
+ * <example>
+ * <title>Registering a message type</title>
+ * <programlisting>
+ * GeditMessageBus *bus = gedit_message_bus_get_default ();
+ *
+ * // Register 'method' at '/plugins/example' with one required
+ * // string argument 'arg1'
+ * GeditMessageType *message_type = gedit_message_bus_register ("/plugins/example", "method", 
+ *                                                              0, 
+ *                                                              "arg1", G_TYPE_STRING,
+ *                                                              NULL);
+ * </programlisting>
+ * </example>
+ * <example>
+ * <title>Connecting a callback</title>
+ * <programlisting>
+ * static void
+ * example_method_cb (GeditMessageBus *bus,
+ *                    GeditMessage    *message,
+ *                    gpointer         userdata)
+ * {
+ * 	gchar *arg1 = NULL;
+ *	
+ * 	gedit_message_get (message, "arg1", &arg1, NULL);
+ * 	g_message ("Evoked /plugins/example.method with: %s", arg1);
+ * 	g_free (arg1);
+ * }
+ *
+ * GeditMessageBus *bus = gedit_message_bus_get_default ();
+ * 
+ * guint id = gedit_message_bus_connect (bus, 
+ *                                       "/plugins/example", "method",
+ *                                       example_method_cb,
+ *                                       NULL,
+ *                                       NULL);
+ *                                        
+ * </programlisting>
+ * </example>
+ * <example>
+ * <title>Sending a message</title>
+ * <programlisting>
+ * GeditMessageBus *bus = gedit_message_bus_get_default ();
+ *
+ * gedit_message_bus_send (bus, 
+ *                         "/plugins/example", "method", 
+ *                         "arg1", "Hello World", 
+ *                         NULL);
+ * </programlisting>
+ * </example>
+ */
+ 
 #define GEDIT_MESSAGE_BUS_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE((object), GEDIT_TYPE_MESSAGE_BUS, GeditMessageBusPrivate))
 
 typedef struct
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]