summaryrefslogtreecommitdiff
path: root/docs/API/xml/xfce-panel-convenience.xml
blob: a96f3980dc9ebe7833fd05b6461d108e8338cb0c (plain)
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
<?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-Convenience-Functions">
<refmeta>
<refentrytitle>Convenience Functions</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>Convenience Functions</refname><refpurpose><para>
Special purpose widgets and utilities.
</para></refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="xfce-create-panel-button">xfce_create_panel_button</link>        (void);
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="xfce-create-panel-toggle-button">xfce_create_panel_toggle_button</link> (void);
</synopsis>
</refsynopsisdiv>









<refsect1>
<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>
<refsect2>
<title><anchor id="xfce-create-panel-button"/>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>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> newly created <link linkend="GtkToggleButton"><type>GtkToggleButton</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-create-panel-toggle-button"/>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>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>