summaryrefslogtreecommitdiff
path: root/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml
diff options
context:
space:
mode:
authorPerberos <[email protected]>2011-12-01 22:56:10 -0300
committerPerberos <[email protected]>2011-12-01 22:56:10 -0300
commitc51ef797a707f4e2c6f9688d4378f2b0e9898a66 (patch)
tree019ae92bb53c19b30077545cb14743cbd1b57aef /doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml
downloadmate-panel-c51ef797a707f4e2c6f9688d4378f2b0e9898a66.tar.bz2
mate-panel-c51ef797a707f4e2c6f9688d4378f2b0e9898a66.tar.xz
moving from https://github.com/perberos/mate-desktop-environment
Diffstat (limited to 'doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml')
-rw-r--r--doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml109
1 files changed, 109 insertions, 0 deletions
diff --git a/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml b/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml
new file mode 100644
index 00000000..f184f7f2
--- /dev/null
+++ b/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml
@@ -0,0 +1,109 @@
+<!-- ##### MACRO MATE_PANEL_APPLET_MATECOMPONENT_FACTORY ##### -->
+<para>
+Defines a 'main' routine for the applet factory.
+</para>
+
+@iid: The matecomponent-activation iid of the factory.
+@type: The #GType to instantiate.
+@name: The applet ID string.
+@version: The applet version string.
+@callback: The factory callback.
+@data: The factory user data pointer.
+
+<!-- ##### MACRO MATE_PANEL_APPLET_MATECOMPONENT_SHLIB_FACTORY ##### -->
+<para>
+Defines a MateComponent Activation shared library plugin and associated
+factory callback.
+</para>
+
+@iid: The matecomponent-activation iid of the factory.
+@type: The #GType to instantiate.
+@descr: A description of the applet.
+@callback: The factory callback.
+@data: The factory user data pointer.
+
+<!-- ##### MACRO MATE_PANEL_APPLET_ORIENT_DOWN ##### -->
+<para>
+The applet is orientated down (i.e. the panel is at the top of the screen).
+</para>
+
+
+<!-- ##### MACRO MATE_PANEL_APPLET_ORIENT_LEFT ##### -->
+<para>
+The applet is orientated left (i.e. the panel is at the right hand side of the screen).
+</para>
+
+
+<!-- ##### MACRO MATE_PANEL_APPLET_ORIENT_RIGHT ##### -->
+<para>
+The applet is orientated right (i.e. the panel is at the left hand side of the screen).
+</para>
+
+
+<!-- ##### MACRO MATE_PANEL_APPLET_ORIENT_UP ##### -->
+<para>
+The applet is orientated up (i.e. the panel is at the bottom of the screen).
+</para>
+
+
+<!-- ##### FUNCTION mate_panel_applet_factory_main_closure ##### -->
+<para>
+A generic 'main' routine for applets. This should not normally be
+used directly because it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_FACTORY.
+</para>
+
+@iid: The matecomponent-activation iid of the factory.
+@applet_type: The #GType to instantiate.
+@closure: The factory callback closure.
+@Returns: 0 on success, 1 on failure.
+
+<!-- ##### FUNCTION mate_panel_applet_get_control ##### -->
+<para>
+Retrieves the #MateComponentControl associated with @applet.
+</para>
+
+@applet: The #MatePanelApplet.
+@Returns: A #MateComponentControl.
+
+<!-- ##### FUNCTION mate_panel_applet_get_popup_component ##### -->
+<para>
+Retrieves the #MateComponentUIComponent used for popup menus associated
+with @applet.
+</para>
+
+@applet: The #MatePanelApplet.
+@Returns: A #MateComponentUIComponent.
+
+<!-- ##### FUNCTION mate_panel_applet_shlib_factory ##### -->
+<para>
+A generic shared library factory routine for applets. This should not
+normally be used directly as it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_SHLIB_FACTORY.
+</para>
+
+@iid: The matecomponent-activation iid of the factory.
+@applet_type: The #GType to instantiate.
+@poa: The #PortableServer_POA passed to the shlib factory
+callback.
+@impl_ptr: The #gpointer passed to the shlib factory callback.
+@callback: The applet factory callback.
+@user_data: The factory user data pointer.
+@ev: The $CORBA_Environment passed to the shlib factory callback.
+@Returns: A #MateComponent_Unknown to return from the shlib factory
+callback.
+
+<!-- ##### FUNCTION mate_panel_applet_shlib_factory_closure ##### -->
+<para>
+A generic shared library factory routine for applets. This should not
+normally be used directly as it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_SHLIB_FACTORY.
+</para>
+
+@iid: The matecomponent-activation iid of the factory.
+@applet_type: The #GType to instantiate.
+@poa: The #PortableServer_POA passed to the shlib factory
+callback.
+@impl_ptr: The #gpointer passed to the shlib factory callback.
+@closure: The applet factory closure.
+@ev: The $CORBA_Environment passed to the shlib factory callback.
+@Returns: A #MateComponent_Unknown to return from the shlib factory
+callback.
+