File: xfce-panel-external-plugin.xml

package info (click to toggle)
xfce4-panel 4.3.99.2-2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 6,000 kB
  • ctags: 2,052
  • sloc: ansic: 17,370; sh: 8,587; xml: 2,908; makefile: 804
file content (110 lines) | stat: -rw-r--r-- 4,443 bytes parent folder | download
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
<?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="XfceExternalPanelPlugin">
<refmeta>
<refentrytitle>XfceExternalPanelPlugin</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>XfceExternalPanelPlugin</refname><refpurpose><para>
External plugin widget.
</para></refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



            <link linkend="XfceExternalPanelPlugin-struct">XfceExternalPanelPlugin</link>;
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="xfce-external-panel-plugin-new">xfce_external_panel_plugin_new</link>  (<link linkend="int">int</link> argc,
                                             <link linkend="char">char</link> **argv,
                                             <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="GtkWindow">GtkWindow</link>
                                       +----<link linkend="GtkPlug">GtkPlug</link>
                                             +----XfceExternalPanelPlugin
</synopsis>

</refsect1>



<refsect1>
<title>Implemented Interfaces</title>
<para>
XfceExternalPanelPlugin implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="XfcePanelPlugin">XfcePanelPlugin</link>.</para>

</refsect1>





<refsect1>
<title>Description</title>
<para>
Implements the <link linkend="XfcePanelPlugin">Panel Plugin interface</link>
for external plugins.
</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="XfceExternalPanelPlugin-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
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>
<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>
<para>
Creates a new external plugin. This function should not be used directly
but only through the <link linkend="XFCE-PANEL-PLUGIN-REGISTER-EXTERNAL:CAPS"><function>XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL()</function></link> macro.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>argc</parameter>&nbsp;:</term>
<listitem><simpara> number of arguments (from the plugins <link linkend="main"><function>main()</function></link> function)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argv</parameter>&nbsp;:</term>
<listitem><simpara> argument array (from the plugins <link linkend="main"><function>main()</function></link> function)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>construct</parameter>&nbsp;:</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>&nbsp;:</term><listitem><simpara> newly created panel plugin widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>