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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
<?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="XfceArrowButton">
<refmeta>
<refentrytitle>XfceArrowButton</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>XfceArrowButton</refname><refpurpose><para>
Toggle button with arrow.
</para></refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="XfceArrowButton-struct">XfceArrowButton</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="xfce-arrow-button-new">xfce_arrow_button_new</link> (<link linkend="GtkArrowType">GtkArrowType</link> type);
<link linkend="void">void</link> <link linkend="xfce-arrow-button-set-arrow-type">xfce_arrow_button_set_arrow_type</link>
(<link linkend="XfceArrowButton">XfceArrowButton</link> *button,
<link linkend="GtkArrowType">GtkArrowType</link> type);
<link linkend="GtkArrowType">GtkArrowType</link> <link linkend="xfce-arrow-button-get-arrow-type">xfce_arrow_button_get_arrow_type</link>
(<link linkend="XfceArrowButton">XfceArrowButton</link> *button);
</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="GtkButton">GtkButton</link>
+----<link linkend="GtkToggleButton">GtkToggleButton</link>
+----XfceArrowButton
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
XfceArrowButton implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
</refsect1>
<refsect1>
<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>
<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);
</synopsis>
</refsect1>
<refsect1>
<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>
<refsect2>
<title><anchor id="XfceArrowButton-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
should be accessed using the functions below.
</para></refsect2>
<refsect2>
<title><anchor id="xfce-arrow-button-new"/>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>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> <link linkend="GtkArrowType"><type>GtkArrowType</type></link> for the arrow button
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> newly created <link linkend="XfceArrowButton"><type>XfceArrowButton</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-arrow-button-set-arrow-type"/>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>
<para>
Sets the arrow type for <parameter>button</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>button</parameter> :</term>
<listitem><simpara> an <link linkend="XfceArrowButton"><type>XfceArrowButton</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> new <link linkend="GtkArrowType"><type>GtkArrowType</type></link> to set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-arrow-button-get-arrow-type"/>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>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>button</parameter> :</term>
<listitem><simpara> an <link linkend="XfceArrowButton"><type>XfceArrowButton</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="GtkArrowType"><type>GtkArrowType</type></link> of <parameter>button</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1>
<title>Properties</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>
<para>
The arrow type of the button. This value also determines the direction
of the popup menu.</para>
<para>
</para><para>Default value: GTK_ARROW_UP</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</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>
<para>
Emitted when the arrow direction of the menu button changes.
This value also determines the direction of the popup menu.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>button</parameter> :</term>
<listitem><simpara> the object which emitted the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> the new <link linkend="GtkArrowType"><type>GtkArrowType</type></link> of the button
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<link linkend="GtkToggleButton"><type>GtkToggleButton</type></link>
</para>
</refsect1>
</refentry>
|
