[Xfce4-commits] r24058 - in xfce4-panel/trunk: docs/API docs/API/xml panel
Olivier Fourdan
olivier at xfce.org
Thu Dec 7 22:31:37 CET 2006
Author: olivier
Date: 2006-12-07 21:31:36 +0000 (Thu, 07 Dec 2006)
New Revision: 24058
Modified:
xfce4-panel/trunk/docs/API/libxfce4panel-decl-list.txt
xfce4-panel/trunk/docs/API/libxfce4panel-decl.txt
xfce4-panel/trunk/docs/API/xml/xfce-arrow-button.xml
xfce4-panel/trunk/docs/API/xml/xfce-hvbox.xml
xfce4-panel/trunk/docs/API/xml/xfce-itembar.xml
xfce4-panel/trunk/docs/API/xml/xfce-panel-convenience.xml
xfce4-panel/trunk/docs/API/xml/xfce-panel-enums.xml
xfce4-panel/trunk/docs/API/xml/xfce-panel-external-plugin.xml
xfce4-panel/trunk/docs/API/xml/xfce-panel-internal-plugin.xml
xfce4-panel/trunk/docs/API/xml/xfce-panel-plugin-iface.xml
xfce4-panel/trunk/docs/API/xml/xfce-panel-plugin.xml
xfce4-panel/trunk/docs/API/xml/xfce-panel-window.xml
xfce4-panel/trunk/panel/panel-dialogs.c
Log:
Update user time to prevent focus stealing prevention to come in the way.
Modified: xfce4-panel/trunk/docs/API/libxfce4panel-decl-list.txt
===================================================================
--- xfce4-panel/trunk/docs/API/libxfce4panel-decl-list.txt 2006-12-07 21:14:14 UTC (rev 24057)
+++ xfce4-panel/trunk/docs/API/libxfce4panel-decl-list.txt 2006-12-07 21:31:36 UTC (rev 24058)
@@ -1,6 +1,7 @@
<SECTION>
<FILE>xfce-panel-external-plugin</FILE>
<TITLE>XfceExternalPanelPlugin</TITLE>
+XfceExternalPanelPlugin
xfce_external_panel_plugin_new
<SUBSECTION Standard>
XFCE_EXTERNAL_PANEL_PLUGIN
@@ -15,6 +16,7 @@
<SECTION>
<FILE>xfce-itembar</FILE>
<TITLE>XfceItembar</TITLE>
+XfceItembar
xfce_itembar_new
xfce_itembar_set_orientation
xfce_itembar_get_orientation
@@ -43,6 +45,22 @@
</SECTION>
<SECTION>
+<FILE>xfce-hvbox</FILE>
+<TITLE>XfceHVBox</TITLE>
+XfceHVBox
+xfce_hvbox_new
+xfce_hvbox_set_orientation
+<SUBSECTION Standard>
+XFCE_HVBOX
+XFCE_IS_HVBOX
+XFCE_TYPE_HVBOX
+xfce_hvbox_get_type
+XFCE_HVBOX_CLASS
+XFCE_IS_HVBOX_CLASS
+XFCE_HVBOX_GET_CLASS
+</SECTION>
+
+<SECTION>
<FILE>xfce-panel-plugin-iface</FILE>
XFCE_PANEL_PLUGIN_GET_INTERFACE
XfcePanelPlugin
@@ -78,6 +96,7 @@
<SECTION>
<FILE>xfce-arrow-button</FILE>
<TITLE>XfceArrowButton</TITLE>
+XfceArrowButton
xfce_arrow_button_new
xfce_arrow_button_set_arrow_type
xfce_arrow_button_get_arrow_type
@@ -97,6 +116,7 @@
XfcePanelWindowMoveFunc
XfcePanelWindowResizeFunc
<TITLE>XfcePanelWindow</TITLE>
+XfcePanelWindow
xfce_panel_window_new
xfce_panel_window_set_orientation
xfce_panel_window_get_orientation
@@ -121,6 +141,7 @@
<SECTION>
<FILE>xfce-panel-internal-plugin</FILE>
<TITLE>XfceInternalPanelPlugin</TITLE>
+XfceInternalPanelPlugin
xfce_internal_panel_plugin_new
<SUBSECTION Standard>
XFCE_INTERNAL_PANEL_PLUGIN
@@ -133,21 +154,6 @@
</SECTION>
<SECTION>
-<FILE>xfce-hvbox</FILE>
-<TITLE>XfceHVBox</TITLE>
-xfce_hvbox_new
-xfce_hvbox_set_orientation
-<SUBSECTION Standard>
-XFCE_HVBOX
-XFCE_IS_HVBOX
-XFCE_TYPE_HVBOX
-xfce_hvbox_get_type
-XFCE_HVBOX_CLASS
-XFCE_IS_HVBOX_CLASS
-XFCE_HVBOX_GET_CLASS
-</SECTION>
-
-<SECTION>
<FILE>xfce-panel-enums</FILE>
XfceScreenPosition
xfce_screen_position_is_horizontal
@@ -160,6 +166,13 @@
</SECTION>
<SECTION>
+<FILE>xfce-panel-convenience</FILE>
+xfce_create_panel_button
+xfce_create_panel_toggle_button
+xfce_allow_panel_customization
+</SECTION>
+
+<SECTION>
<FILE>xfce-panel-plugin</FILE>
XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL
XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK
@@ -185,10 +198,3 @@
panel_slice_free
</SECTION>
-<SECTION>
-<FILE>xfce-panel-convenience</FILE>
-xfce_create_panel_button
-xfce_create_panel_toggle_button
-xfce_allow_panel_customization
-</SECTION>
-
Modified: xfce4-panel/trunk/docs/API/libxfce4panel-decl.txt
===================================================================
--- xfce4-panel/trunk/docs/API/libxfce4panel-decl.txt 2006-12-07 21:14:14 UTC (rev 24057)
+++ xfce4-panel/trunk/docs/API/libxfce4panel-decl.txt 2006-12-07 21:31:36 UTC (rev 24058)
@@ -273,6 +273,81 @@
(position >= XFCE_SCREEN_POSITION_SW_H)
</MACRO>
<MACRO>
+<NAME>XFCE_TYPE_HVBOX</NAME>
+#define XFCE_TYPE_HVBOX (xfce_hvbox_get_type())
+</MACRO>
+<MACRO>
+<NAME>XFCE_HVBOX</NAME>
+#define XFCE_HVBOX(obj) (G_TYPE_CHECK_INSTANCE_CAST (obj, xfce_hvbox_get_type (), XfceHVBox))
+</MACRO>
+<MACRO>
+<NAME>XFCE_HVBOX_CLASS</NAME>
+#define XFCE_HVBOX_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST (klass, xfce_hvbox_get_type (), XfceHVBoxClass))
+</MACRO>
+<MACRO>
+<NAME>XFCE_IS_HVBOX</NAME>
+#define XFCE_IS_HVBOX(obj) (G_TYPE_CHECK_INSTANCE_TYPE (obj, xfce_hvbox_get_type ()))
+</MACRO>
+<MACRO>
+<NAME>XFCE_IS_HVBOX_CLASS</NAME>
+#define XFCE_IS_HVBOX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), XFCE_TYPE_HVBOX))
+</MACRO>
+<MACRO>
+<NAME>XFCE_HVBOX_GET_CLASS</NAME>
+#define XFCE_HVBOX_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), XFCE_TYPE_HVBOX, TrayOBoxClass))
+</MACRO>
+<STRUCT>
+<NAME>XfceHVBox</NAME>
+</STRUCT>
+<STRUCT>
+<NAME>XfceHVBoxClass</NAME>
+</STRUCT>
+<STRUCT>
+<NAME>XfceHVBox</NAME>
+struct _XfceHVBox
+{
+ GtkBox hvbox;
+ GtkOrientation orientation;
+};
+</STRUCT>
+<STRUCT>
+<NAME>XfceHVBoxClass</NAME>
+struct _XfceHVBoxClass
+{
+ GtkBoxClass parent_class;
+};
+</STRUCT>
+<FUNCTION>
+<NAME>xfce_hvbox_get_type</NAME>
+<RETURNS>GType </RETURNS>
+void
+</FUNCTION>
+<FUNCTION>
+<NAME>xfce_hvbox_new</NAME>
+<RETURNS>GtkWidget *</RETURNS>
+GtkOrientation orientation,gboolean homogeneous,int spacing
+</FUNCTION>
+<FUNCTION>
+<NAME>xfce_hvbox_set_orientation</NAME>
+<RETURNS>void </RETURNS>
+XfceHVBox * hvbox,GtkOrientation orientation
+</FUNCTION>
+<FUNCTION>
+<NAME>xfce_create_panel_button</NAME>
+<RETURNS>GtkWidget *</RETURNS>
+void
+</FUNCTION>
+<FUNCTION>
+<NAME>xfce_create_panel_toggle_button</NAME>
+<RETURNS>GtkWidget *</RETURNS>
+void
+</FUNCTION>
+<FUNCTION>
+<NAME>xfce_allow_panel_customization</NAME>
+<RETURNS>gboolean </RETURNS>
+void
+</FUNCTION>
+<MACRO>
<NAME>XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL</NAME>
#define XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL(construct) \
int \
@@ -760,66 +835,6 @@
#define XFCE_TYPE_SCREEN_POSITION (xfce_screen_position_get_type())
</MACRO>
<MACRO>
-<NAME>XFCE_TYPE_HVBOX</NAME>
-#define XFCE_TYPE_HVBOX (xfce_hvbox_get_type())
-</MACRO>
-<MACRO>
-<NAME>XFCE_HVBOX</NAME>
-#define XFCE_HVBOX(obj) (G_TYPE_CHECK_INSTANCE_CAST (obj, xfce_hvbox_get_type (), XfceHVBox))
-</MACRO>
-<MACRO>
-<NAME>XFCE_HVBOX_CLASS</NAME>
-#define XFCE_HVBOX_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST (klass, xfce_hvbox_get_type (), XfceHVBoxClass))
-</MACRO>
-<MACRO>
-<NAME>XFCE_IS_HVBOX</NAME>
-#define XFCE_IS_HVBOX(obj) (G_TYPE_CHECK_INSTANCE_TYPE (obj, xfce_hvbox_get_type ()))
-</MACRO>
-<MACRO>
-<NAME>XFCE_IS_HVBOX_CLASS</NAME>
-#define XFCE_IS_HVBOX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), XFCE_TYPE_HVBOX))
-</MACRO>
-<MACRO>
-<NAME>XFCE_HVBOX_GET_CLASS</NAME>
-#define XFCE_HVBOX_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), XFCE_TYPE_HVBOX, TrayOBoxClass))
-</MACRO>
-<STRUCT>
-<NAME>XfceHVBox</NAME>
-</STRUCT>
-<STRUCT>
-<NAME>XfceHVBoxClass</NAME>
-</STRUCT>
-<STRUCT>
-<NAME>XfceHVBox</NAME>
-struct _XfceHVBox
-{
- GtkBox hvbox;
- GtkOrientation orientation;
-};
-</STRUCT>
-<STRUCT>
-<NAME>XfceHVBoxClass</NAME>
-struct _XfceHVBoxClass
-{
- GtkBoxClass parent_class;
-};
-</STRUCT>
-<FUNCTION>
-<NAME>xfce_hvbox_get_type</NAME>
-<RETURNS>GType </RETURNS>
-void
-</FUNCTION>
-<FUNCTION>
-<NAME>xfce_hvbox_new</NAME>
-<RETURNS>GtkWidget *</RETURNS>
-GtkOrientation orientation,gboolean homogeneous,int spacing
-</FUNCTION>
-<FUNCTION>
-<NAME>xfce_hvbox_set_orientation</NAME>
-<RETURNS>void </RETURNS>
-XfceHVBox * hvbox,GtkOrientation orientation
-</FUNCTION>
-<MACRO>
<NAME>panel_slice_alloc</NAME>
#define panel_slice_alloc(block_size) (g_slice_alloc ((block_size)))
</MACRO>
@@ -867,18 +882,3 @@
<NAME>panel_slice_free</NAME>
#define panel_slice_free(type, ptr) G_STMT_START{ g_free ((ptr)); }G_STMT_END
</MACRO>
-<FUNCTION>
-<NAME>xfce_create_panel_button</NAME>
-<RETURNS>GtkWidget *</RETURNS>
-void
-</FUNCTION>
-<FUNCTION>
-<NAME>xfce_create_panel_toggle_button</NAME>
-<RETURNS>GtkWidget *</RETURNS>
-void
-</FUNCTION>
-<FUNCTION>
-<NAME>xfce_allow_panel_customization</NAME>
-<RETURNS>gboolean </RETURNS>
-void
-</FUNCTION>
Modified: xfce4-panel/trunk/docs/API/xml/xfce-arrow-button.xml
===================================================================
--- xfce4-panel/trunk/docs/API/xml/xfce-arrow-button.xml 2006-12-07 21:14:14 UTC (rev 24057)
+++ xfce4-panel/trunk/docs/API/xml/xfce-arrow-button.xml 2006-12-07 21:31:36 UTC (rev 24058)
@@ -3,18 +3,21 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="XfceArrowButton">
<refmeta>
-<refentrytitle>XfceArrowButton</refentrytitle>
+<refentrytitle role="top_of_page">XfceArrowButton</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
-<refname>XfceArrowButton</refname><refpurpose><para>
+<refname>XfceArrowButton</refname>
+<refpurpose><para>
Toggle button with arrow.
</para></refpurpose>
+<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
-<refsynopsisdiv><title>Synopsis</title>
+<refsynopsisdiv role="synopsis">
+<title role="synopsis.title">Synopsis</title>
<synopsis>
@@ -31,8 +34,8 @@
</synopsis>
</refsynopsisdiv>
-<refsect1>
-<title>Object Hierarchy</title>
+<refsect1 role="object_hierarchy">
+<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
@@ -50,8 +53,8 @@
-<refsect1>
-<title>Implemented Interfaces</title>
+<refsect1 role="impl_interfaces">
+<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
XfceArrowButton implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
@@ -59,45 +62,45 @@
</refsect1>
-<refsect1>
-<title>Properties</title>
+<refsect1 role="properties">
+<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="XfceArrowButton--arrow-type">arrow-type</link>" <link linkend="GtkArrowType">GtkArrowType</link> : Read / Write
</synopsis>
</refsect1>
-<refsect1>
-<title>Signal Prototypes</title>
+<refsect1 role="signal_proto">
+<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="XfceArrowButton-arrow-type-changed">arrow-type-changed</link>"
<link linkend="void">void</link> user_function (<link linkend="XfceArrowButton">XfceArrowButton</link> *button,
- <link linkend="GtkArrowType">GtkArrowType</link> type,
- <link linkend="gpointer">gpointer</link> user_data);
+ <link linkend="GtkArrowType">GtkArrowType</link> *type,
+ <link linkend="gpointer">gpointer</link> user_data) : Run first
</synopsis>
</refsect1>
-<refsect1>
-<title>Description</title>
+<refsect1 role="desc">
+<title role="desc.title">Description</title>
<para>
Toggle button with arrow. The arrow direction will be inverted when the button
is toggled.
</para>
</refsect1>
-<refsect1>
-<title>Details</title>
+<refsect1 role="details">
+<title role="details.title">Details</title>
<refsect2>
-<title><anchor id="XfceArrowButton-struct"/>XfceArrowButton</title>
+<title><anchor id="XfceArrowButton-struct" role="struct"/>XfceArrowButton</title>
<indexterm><primary>XfceArrowButton</primary></indexterm><programlisting>typedef struct _XfceArrowButton XfceArrowButton;</programlisting>
<para>
-The <link linkend="XfceArrowButton-struct"><type>XfceArrowButton-struct</type></link> struct contains private data only, and
+The <link linkend="XfceArrowButton-struct"><type>XfceArrowButton</type></link> struct contains private data only, and
should be accessed using the functions below.
</para></refsect2>
<refsect2>
-<title><anchor id="xfce-arrow-button-new"/>xfce_arrow_button_new ()</title>
+<title><anchor id="xfce-arrow-button-new" role="function"/>xfce_arrow_button_new ()</title>
<indexterm><primary>xfce_arrow_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* xfce_arrow_button_new (<link linkend="GtkArrowType">GtkArrowType</link> type);</programlisting>
<para>
</para>
@@ -111,7 +114,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-arrow-button-set-arrow-type"/>xfce_arrow_button_set_arrow_type ()</title>
+<title><anchor id="xfce-arrow-button-set-arrow-type" role="function"/>xfce_arrow_button_set_arrow_type ()</title>
<indexterm><primary>xfce_arrow_button_set_arrow_type</primary></indexterm><programlisting><link linkend="void">void</link> xfce_arrow_button_set_arrow_type
(<link linkend="XfceArrowButton">XfceArrowButton</link> *button,
<link linkend="GtkArrowType">GtkArrowType</link> type);</programlisting>
@@ -128,7 +131,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-arrow-button-get-arrow-type"/>xfce_arrow_button_get_arrow_type ()</title>
+<title><anchor id="xfce-arrow-button-get-arrow-type" role="function"/>xfce_arrow_button_get_arrow_type ()</title>
<indexterm><primary>xfce_arrow_button_get_arrow_type</primary></indexterm><programlisting><link linkend="GtkArrowType">GtkArrowType</link> xfce_arrow_button_get_arrow_type
(<link linkend="XfceArrowButton">XfceArrowButton</link> *button);</programlisting>
<para>
@@ -144,10 +147,10 @@
</variablelist></refsect2>
</refsect1>
-<refsect1>
-<title>Properties</title>
+<refsect1 role="property_details">
+<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="XfceArrowButton--arrow-type"/>The "<literal>arrow-type</literal>" property</title>
-<programlisting> "arrow-type" <link linkend="GtkArrowType">GtkArrowType</link> : Read / Write</programlisting>
+<indexterm><primary>XfceArrowButton:arrow-type</primary></indexterm><programlisting> "arrow-type" <link linkend="GtkArrowType">GtkArrowType</link> : Read / Write</programlisting>
<para>
The arrow type of the button. This value also determines the direction
of the popup menu.</para>
@@ -158,12 +161,12 @@
</refsect1>
-<refsect1>
-<title>Signals</title>
+<refsect1 role="signals">
+<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="XfceArrowButton-arrow-type-changed"/>The "arrow-type-changed" signal</title>
-<programlisting><link linkend="void">void</link> user_function (<link linkend="XfceArrowButton">XfceArrowButton</link> *button,
- <link linkend="GtkArrowType">GtkArrowType</link> type,
- <link linkend="gpointer">gpointer</link> user_data);</programlisting>
+<indexterm><primary>XfceArrowButton::arrow-type-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="XfceArrowButton">XfceArrowButton</link> *button,
+ <link linkend="GtkArrowType">GtkArrowType</link> *type,
+ <link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
Emitted when the arrow direction of the menu button changes.
This value also determines the direction of the popup menu.</para>
Modified: xfce4-panel/trunk/docs/API/xml/xfce-hvbox.xml
===================================================================
--- xfce4-panel/trunk/docs/API/xml/xfce-hvbox.xml 2006-12-07 21:14:14 UTC (rev 24057)
+++ xfce4-panel/trunk/docs/API/xml/xfce-hvbox.xml 2006-12-07 21:31:36 UTC (rev 24058)
@@ -3,18 +3,21 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="XfceHVBox">
<refmeta>
-<refentrytitle>XfceHVBox</refentrytitle>
+<refentrytitle role="top_of_page">XfceHVBox</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
-<refname>XfceHVBox</refname><refpurpose><para>
+<refname>XfceHVBox</refname>
+<refpurpose><para>
Container widget with configurable orienation.
</para></refpurpose>
+<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
-<refsynopsisdiv><title>Synopsis</title>
+<refsynopsisdiv role="synopsis">
+<title role="synopsis.title">Synopsis</title>
<synopsis>
@@ -30,8 +33,8 @@
</synopsis>
</refsynopsisdiv>
-<refsect1>
-<title>Object Hierarchy</title>
+<refsect1 role="object_hierarchy">
+<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
@@ -47,8 +50,8 @@
-<refsect1>
-<title>Implemented Interfaces</title>
+<refsect1 role="impl_interfaces">
+<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
XfceHVBox implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
@@ -59,24 +62,24 @@
-<refsect1>
-<title>Description</title>
+<refsect1 role="desc">
+<title role="desc.title">Description</title>
<para>
<link linkend="XfceHVBox"><type>XfceHVBox</type></link> is a <link linkend="GtkBox"><type>GtkBox</type></link> widget that allows the user to change its orientation.
It is in fact a combination of <link linkend="GtkHBox"><type>GtkHBox</type></link> and <link linkend="GtkVBox"><type>GtkVBox</type></link>.
</para>
</refsect1>
-<refsect1>
-<title>Details</title>
+<refsect1 role="details">
+<title role="details.title">Details</title>
<refsect2>
-<title><anchor id="XfceHVBox-struct"/>XfceHVBox</title>
+<title><anchor id="XfceHVBox-struct" role="struct"/>XfceHVBox</title>
<indexterm><primary>XfceHVBox</primary></indexterm><programlisting>typedef struct _XfceHVBox XfceHVBox;</programlisting>
<para>
</para></refsect2>
<refsect2>
-<title><anchor id="xfce-hvbox-new"/>xfce_hvbox_new ()</title>
+<title><anchor id="xfce-hvbox-new" role="function"/>xfce_hvbox_new ()</title>
<indexterm><primary>xfce_hvbox_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* xfce_hvbox_new (<link linkend="GtkOrientation">GtkOrientation</link> orientation,
<link linkend="gboolean">gboolean</link> homogeneous,
<link linkend="int">int</link> spacing);</programlisting>
@@ -98,7 +101,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-hvbox-set-orientation"/>xfce_hvbox_set_orientation ()</title>
+<title><anchor id="xfce-hvbox-set-orientation" role="function"/>xfce_hvbox_set_orientation ()</title>
<indexterm><primary>xfce_hvbox_set_orientation</primary></indexterm><programlisting><link linkend="void">void</link> xfce_hvbox_set_orientation (<link linkend="XfceHVBox">XfceHVBox</link> *hvbox,
<link linkend="GtkOrientation">GtkOrientation</link> orientation);</programlisting>
<para>
Modified: xfce4-panel/trunk/docs/API/xml/xfce-itembar.xml
===================================================================
--- xfce4-panel/trunk/docs/API/xml/xfce-itembar.xml 2006-12-07 21:14:14 UTC (rev 24057)
+++ xfce4-panel/trunk/docs/API/xml/xfce-itembar.xml 2006-12-07 21:31:36 UTC (rev 24058)
@@ -3,18 +3,21 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="XfceItembar">
<refmeta>
-<refentrytitle>XfceItembar</refentrytitle>
+<refentrytitle role="top_of_page">XfceItembar</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
-<refname>XfceItembar</refname><refpurpose><para>
+<refname>XfceItembar</refname>
+<refpurpose><para>
Container widget with configurable orientation.
</para></refpurpose>
+<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
-<refsynopsisdiv><title>Synopsis</title>
+<refsynopsisdiv role="synopsis">
+<title role="synopsis.title">Synopsis</title>
<synopsis>
@@ -59,8 +62,8 @@
</synopsis>
</refsynopsisdiv>
-<refsect1>
-<title>Object Hierarchy</title>
+<refsect1 role="object_hierarchy">
+<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
@@ -75,8 +78,8 @@
-<refsect1>
-<title>Implemented Interfaces</title>
+<refsect1 role="impl_interfaces">
+<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
XfceItembar implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
@@ -84,55 +87,55 @@
</refsect1>
-<refsect1>
-<title>Properties</title>
+<refsect1 role="properties">
+<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="XfceItembar--orientation">orientation</link>" <link linkend="GtkOrientation">GtkOrientation</link> : Read / Write
</synopsis>
</refsect1>
-<refsect1>
-<title>Child Properties</title>
+<refsect1 role="child_properties">
+<title role="child_properties.title">Child Properties</title>
<synopsis>
"<link linkend="XfceItembar--expand">expand</link>" <link linkend="gboolean">gboolean</link> : Read / Write
</synopsis>
</refsect1>
-<refsect1>
-<title>Signal Prototypes</title>
+<refsect1 role="signal_proto">
+<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="XfceItembar-contents-changed">contents-changed</link>"
<link linkend="void">void</link> user_function (<link linkend="XfceItembar">XfceItembar</link> *itembar,
- <link linkend="gpointer">gpointer</link> user_data);
+ <link linkend="gpointer">gpointer</link> user_data) : Run first
"<link linkend="XfceItembar-orientation-changed">orientation-changed</link>"
- <link linkend="void">void</link> user_function (<link linkend="XfceItembar">XfceItembar</link> *itembar,
- <link linkend="GtkOrientation">GtkOrientation</link> orientation,
- <link linkend="gpointer">gpointer</link> user_data);
+ <link linkend="void">void</link> user_function (<link linkend="XfceItembar">XfceItembar</link> *itembar,
+ <link linkend="GtkOrientation">GtkOrientation</link> *orientation,
+ <link linkend="gpointer">gpointer</link> user_data) : Run first
</synopsis>
</refsect1>
-<refsect1>
-<title>Description</title>
+<refsect1 role="desc">
+<title role="desc.title">Description</title>
<para>
<link linkend="XfceItembar"><type>XfceItembar</type></link> is a container widget that can hold multiple widgets. The
orientation of the bar is configurable and can be changed at any time.
</para>
</refsect1>
-<refsect1>
-<title>Details</title>
+<refsect1 role="details">
+<title role="details.title">Details</title>
<refsect2>
-<title><anchor id="XfceItembar-struct"/>XfceItembar</title>
+<title><anchor id="XfceItembar-struct" role="struct"/>XfceItembar</title>
<indexterm><primary>XfceItembar</primary></indexterm><programlisting>typedef struct _XfceItembar XfceItembar;</programlisting>
<para>
-The <link linkend="XfceItembar-struct"><type>XfceItembar-struct</type></link> struct contains private data only, and
+The <link linkend="XfceItembar-struct"><type>XfceItembar</type></link> struct contains private data only, and
should be accessed using the functions below.
</para></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-new"/>xfce_itembar_new ()</title>
+<title><anchor id="xfce-itembar-new" role="function"/>xfce_itembar_new ()</title>
<indexterm><primary>xfce_itembar_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* xfce_itembar_new (<link linkend="GtkOrientation">GtkOrientation</link> orientation);</programlisting>
<para>
</para>
@@ -146,7 +149,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-set-orientation"/>xfce_itembar_set_orientation ()</title>
+<title><anchor id="xfce-itembar-set-orientation" role="function"/>xfce_itembar_set_orientation ()</title>
<indexterm><primary>xfce_itembar_set_orientation</primary></indexterm><programlisting><link linkend="void">void</link> xfce_itembar_set_orientation (<link linkend="XfceItembar">XfceItembar</link> *itembar,
<link linkend="GtkOrientation">GtkOrientation</link> orientation);</programlisting>
<para>
@@ -162,7 +165,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-get-orientation"/>xfce_itembar_get_orientation ()</title>
+<title><anchor id="xfce-itembar-get-orientation" role="function"/>xfce_itembar_get_orientation ()</title>
<indexterm><primary>xfce_itembar_get_orientation</primary></indexterm><programlisting><link linkend="GtkOrientation">GtkOrientation</link> xfce_itembar_get_orientation (<link linkend="XfceItembar">XfceItembar</link> *itembar);</programlisting>
<para>
</para>
@@ -176,7 +179,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-insert"/>xfce_itembar_insert ()</title>
+<title><anchor id="xfce-itembar-insert" role="function"/>xfce_itembar_insert ()</title>
<indexterm><primary>xfce_itembar_insert</primary></indexterm><programlisting><link linkend="void">void</link> xfce_itembar_insert (<link linkend="XfceItembar">XfceItembar</link> *itembar,
<link linkend="GtkWidget">GtkWidget</link> *item,
<link linkend="int">int</link> position);</programlisting>
@@ -196,7 +199,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-append"/>xfce_itembar_append ()</title>
+<title><anchor id="xfce-itembar-append" role="function"/>xfce_itembar_append ()</title>
<indexterm><primary>xfce_itembar_append</primary></indexterm><programlisting><link linkend="void">void</link> xfce_itembar_append (<link linkend="XfceItembar">XfceItembar</link> *itembar,
<link linkend="GtkWidget">GtkWidget</link> *item);</programlisting>
<para>
@@ -212,7 +215,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-prepend"/>xfce_itembar_prepend ()</title>
+<title><anchor id="xfce-itembar-prepend" role="function"/>xfce_itembar_prepend ()</title>
<indexterm><primary>xfce_itembar_prepend</primary></indexterm><programlisting><link linkend="void">void</link> xfce_itembar_prepend (<link linkend="XfceItembar">XfceItembar</link> *itembar,
<link linkend="GtkWidget">GtkWidget</link> *item);</programlisting>
<para>
@@ -228,7 +231,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-reorder-child"/>xfce_itembar_reorder_child ()</title>
+<title><anchor id="xfce-itembar-reorder-child" role="function"/>xfce_itembar_reorder_child ()</title>
<indexterm><primary>xfce_itembar_reorder_child</primary></indexterm><programlisting><link linkend="void">void</link> xfce_itembar_reorder_child (<link linkend="XfceItembar">XfceItembar</link> *itembar,
<link linkend="GtkWidget">GtkWidget</link> *item,
<link linkend="int">int</link> position);</programlisting>
@@ -248,7 +251,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-set-child-expand"/>xfce_itembar_set_child_expand ()</title>
+<title><anchor id="xfce-itembar-set-child-expand" role="function"/>xfce_itembar_set_child_expand ()</title>
<indexterm><primary>xfce_itembar_set_child_expand</primary></indexterm><programlisting><link linkend="void">void</link> xfce_itembar_set_child_expand (<link linkend="XfceItembar">XfceItembar</link> *itembar,
<link linkend="GtkWidget">GtkWidget</link> *item,
<link linkend="gboolean">gboolean</link> expand);</programlisting>
@@ -268,7 +271,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-get-child-expand"/>xfce_itembar_get_child_expand ()</title>
+<title><anchor id="xfce-itembar-get-child-expand" role="function"/>xfce_itembar_get_child_expand ()</title>
<indexterm><primary>xfce_itembar_get_child_expand</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> xfce_itembar_get_child_expand (<link linkend="XfceItembar">XfceItembar</link> *itembar,
<link linkend="GtkWidget">GtkWidget</link> *item);</programlisting>
<para>
@@ -282,12 +285,12 @@
<varlistentry><term><parameter>item</parameter> :</term>
<listitem><simpara> a child <link linkend="GtkWidget"><type>GtkWidget</type></link> of <parameter>itembar</parameter>
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if <parameter>item</parameter> will expand when the size of <parameter>itembar</parameter> increases,
- otherwise <literal>FALSE</literal>.
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>item</parameter> will expand when the size of <parameter>itembar</parameter> increases,
+ otherwise <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-get-n-items"/>xfce_itembar_get_n_items ()</title>
+<title><anchor id="xfce-itembar-get-n-items" role="function"/>xfce_itembar_get_n_items ()</title>
<indexterm><primary>xfce_itembar_get_n_items</primary></indexterm><programlisting><link linkend="int">int</link> xfce_itembar_get_n_items (<link linkend="XfceItembar">XfceItembar</link> *itembar);</programlisting>
<para>
</para>
@@ -301,7 +304,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-get-item-index"/>xfce_itembar_get_item_index ()</title>
+<title><anchor id="xfce-itembar-get-item-index" role="function"/>xfce_itembar_get_item_index ()</title>
<indexterm><primary>xfce_itembar_get_item_index</primary></indexterm><programlisting><link linkend="int">int</link> xfce_itembar_get_item_index (<link linkend="XfceItembar">XfceItembar</link> *itembar,
<link linkend="GtkWidget">GtkWidget</link> *item);</programlisting>
<para>
@@ -319,7 +322,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-get-nth-item"/>xfce_itembar_get_nth_item ()</title>
+<title><anchor id="xfce-itembar-get-nth-item" role="function"/>xfce_itembar_get_nth_item ()</title>
<indexterm><primary>xfce_itembar_get_nth_item</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* xfce_itembar_get_nth_item (<link linkend="XfceItembar">XfceItembar</link> *itembar,
<link linkend="int">int</link> n);</programlisting>
<para>
@@ -333,12 +336,12 @@
<varlistentry><term><parameter>n</parameter> :</term>
<listitem><simpara> a position on the itembar
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <parameter>n</parameter><!-- -->'s item on <parameter>itembar</parameter>, or <literal>NULL</literal> if the
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <parameter>n</parameter><!-- -->'s item on <parameter>itembar</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the
itembar does not contain an <parameter>n</parameter><!-- -->'th item.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-raise-event-window"/>xfce_itembar_raise_event_window ()</title>
+<title><anchor id="xfce-itembar-raise-event-window" role="function"/>xfce_itembar_raise_event_window ()</title>
<indexterm><primary>xfce_itembar_raise_event_window</primary></indexterm><programlisting><link linkend="void">void</link> xfce_itembar_raise_event_window (<link linkend="XfceItembar">XfceItembar</link> *itembar);</programlisting>
<para>
Raise the event window of <parameter>itembar</parameter>. This causes all events, like
@@ -355,7 +358,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-lower-event-window"/>xfce_itembar_lower_event_window ()</title>
+<title><anchor id="xfce-itembar-lower-event-window" role="function"/>xfce_itembar_lower_event_window ()</title>
<indexterm><primary>xfce_itembar_lower_event_window</primary></indexterm><programlisting><link linkend="void">void</link> xfce_itembar_lower_event_window (<link linkend="XfceItembar">XfceItembar</link> *itembar);</programlisting>
<para>
Lower the event window of <parameter>itembar</parameter>. This causes all events, like
@@ -372,7 +375,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-event-window-is-raised"/>xfce_itembar_event_window_is_raised ()</title>
+<title><anchor id="xfce-itembar-event-window-is-raised" role="function"/>xfce_itembar_event_window_is_raised ()</title>
<indexterm><primary>xfce_itembar_event_window_is_raised</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> xfce_itembar_event_window_is_raised
(<link linkend="XfceItembar">XfceItembar</link> *itembar);</programlisting>
<para>
@@ -383,11 +386,11 @@
<varlistentry><term><parameter>itembar</parameter> :</term>
<listitem><simpara> an <link linkend="XfceItembar"><type>XfceItembar</type></link>
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if event window is raised.
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if event window is raised.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-get-item-at-point"/>xfce_itembar_get_item_at_point ()</title>
+<title><anchor id="xfce-itembar-get-item-at-point" role="function"/>xfce_itembar_get_item_at_point ()</title>
<indexterm><primary>xfce_itembar_get_item_at_point</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* xfce_itembar_get_item_at_point (<link linkend="XfceItembar">XfceItembar</link> *itembar,
<link linkend="int">int</link> x,
<link linkend="int">int</link> y);</programlisting>
@@ -405,11 +408,11 @@
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> y coordinate relative to the itembar window
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> or <literal>NULL</literal>.
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-itembar-get-drop-index"/>xfce_itembar_get_drop_index ()</title>
+<title><anchor id="xfce-itembar-get-drop-index" role="function"/>xfce_itembar_get_drop_index ()</title>
<indexterm><primary>xfce_itembar_get_drop_index</primary></indexterm><programlisting><link linkend="int">int</link> xfce_itembar_get_drop_index (<link linkend="XfceItembar">XfceItembar</link> *itembar,
<link linkend="int">int</link> x,
<link linkend="int">int</link> y);</programlisting>
@@ -439,10 +442,10 @@
</variablelist></refsect2>
</refsect1>
-<refsect1>
-<title>Properties</title>
+<refsect1 role="property_details">
+<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="XfceItembar--orientation"/>The "<literal>orientation</literal>" property</title>
-<programlisting> "orientation" <link linkend="GtkOrientation">GtkOrientation</link> : Read / Write</programlisting>
+<indexterm><primary>XfceItembar:orientation</primary></indexterm><programlisting> "orientation" <link linkend="GtkOrientation">GtkOrientation</link> : Read / Write</programlisting>
<para>
The orientation of the <link linkend="XfceItembar"><type>XfceItembar</type></link>.</para>
<para>
@@ -451,10 +454,10 @@
</refsect2>
</refsect1>
-<refsect1>
-<title>Child Properties</title>
+<refsect1 role="child_property_details">
+<title role="child_property_details.title">Child Property Details</title>
<refsect2><title><anchor id="XfceItembar--expand"/>The "<literal>expand</literal>" child property</title>
-<programlisting> "expand" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
+<indexterm><primary>XfceItembar:expand</primary></indexterm><programlisting> "expand" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>
Whether the child of the <link linkend="XfceItembar"><type>XfceItembar</type></link> should fill available space.</para>
<para>
@@ -464,11 +467,11 @@
</refsect1>
-<refsect1>
-<title>Signals</title>
+<refsect1 role="signals">
+<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="XfceItembar-contents-changed"/>The "contents-changed" signal</title>
-<programlisting><link linkend="void">void</link> user_function (<link linkend="XfceItembar">XfceItembar</link> *itembar,
- <link linkend="gpointer">gpointer</link> user_data);</programlisting>
+<indexterm><primary>XfceItembar::contents-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="XfceItembar">XfceItembar</link> *itembar,
+ <link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
Emitted when the contents of the itembar change, either by adding
a child, removing a child, or reordering a child.</para>
@@ -481,9 +484,9 @@
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="XfceItembar-orientation-changed"/>The "orientation-changed" signal</title>
-<programlisting><link linkend="void">void</link> user_function (<link linkend="XfceItembar">XfceItembar</link> *itembar,
- <link linkend="GtkOrientation">GtkOrientation</link> orientation,
- <link linkend="gpointer">gpointer</link> user_data);</programlisting>
+<indexterm><primary>XfceItembar::orientation-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="XfceItembar">XfceItembar</link> *itembar,
+ <link linkend="GtkOrientation">GtkOrientation</link> *orientation,
+ <link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
Emitted when the orientation of the itembar changes.</para>
<para>
Modified: xfce4-panel/trunk/docs/API/xml/xfce-panel-convenience.xml
===================================================================
--- xfce4-panel/trunk/docs/API/xml/xfce-panel-convenience.xml 2006-12-07 21:14:14 UTC (rev 24057)
+++ xfce4-panel/trunk/docs/API/xml/xfce-panel-convenience.xml 2006-12-07 21:31:36 UTC (rev 24058)
@@ -3,18 +3,21 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libxfce4panel-Convenience-Functions">
<refmeta>
-<refentrytitle>Convenience Functions</refentrytitle>
+<refentrytitle role="top_of_page">Convenience Functions</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
-<refname>Convenience Functions</refname><refpurpose><para>
+<refname>Convenience Functions</refname>
+<refpurpose><para>
Special purpose widgets and utilities.
</para></refpurpose>
+<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
-<refsynopsisdiv><title>Synopsis</title>
+<refsynopsisdiv role="synopsis">
+<title role="synopsis.title">Synopsis</title>
<synopsis>
@@ -33,22 +36,22 @@
-<refsect1>
-<title>Description</title>
+<refsect1 role="desc">
+<title role="desc.title">Description</title>
<para>
This section describes a number of functions that were created to help
developers of Xfce Panel plugins.
</para>
</refsect1>
-<refsect1>
-<title>Details</title>
+<refsect1 role="details">
+<title role="details.title">Details</title>
<refsect2>
-<title><anchor id="xfce-create-panel-button"/>xfce_create_panel_button ()</title>
+<title><anchor id="xfce-create-panel-button" role="function"/>xfce_create_panel_button ()</title>
<indexterm><primary>xfce_create_panel_button</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* xfce_create_panel_button (void);</programlisting>
<para>
Create regular <link linkend="GtkToggleButton"><type>GtkToggleButton</type></link> with a few properties set to be useful in
-Xfce panel: Flat (<literal>GTK_RELIEF_NONE</literal>), no focus on click and minimal padding.</para>
+Xfce panel: Flat (<link linkend="GTK-RELIEF-NONE:CAPS"><literal>GTK_RELIEF_NONE</literal></link>), no focus on click and minimal padding.</para>
<para>
</para><variablelist role="params">
@@ -56,7 +59,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-create-panel-toggle-button"/>xfce_create_panel_toggle_button ()</title>
+<title><anchor id="xfce-create-panel-toggle-button" role="function"/>xfce_create_panel_toggle_button ()</title>
<indexterm><primary>xfce_create_panel_toggle_button</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* xfce_create_panel_toggle_button (void);</programlisting>
<para>
Modified: xfce4-panel/trunk/docs/API/xml/xfce-panel-enums.xml
===================================================================
--- xfce4-panel/trunk/docs/API/xml/xfce-panel-enums.xml 2006-12-07 21:14:14 UTC (rev 24057)
+++ xfce4-panel/trunk/docs/API/xml/xfce-panel-enums.xml 2006-12-07 21:31:36 UTC (rev 24058)
@@ -3,18 +3,21 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libxfce4panel-Standard-Enumerations">
<refmeta>
-<refentrytitle>Standard Enumerations</refentrytitle>
+<refentrytitle role="top_of_page">Standard Enumerations</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
-<refname>Standard Enumerations</refname><refpurpose><para>
+<refname>Standard Enumerations</refname>
+<refpurpose><para>
Standard enumerations used by the Xfce Panel.
</para></refpurpose>
+<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
-<refsynopsisdiv><title>Synopsis</title>
+<refsynopsisdiv role="synopsis">
+<title role="synopsis.title">Synopsis</title>
<synopsis>
@@ -39,17 +42,17 @@
-<refsect1>
-<title>Description</title>
+<refsect1 role="desc">
+<title role="desc.title">Description</title>
<para>
Currently only contains the definition of <link linkend="XfceScreenPosition"><type>XfceScreenPosition</type></link>.
</para>
</refsect1>
-<refsect1>
-<title>Details</title>
+<refsect1 role="details">
+<title role="details.title">Details</title>
<refsect2>
-<title><anchor id="XfceScreenPosition"/>enum XfceScreenPosition</title>
+<title><anchor id="XfceScreenPosition" role="enum"/>enum XfceScreenPosition</title>
<indexterm><primary>XfceScreenPosition</primary></indexterm><programlisting>typedef enum /*<enum,prefix=XFCE_SCREEN_POSITION >*/
{
XFCE_SCREEN_POSITION_NONE,
@@ -90,83 +93,83 @@
</para><variablelist role="enum">
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_NONE</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-NONE:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_NONE</literal></term>
<listitem><simpara> No position has been set.
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_NW_H</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-NW-H:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_NW_H</literal></term>
<listitem><simpara> North West Horizontal
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_N</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-N:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_N</literal></term>
<listitem><simpara> North
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_NE_H</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-NE-H:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_NE_H</literal></term>
<listitem><simpara> North East Horizontal
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_NW_V</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-NW-V:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_NW_V</literal></term>
<listitem><simpara> North West Vertical
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_W</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-W:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_W</literal></term>
<listitem><simpara> West
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_SW_V</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-SW-V:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_SW_V</literal></term>
<listitem><simpara> South West Vertical
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_NE_V</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-NE-V:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_NE_V</literal></term>
<listitem><simpara> North East Vertical
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_E</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-E:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_E</literal></term>
<listitem><simpara> East
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_SE_V</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-SE-V:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_SE_V</literal></term>
<listitem><simpara> South East Vertical
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_SW_H</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-SW-H:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_SW_H</literal></term>
<listitem><simpara> South West Horizontal
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_S</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-S:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_S</literal></term>
<listitem><simpara> South
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_SE_H</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-SE-H:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_SE_H</literal></term>
<listitem><simpara> South East Horizontal
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_FLOATING_H</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-FLOATING-H:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_FLOATING_H</literal></term>
<listitem><simpara> Floating Horizontal
</simpara></listitem>
</varlistentry>
<varlistentry>
-<term><literal>XFCE_SCREEN_POSITION_FLOATING_V</literal></term>
+<term><anchor id="XFCE-SCREEN-POSITION-FLOATING-V:CAPS" role="constant"/><literal>XFCE_SCREEN_POSITION_FLOATING_V</literal></term>
<listitem><simpara> Floating Vertical
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-screen-position-is-horizontal"/>xfce_screen_position_is_horizontal()</title>
+<title><anchor id="xfce-screen-position-is-horizontal" role="macro"/>xfce_screen_position_is_horizontal()</title>
<indexterm><primary>xfce_screen_position_is_horizontal</primary></indexterm><programlisting>#define xfce_screen_position_is_horizontal(position)</programlisting>
<para>
</para>
@@ -176,11 +179,11 @@
<varlistentry><term><parameter>position</parameter> :</term>
<listitem><simpara> the <link linkend="XfceScreenPosition"><type>XfceScreenPosition</type></link>
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if horizontal, <literal>FALSE</literal> otherwise
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if horizontal, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-screen-position-get-orientation"/>xfce_screen_position_get_orientation()</title>
+<title><anchor id="xfce-screen-position-get-orientation" role="macro"/>xfce_screen_position_get_orientation()</title>
<indexterm><primary>xfce_screen_position_get_orientation</primary></indexterm><programlisting>#define xfce_screen_position_get_orientation(position)</programlisting>
<para>
</para>
@@ -194,7 +197,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-screen-position-is-floating"/>xfce_screen_position_is_floating()</title>
+<title><anchor id="xfce-screen-position-is-floating" role="macro"/>xfce_screen_position_is_floating()</title>
<indexterm><primary>xfce_screen_position_is_floating</primary></indexterm><programlisting>#define xfce_screen_position_is_floating(position)</programlisting>
<para>
</para>
@@ -204,11 +207,11 @@
<varlistentry><term><parameter>position</parameter> :</term>
<listitem><simpara> the <link linkend="XfceScreenPosition"><type>XfceScreenPosition</type></link>
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if floating, <literal>FALSE</literal> otherwise.
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if floating, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-screen-position-is-top"/>xfce_screen_position_is_top()</title>
+<title><anchor id="xfce-screen-position-is-top" role="macro"/>xfce_screen_position_is_top()</title>
<indexterm><primary>xfce_screen_position_is_top</primary></indexterm><programlisting>#define xfce_screen_position_is_top(position)</programlisting>
<para>
</para>
@@ -218,11 +221,11 @@
<varlistentry><term><parameter>position</parameter> :</term>
<listitem><simpara> the <link linkend="XfceScreenPosition"><type>XfceScreenPosition</type></link>
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if on the top of the screen, <literal>FALSE</literal> otherwise
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if on the top of the screen, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-screen-position-is-left"/>xfce_screen_position_is_left()</title>
+<title><anchor id="xfce-screen-position-is-left" role="macro"/>xfce_screen_position_is_left()</title>
<indexterm><primary>xfce_screen_position_is_left</primary></indexterm><programlisting>#define xfce_screen_position_is_left(position)</programlisting>
<para>
</para>
@@ -232,11 +235,11 @@
<varlistentry><term><parameter>position</parameter> :</term>
<listitem><simpara> the <link linkend="XfceScreenPosition"><type>XfceScreenPosition</type></link>
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if on the left of the screen, <literal>FALSE</literal> otherwise
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if on the left of the screen, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-screen-position-is-right"/>xfce_screen_position_is_right()</title>
+<title><anchor id="xfce-screen-position-is-right" role="macro"/>xfce_screen_position_is_right()</title>
<indexterm><primary>xfce_screen_position_is_right</primary></indexterm><programlisting>#define xfce_screen_position_is_right(position)</programlisting>
<para>
</para>
@@ -246,11 +249,11 @@
<varlistentry><term><parameter>position</parameter> :</term>
<listitem><simpara> the <link linkend="XfceScreenPosition"><type>XfceScreenPosition</type></link>
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if on the right of the screen, <literal>FALSE</literal> otherwise
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if on the right of the screen, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-screen-position-is-bottom"/>xfce_screen_position_is_bottom()</title>
+<title><anchor id="xfce-screen-position-is-bottom" role="macro"/>xfce_screen_position_is_bottom()</title>
<indexterm><primary>xfce_screen_position_is_bottom</primary></indexterm><programlisting>#define xfce_screen_position_is_bottom(position)</programlisting>
<para>
</para>
@@ -260,7 +263,7 @@
<varlistentry><term><parameter>position</parameter> :</term>
<listitem><simpara> the <link linkend="XfceScreenPosition"><type>XfceScreenPosition</type></link>
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if on the bottom of the screen, <literal>FALSE</literal> otherwise
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if on the bottom of the screen, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
Modified: xfce4-panel/trunk/docs/API/xml/xfce-panel-external-plugin.xml
===================================================================
--- xfce4-panel/trunk/docs/API/xml/xfce-panel-external-plugin.xml 2006-12-07 21:14:14 UTC (rev 24057)
+++ xfce4-panel/trunk/docs/API/xml/xfce-panel-external-plugin.xml 2006-12-07 21:31:36 UTC (rev 24058)
@@ -3,18 +3,21 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="XfceExternalPanelPlugin">
<refmeta>
-<refentrytitle>XfceExternalPanelPlugin</refentrytitle>
+<refentrytitle role="top_of_page">XfceExternalPanelPlugin</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
-<refname>XfceExternalPanelPlugin</refname><refpurpose><para>
+<refname>XfceExternalPanelPlugin</refname>
+<refpurpose><para>
External plugin widget.
</para></refpurpose>
+<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
-<refsynopsisdiv><title>Synopsis</title>
+<refsynopsisdiv role="synopsis">
+<title role="synopsis.title">Synopsis</title>
<synopsis>
@@ -28,8 +31,8 @@
</synopsis>
</refsynopsisdiv>
-<refsect1>
-<title>Object Hierarchy</title>
+<refsect1 role="object_hierarchy">
+<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
@@ -47,8 +50,8 @@
-<refsect1>
-<title>Implemented Interfaces</title>
+<refsect1 role="impl_interfaces">
+<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
XfceExternalPanelPlugin implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="XfcePanelPlugin">XfcePanelPlugin</link>.</para>
@@ -59,26 +62,26 @@
-<refsect1>
-<title>Description</title>
+<refsect1 role="desc">
+<title role="desc.title">Description</title>
<para>
Implements the <link linkend="XfcePanelPlugin">Panel Plugin interface</link>
for external plugins.
</para>
</refsect1>
-<refsect1>
-<title>Details</title>
+<refsect1 role="details">
+<title role="details.title">Details</title>
<refsect2>
-<title><anchor id="XfceExternalPanelPlugin-struct"/>XfceExternalPanelPlugin</title>
+<title><anchor id="XfceExternalPanelPlugin-struct" role="struct"/>XfceExternalPanelPlugin</title>
<indexterm><primary>XfceExternalPanelPlugin</primary></indexterm><programlisting>typedef struct _XfceExternalPanelPlugin XfceExternalPanelPlugin;</programlisting>
<para>
-The <link linkend="XfceExternalPanelPlugin-struct"><type>XfceExternalPanelPlugin-struct</type></link> struct contains private data only, and
+The <link linkend="XfceExternalPanelPlugin-struct"><type>XfceExternalPanelPlugin</type></link> struct contains private data only, and
should be accessed using the functions for the
<link linkend="XfcePanelPlugin">XfcePanelPlugin Interface</link>.
</para></refsect2>
<refsect2>
-<title><anchor id="xfce-external-panel-plugin-new"/>xfce_external_panel_plugin_new ()</title>
+<title><anchor id="xfce-external-panel-plugin-new" role="function"/>xfce_external_panel_plugin_new ()</title>
<indexterm><primary>xfce_external_panel_plugin_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* xfce_external_panel_plugin_new (<link linkend="int">int</link> argc,
<link linkend="char">char</link> **argv,
<link linkend="XfcePanelPluginFunc">XfcePanelPluginFunc</link> construct);</programlisting>
Modified: xfce4-panel/trunk/docs/API/xml/xfce-panel-internal-plugin.xml
===================================================================
--- xfce4-panel/trunk/docs/API/xml/xfce-panel-internal-plugin.xml 2006-12-07 21:14:14 UTC (rev 24057)
+++ xfce4-panel/trunk/docs/API/xml/xfce-panel-internal-plugin.xml 2006-12-07 21:31:36 UTC (rev 24058)
@@ -3,18 +3,21 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="XfceInternalPanelPlugin">
<refmeta>
-<refentrytitle>XfceInternalPanelPlugin</refentrytitle>
+<refentrytitle role="top_of_page">XfceInternalPanelPlugin</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
-<refname>XfceInternalPanelPlugin</refname><refpurpose><para>
+<refname>XfceInternalPanelPlugin</refname>
+<refpurpose><para>
Internal panel plugin.
</para></refpurpose>
+<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
-<refsynopsisdiv><title>Synopsis</title>
+<refsynopsisdiv role="synopsis">
+<title role="synopsis.title">Synopsis</title>
<synopsis>
@@ -31,8 +34,8 @@
</synopsis>
</refsynopsisdiv>
-<refsect1>
-<title>Object Hierarchy</title>
+<refsect1 role="object_hierarchy">
+<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
@@ -49,8 +52,8 @@
-<refsect1>
-<title>Implemented Interfaces</title>
+<refsect1 role="impl_interfaces">
+<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
XfceInternalPanelPlugin implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="XfcePanelPlugin">XfcePanelPlugin</link> and <link linkend="XfcePanelItem">XfcePanelItem</link>.</para>
@@ -61,26 +64,26 @@
-<refsect1>
-<title>Description</title>
+<refsect1 role="desc">
+<title role="desc.title">Description</title>
<para>
Implements the <link linkend="XfcePanelPlugin">Panel Plugin interface</link>
for internal plugins (loadable modules).
</para>
</refsect1>
-<refsect1>
-<title>Details</title>
+<refsect1 role="details">
+<title role="details.title">Details</title>
<refsect2>
-<title><anchor id="XfceInternalPanelPlugin-struct"/>XfceInternalPanelPlugin</title>
+<title><anchor id="XfceInternalPanelPlugin-struct" role="struct"/>XfceInternalPanelPlugin</title>
<indexterm><primary>XfceInternalPanelPlugin</primary></indexterm><programlisting>typedef struct _XfceInternalPanelPlugin XfceInternalPanelPlugin;</programlisting>
<para>
-The <link linkend="XfceInternalPanelPlugin-struct"><type>XfceInternalPanelPlugin-struct</type></link> struct contains private data only, and
+The <link linkend="XfceInternalPanelPlugin-struct"><type>XfceInternalPanelPlugin</type></link> struct contains private data only, and
should be accessed using the functions for the
<link linkend="XfcePanelPlugin">XfcePanelPlugin Interface</link>.
</para></refsect2>
<refsect2>
-<title><anchor id="xfce-internal-panel-plugin-new"/>xfce_internal_panel_plugin_new ()</title>
+<title><anchor id="xfce-internal-panel-plugin-new" role="function"/>xfce_internal_panel_plugin_new ()</title>
<indexterm><primary>xfce_internal_panel_plugin_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* xfce_internal_panel_plugin_new (const <link linkend="char">char</link> *name,
const <link linkend="char">char</link> *id,
const <link linkend="char">char</link> *display_name,
Modified: xfce4-panel/trunk/docs/API/xml/xfce-panel-plugin-iface.xml
===================================================================
--- xfce4-panel/trunk/docs/API/xml/xfce-panel-plugin-iface.xml 2006-12-07 21:14:14 UTC (rev 24057)
+++ xfce4-panel/trunk/docs/API/xml/xfce-panel-plugin-iface.xml 2006-12-07 21:31:36 UTC (rev 24058)
@@ -3,18 +3,21 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="XfcePanelPlugin">
<refmeta>
-<refentrytitle>XfcePanelPlugin</refentrytitle>
+<refentrytitle role="top_of_page">XfcePanelPlugin</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
-<refname>XfcePanelPlugin</refname><refpurpose><para>
+<refname>XfcePanelPlugin</refname>
+<refpurpose><para>
Panel plugin interface.
</para></refpurpose>
+<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
-<refsynopsisdiv><title>Synopsis</title>
+<refsynopsisdiv role="synopsis">
+<title role="synopsis.title">Synopsis</title>
<synopsis>
@@ -56,8 +59,8 @@
</synopsis>
</refsynopsisdiv>
-<refsect1>
-<title>Object Hierarchy</title>
+<refsect1 role="object_hierarchy">
+<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GInterface">GInterface</link>
@@ -66,8 +69,8 @@
</refsect1>
-<refsect1>
-<title>Prerequisites</title>
+<refsect1 role="prerequisites">
+<title role="prerequisites.title">Prerequisites</title>
<para>
XfcePanelPlugin requires
<link linkend="GtkContainer">GtkContainer</link>.</para>
@@ -76,16 +79,16 @@
-<refsect1>
-<title>Known Implementations</title>
+<refsect1 role="implementations">
+<title role="implementations.title">Known Implementations</title>
<para>
XfcePanelPlugin is implemented by
<link linkend="XfceExternalPanelPlugin">XfceExternalPanelPlugin</link> and <link linkend="XfceInternalPanelPlugin">XfceInternalPanelPlugin</link>.</para>
</refsect1>
-<refsect1>
-<title>Properties</title>
+<refsect1 role="properties">
+<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="XfcePanelPlugin--display-name">display-name</link>" <link linkend="gchararray">gchararray</link> : Read
@@ -97,37 +100,37 @@
</synopsis>
</refsect1>
-<refsect1>
-<title>Signal Prototypes</title>
+<refsect1 role="signal_proto">
+<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="XfcePanelPlugin-about">about</link>" <link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="gpointer">gpointer</link> user_data);
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks
"<link linkend="XfcePanelPlugin-configure-plugin">configure-plugin</link>"
<link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="gpointer">gpointer</link> user_data);
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks
"<link linkend="XfcePanelPlugin-free-data">free-data</link>" <link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="gpointer">gpointer</link> user_data);
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks
"<link linkend="XfcePanelPlugin-orientation-changed">orientation-changed</link>"
<link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="GtkOrientation">GtkOrientation</link> orientation,
- <link linkend="gpointer">gpointer</link> user_data);
+ <link linkend="GtkOrientation">GtkOrientation</link> *orientation,
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks
"<link linkend="XfcePanelPlugin-save">save</link>" <link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="gpointer">gpointer</link> user_data);
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks
"<link linkend="XfcePanelPlugin-screen-position-changed">screen-position-changed</link>"
- <link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="XfceScreenPosition">XfceScreenPosition</link> position,
- <link linkend="gpointer">gpointer</link> user_data);
+ <link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
+ <link linkend="XfceScreenPosition">XfceScreenPosition</link> *position,
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks
"<link linkend="XfcePanelPlugin-size-changed">size-changed</link>"
<link linkend="gboolean">gboolean</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="gint">gint</link> size,
- <link linkend="gpointer">gpointer</link> user_data);
+ <link linkend="gint">gint</link> size,
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks
</synopsis>
</refsect1>
-<refsect1>
-<title>Description</title>
+<refsect1 role="desc">
+<title role="desc.title">Description</title>
<para>
The interface implemented by both internal and external plugins. Plugin
writers may use the functions described below to interact with the plugin
@@ -135,17 +138,17 @@
</para>
</refsect1>
-<refsect1>
-<title>Details</title>
+<refsect1 role="details">
+<title role="details.title">Details</title>
<refsect2>
-<title><anchor id="XfcePanelPlugin-struct"/>XfcePanelPlugin</title>
+<title><anchor id="XfcePanelPlugin-struct" role="struct"/>XfcePanelPlugin</title>
<indexterm><primary>XfcePanelPlugin</primary></indexterm><programlisting>typedef struct _XfcePanelPlugin XfcePanelPlugin;</programlisting>
<para>
-The <link linkend="XfcePanelPlugin-struct"><type>XfcePanelPlugin-struct</type></link> is a purely virtual object to describe an instance
+The <link linkend="XfcePanelPlugin-struct"><type>XfcePanelPlugin</type></link> is a purely virtual object to describe an instance
of a widget implementing the panel plugin interface.
</para></refsect2>
<refsect2>
-<title><anchor id="XfcePanelPluginFunc"/>XfcePanelPluginFunc ()</title>
+<title><anchor id="XfcePanelPluginFunc" role="function"/>XfcePanelPluginFunc ()</title>
<indexterm><primary>XfcePanelPluginFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*XfcePanelPluginFunc) (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
Callback function to create the plugin contents. It should be given as
@@ -162,7 +165,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-get-name"/>xfce_panel_plugin_get_name ()</title>
+<title><anchor id="xfce-panel-plugin-get-name" role="function"/>xfce_panel_plugin_get_name ()</title>
<indexterm><primary>xfce_panel_plugin_get_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* xfce_panel_plugin_get_name (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
The plugin name identifies a plugin type and therefore must be unique.</para>
@@ -176,7 +179,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-get-id"/>xfce_panel_plugin_get_id ()</title>
+<title><anchor id="xfce-panel-plugin-get-id" role="function"/>xfce_panel_plugin_get_id ()</title>
<indexterm><primary>xfce_panel_plugin_get_id</primary></indexterm><programlisting>const <link linkend="char">char</link>* xfce_panel_plugin_get_id (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
The plugin id is a unique identifier string that is given to every instance
@@ -191,7 +194,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-get-display-name"/>xfce_panel_plugin_get_display_name ()</title>
+<title><anchor id="xfce-panel-plugin-get-display-name" role="function"/>xfce_panel_plugin_get_display_name ()</title>
<indexterm><primary>xfce_panel_plugin_get_display_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* xfce_panel_plugin_get_display_name
(<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
@@ -207,7 +210,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-get-size"/>xfce_panel_plugin_get_size ()</title>
+<title><anchor id="xfce-panel-plugin-get-size" role="function"/>xfce_panel_plugin_get_size ()</title>
<indexterm><primary>xfce_panel_plugin_get_size</primary></indexterm><programlisting><link linkend="int">int</link> xfce_panel_plugin_get_size (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
</para>
@@ -221,7 +224,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-get-screen-position"/>xfce_panel_plugin_get_screen_position ()</title>
+<title><anchor id="xfce-panel-plugin-get-screen-position" role="function"/>xfce_panel_plugin_get_screen_position ()</title>
<indexterm><primary>xfce_panel_plugin_get_screen_position</primary></indexterm><programlisting><link linkend="XfceScreenPosition">XfceScreenPosition</link> xfce_panel_plugin_get_screen_position
(<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
@@ -236,7 +239,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-set-expand"/>xfce_panel_plugin_set_expand ()</title>
+<title><anchor id="xfce-panel-plugin-set-expand" role="function"/>xfce_panel_plugin_set_expand ()</title>
<indexterm><primary>xfce_panel_plugin_set_expand</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_plugin_set_expand (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
<link linkend="gboolean">gboolean</link> expand);</programlisting>
<para>
@@ -252,7 +255,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-get-expand"/>xfce_panel_plugin_get_expand ()</title>
+<title><anchor id="xfce-panel-plugin-get-expand" role="function"/>xfce_panel_plugin_get_expand ()</title>
<indexterm><primary>xfce_panel_plugin_get_expand</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> xfce_panel_plugin_get_expand (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
</para>
@@ -266,7 +269,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-get-orientation"/>xfce_panel_plugin_get_orientation ()</title>
+<title><anchor id="xfce-panel-plugin-get-orientation" role="function"/>xfce_panel_plugin_get_orientation ()</title>
<indexterm><primary>xfce_panel_plugin_get_orientation</primary></indexterm><programlisting><link linkend="GtkOrientation">GtkOrientation</link> xfce_panel_plugin_get_orientation
(<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
@@ -281,7 +284,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-add-action-widget"/>xfce_panel_plugin_add_action_widget ()</title>
+<title><anchor id="xfce-panel-plugin-add-action-widget" role="function"/>xfce_panel_plugin_add_action_widget ()</title>
<indexterm><primary>xfce_panel_plugin_add_action_widget</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_plugin_add_action_widget
(<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
@@ -301,7 +304,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-menu-insert-item"/>xfce_panel_plugin_menu_insert_item ()</title>
+<title><anchor id="xfce-panel-plugin-menu-insert-item" role="function"/>xfce_panel_plugin_menu_insert_item ()</title>
<indexterm><primary>xfce_panel_plugin_menu_insert_item</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_plugin_menu_insert_item
(<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
<link linkend="GtkMenuItem">GtkMenuItem</link> *item);</programlisting>
@@ -318,7 +321,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-menu-show-about"/>xfce_panel_plugin_menu_show_about ()</title>
+<title><anchor id="xfce-panel-plugin-menu-show-about" role="function"/>xfce_panel_plugin_menu_show_about ()</title>
<indexterm><primary>xfce_panel_plugin_menu_show_about</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_plugin_menu_show_about
(<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
@@ -332,7 +335,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-menu-show-configure"/>xfce_panel_plugin_menu_show_configure ()</title>
+<title><anchor id="xfce-panel-plugin-menu-show-configure" role="function"/>xfce_panel_plugin_menu_show_configure ()</title>
<indexterm><primary>xfce_panel_plugin_menu_show_configure</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_plugin_menu_show_configure
(<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
@@ -346,7 +349,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-block-menu"/>xfce_panel_plugin_block_menu ()</title>
+<title><anchor id="xfce-panel-plugin-block-menu" role="function"/>xfce_panel_plugin_block_menu ()</title>
<indexterm><primary>xfce_panel_plugin_block_menu</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_plugin_block_menu (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
Temporarily block the menu from being shown. This can be used by plugin
@@ -362,7 +365,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-unblock-menu"/>xfce_panel_plugin_unblock_menu ()</title>
+<title><anchor id="xfce-panel-plugin-unblock-menu" role="function"/>xfce_panel_plugin_unblock_menu ()</title>
<indexterm><primary>xfce_panel_plugin_unblock_menu</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_plugin_unblock_menu (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
Don't block the menu from being shown.
@@ -377,7 +380,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-register-menu"/>xfce_panel_plugin_register_menu ()</title>
+<title><anchor id="xfce-panel-plugin-register-menu" role="function"/>xfce_panel_plugin_register_menu ()</title>
<indexterm><primary>xfce_panel_plugin_register_menu</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_plugin_register_menu (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
<link linkend="GtkMenu">GtkMenu</link> *menu);</programlisting>
<para>
@@ -394,7 +397,7 @@
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-lookup-rc-file"/>xfce_panel_plugin_lookup_rc_file ()</title>
+<title><anchor id="xfce-panel-plugin-lookup-rc-file" role="function"/>xfce_panel_plugin_lookup_rc_file ()</title>
<indexterm><primary>xfce_panel_plugin_lookup_rc_file</primary></indexterm><programlisting><link linkend="char">char</link>* xfce_panel_plugin_lookup_rc_file
(<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
<para>
@@ -406,14 +409,14 @@
<varlistentry><term><parameter>plugin</parameter> :</term>
<listitem><simpara> an <link linkend="XfcePanelPlugin"><type>XfcePanelPlugin</type></link>
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> path to configuration file or <literal>NULL</literal> if none was found. The
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> path to configuration file or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none was found. The
returned string must be freed using <link linkend="g-free"><function>g_free()</function></link>.
See also: <link linkend="xfce-panel-plugin-save-location"><function>xfce_panel_plugin_save_location()</function></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
-<title><anchor id="xfce-panel-plugin-save-location"/>xfce_panel_plugin_save_location ()</title>
+<title><anchor id="xfce-panel-plugin-save-location" role="function"/>xfce_panel_plugin_save_location ()</title>
<indexterm><primary>xfce_panel_plugin_save_location</primary></indexterm><programlisting><link linkend="char">char</link>* xfce_panel_plugin_save_location (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
<link linkend="gboolean">gboolean</link> create);</programlisting>
<para>
@@ -428,7 +431,7 @@
<varlistentry><term><parameter>create</parameter> :</term>
<listitem><simpara> whether the file should be created
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> path to configuration file or <literal>NULL</literal> is the file could not be
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> path to configuration file or <link linkend="NULL:CAPS"><literal>NULL</literal></link> is the file could not be
created. The returned string must be freed using <link linkend="g-free"><function>g_free()</function></link>.
See also: <link linkend="xfce-panel-plugin-lookup-rc-file"><function>xfce_panel_plugin_lookup_rc_file()</function></link>
@@ -436,10 +439,10 @@
</variablelist></refsect2>
</refsect1>
-<refsect1>
-<title>Properties</title>
+<refsect1 role="property_details">
+<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="XfcePanelPlugin--display-name"/>The "<literal>display-name</literal>" property</title>
-<programlisting> "display-name" <link linkend="gchararray">gchararray</link> : Read</programlisting>
+<indexterm><primary>XfcePanelPlugin:display-name</primary></indexterm><programlisting> "display-name" <link linkend="gchararray">gchararray</link> : Read</programlisting>
<para>
Translated plugin name. This is the name that can be presented to
the user, e.g. in dialogs or menus.</para>
@@ -448,7 +451,7 @@
</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="XfcePanelPlugin--expand"/>The "<literal>expand</literal>" property</title>
-<programlisting> "expand" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
+<indexterm><primary>XfcePanelPlugin:expand</primary></indexterm><programlisting> "expand" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>
Whether to expand the plugin when the panel width increases.</para>
<para>
@@ -456,7 +459,7 @@
</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="XfcePanelPlugin--id"/>The "<literal>id</literal>" property</title>
-<programlisting> "id" <link linkend="gchararray">gchararray</link> : Read</programlisting>
+<indexterm><primary>XfcePanelPlugin:id</primary></indexterm><programlisting> "id" <link linkend="gchararray">gchararray</link> : Read</programlisting>
<para>
Unique identifier string created for every <link linkend="XfcePanelPlugin"><type>XfcePanelPlugin</type></link> instance.</para>
<para>
@@ -464,7 +467,7 @@
</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="XfcePanelPlugin--name"/>The "<literal>name</literal>" property</title>
-<programlisting> "name" <link linkend="gchararray">gchararray</link> : Read</programlisting>
+<indexterm><primary>XfcePanelPlugin:name</primary></indexterm><programlisting> "name" <link linkend="gchararray">gchararray</link> : Read</programlisting>
<para>
Untranslated plugin name. This identifies the plugin type and
therefore has to be unique.</para>
@@ -473,7 +476,7 @@
</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="XfcePanelPlugin--screen-position"/>The "<literal>screen-position</literal>" property</title>
-<programlisting> "screen-position" <link linkend="XfceScreenPosition">XfceScreenPosition</link> : Read</programlisting>
+<indexterm><primary>XfcePanelPlugin:screen-position</primary></indexterm><programlisting> "screen-position" <link linkend="XfceScreenPosition">XfceScreenPosition</link> : Read</programlisting>
<para>
The current <link linkend="XfceScreenPosition"><type>XfceScreenPosition</type></link> of the panel.</para>
<para>
@@ -481,7 +484,7 @@
</para><para>Default value: XFCE_SCREEN_POSITION_S</para>
</refsect2>
<refsect2><title><anchor id="XfcePanelPlugin--size"/>The "<literal>size</literal>" property</title>
-<programlisting> "size" <link linkend="gint">gint</link> : Read</programlisting>
+<indexterm><primary>XfcePanelPlugin:size</primary></indexterm><programlisting> "size" <link linkend="gint">gint</link> : Read</programlisting>
<para>
The current panel size.</para>
<para>
@@ -492,11 +495,11 @@
</refsect1>
-<refsect1>
-<title>Signals</title>
+<refsect1 role="signals">
+<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="XfcePanelPlugin-about"/>The "about" signal</title>
-<programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="gpointer">gpointer</link> user_data);</programlisting>
+<indexterm><primary>XfcePanelPlugin::about</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks</programlisting>
<para>
Emitted when the 'About' menu item is clicked. Plugin writers
should connect to this signal to show information about their
@@ -513,8 +516,8 @@
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-configure-plugin"/>The "configure-plugin" signal</title>
-<programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="gpointer">gpointer</link> user_data);</programlisting>
+<indexterm><primary>XfcePanelPlugin::configure-plugin</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks</programlisting>
<para>
Emitted when the 'Configure' menu item is clicked. Plugin writers
should connect to this signal to show a settings dialog.
@@ -530,14 +533,14 @@
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-free-data"/>The "free-data" signal</title>
-<programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="gpointer">gpointer</link> user_data);</programlisting>
+<indexterm><primary>XfcePanelPlugin::free-data</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks</programlisting>
<para>
Emitted when the panel is closing. Plugin writers should connect to
this signal to free any allocated resources.
</para>
<para>
-See also: <link linkend="XfcePanelPlugin"><type>XfcePanelPlugin</type></link>::save</para>
+See also: <link linkend="XfcePanelPlugin-save"><type>XfcePanelPlugin::save</type></link></para>
<para>
</para><variablelist role="params">
@@ -547,9 +550,9 @@
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-orientation-changed"/>The "orientation-changed" signal</title>
-<programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="GtkOrientation">GtkOrientation</link> orientation,
- <link linkend="gpointer">gpointer</link> user_data);</programlisting>
+<indexterm><primary>XfcePanelPlugin::orientation-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
+ <link linkend="GtkOrientation">GtkOrientation</link> *orientation,
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks</programlisting>
<para>
Emitted when the panel orientation changes.</para>
<para>
@@ -564,8 +567,8 @@
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-save"/>The "save" signal</title>
-<programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="gpointer">gpointer</link> user_data);</programlisting>
+<indexterm><primary>XfcePanelPlugin::save</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks</programlisting>
<para>
Emitted before the panel is closing. May be called more than once
while the panel is running. Plugin writers should connect to
@@ -582,9 +585,9 @@
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-screen-position-changed"/>The "screen-position-changed" signal</title>
-<programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="XfceScreenPosition">XfceScreenPosition</link> position,
- <link linkend="gpointer">gpointer</link> user_data);</programlisting>
+<indexterm><primary>XfcePanelPlugin::screen-position-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
+ <link linkend="XfceScreenPosition">XfceScreenPosition</link> *position,
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks</programlisting>
<para>
Emitted when the screen position changes. Most plugins will be
more interested in the "orientation-changed" signal.</para>
@@ -600,9 +603,9 @@
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-size-changed"/>The "size-changed" signal</title>
-<programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
- <link linkend="gint">gint</link> size,
- <link linkend="gpointer">gpointer</link> user_data);</programlisting>
+<indexterm><primary>XfcePanelPlugin::size-changed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
+ <link linkend="gint">gint</link> size,
+ <link linkend="gpointer">gpointer</link> user_data) : Run last / No recursion / No hooks</programlisting>
<para>
Emitted when the panel size changes.</para>
<para>
@@ -616,7 +619,7 @@
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> when handled, <literal>FALSE</literal> otherwise.
+<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> when handled, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
Modified: xfce4-panel/trunk/docs/API/xml/xfce-panel-plugin.xml
===================================================================
--- xfce4-panel/trunk/docs/API/xml/xfce-panel-plugin.xml 2006-12-07 21:14:14 UTC (rev 24057)
+++ xfce4-panel/trunk/docs/API/xml/xfce-panel-plugin.xml 2006-12-07 21:31:36 UTC (rev 24058)
@@ -3,18 +3,21 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libxfce4panel-Writing-Plugins">
<refmeta>
-<refentrytitle>Writing Plugins</refentrytitle>
+<refentrytitle role="top_of_page">Writing Plugins</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
-<refname>Writing Plugins</refname><refpurpose><para>
+<refname>Writing Plugins</refname>
+<refpurpose><para>
Information for plugin writers
</para></refpurpose>
+<!--[<xref linkend=&