1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="XfceInternalPanelPlugin">
<refmeta>
<refentrytitle>XfceInternalPanelPlugin</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>XfceInternalPanelPlugin</refname><refpurpose><para>
Internal panel plugin.
</para></refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="XfceInternalPanelPlugin-struct">XfceInternalPanelPlugin</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="xfce-internal-panel-plugin-new">xfce_internal_panel_plugin_new</link> (const <link linkend="char">char</link> *name,
const <link linkend="char">char</link> *id,
const <link linkend="char">char</link> *display_name,
<link linkend="int">int</link> size,
<link linkend="XfceScreenPosition">XfceScreenPosition</link> position,
<link linkend="XfcePanelPluginFunc">XfcePanelPluginFunc</link> construct);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBin">GtkBin</link>
+----<link linkend="GtkEventBox">GtkEventBox</link>
+----XfceInternalPanelPlugin
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
XfceInternalPanelPlugin implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="XfcePanelPlugin">XfcePanelPlugin</link> and <link linkend="XfcePanelItem">XfcePanelItem</link>.</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
Implements the <link linkend="XfcePanelPlugin">Panel Plugin interface</link>
for internal plugins (loadable modules).
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="XfceInternalPanelPlugin-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
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>
<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,
<link linkend="int">int</link> size,
<link linkend="XfceScreenPosition">XfceScreenPosition</link> position,
<link linkend="XfcePanelPluginFunc">XfcePanelPluginFunc</link> construct);</programlisting>
<para>
Creates a new internal plugin. This function should not be used directly,
but only throught the <link linkend="XFCE-PANEL-PLUGIN-REGISTER-INTERNAL:CAPS"><function>XFCE_PANEL_PLUGIN_REGISTER_INTERNAL()</function></link> macro.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> plugin name
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> unique identifier string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>display_name</parameter> :</term>
<listitem><simpara> translated plugin name
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> panel size
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>position</parameter> :</term>
<listitem><simpara> panel screen position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>construct</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelPluginFunc"><type>XfcePanelPluginFunc</type></link> that will be called to construct the
plugin widgets.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Newly created panel plugin widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|