File: xfce-panel-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 (89 lines) | stat: -rw-r--r-- 2,944 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
<?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="libxfce4panel-Writing-Plugins">
<refmeta>
<refentrytitle>Writing Plugins</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>Writing Plugins</refname><refpurpose><para>
Information for plugin writers
</para></refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>

#include &lt;libxfce4panel/libxfce4panel&gt;


#define     <link linkend="XFCE-PANEL-PLUGIN-REGISTER-EXTERNAL:CAPS">XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL</link>(construct)
#define     <link linkend="XFCE-PANEL-PLUGIN-REGISTER-INTERNAL:CAPS">XFCE_PANEL_PLUGIN_REGISTER_INTERNAL</link>(construct)
</synopsis>
</refsynopsisdiv>









<refsect1>
<title>Description</title>
<para>
Macros to register a plugin with the Xfce Panel.
</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="XFCE-PANEL-PLUGIN-REGISTER-EXTERNAL:CAPS"/>XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL()</title>
<indexterm><primary>XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL</primary></indexterm><programlisting>#define     XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL(construct)</programlisting>
<para>
Registers and initializes the plugin. This is the only thing that is 
required to create a panel plugin.
</para>
<para>
See also: <link linkend="XfcePanelPlugin">Panel Plugin interface</link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>construct</parameter>&nbsp;:</term>
<listitem><simpara> name of a function that can be cast to an <link linkend="XfcePanelPluginFunc"><type>XfcePanelPluginFunc</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="XFCE-PANEL-PLUGIN-REGISTER-INTERNAL:CAPS"/>XFCE_PANEL_PLUGIN_REGISTER_INTERNAL()</title>
<indexterm><primary>XFCE_PANEL_PLUGIN_REGISTER_INTERNAL</primary></indexterm><programlisting>#define     XFCE_PANEL_PLUGIN_REGISTER_INTERNAL(construct)</programlisting>
<para>
Registers and initializes the plugin. This is the only thing that is 
required to create a panel plugin.
</para>
<para>
This macro is for plugins implemented as a loadable module. Generally it is
preferred to create an external plugin, for which you have to use
<link linkend="XFCE-PANEL-PLUGIN-REGISTER-EXTERNAL:CAPS"><function>XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL()</function></link> .
</para>
<para>
See also: <link linkend="XfcePanelPlugin">Panel Plugin interface</link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>construct</parameter>&nbsp;:</term>
<listitem><simpara> name of a function that can be cast to an <link linkend="XfcePanelPluginFunc"><type>XfcePanelPluginFunc</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>