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
|
<refentry id="GtkCheckButton">
<refmeta>
<refentrytitle role="top_of_page">GtkCheckButton</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkCheckButton</refname>
<refpurpose>Create widgets with a discrete toggle button</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <gtk/gtk.h>
<link linkend="GtkCheckButton-struct">GtkCheckButton</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gtk-check-button-new">gtk_check_button_new</link> (void);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gtk-check-button-new-with-label">gtk_check_button_new_with_label</link> (const <link linkend="gchar">gchar</link> *label);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gtk-check-button-new-with-mnemonic">gtk_check_button_new_with_mnemonic</link> (const <link linkend="gchar">gchar</link> *label);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.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>
+----GtkCheckButton
+----<link linkend="GtkRadioButton">GtkRadioButton</link>
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkCheckButton implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
</refsect1>
<refsect1 role="style_properties">
<title role="style_properties.title">Style Properties</title>
<synopsis>
<link linkend="GtkCheckButton--indicator-size">indicator-size</link> <link linkend="gint">gint</link> : Read
<link linkend="GtkCheckButton--indicator-spacing">indicator-spacing</link> <link linkend="gint">gint</link> : Read
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
A <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link> places a discrete <link linkend="GtkToggleButton"><type>GtkToggleButton</type></link> next to a widget, (usually a <link linkend="GtkLabel"><type>GtkLabel</type></link>). See the section on <link linkend="GtkToggleButton"><type>GtkToggleButton</type></link> widgets for more information about toggle/check buttons.
</para>
<para>
The important signal ('toggled') is also inherited from <link linkend="GtkToggleButton"><type>GtkToggleButton</type></link>.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GtkCheckButton-struct" role="struct"/>GtkCheckButton</title>
<indexterm><primary>GtkCheckButton</primary></indexterm><programlisting>typedef struct _GtkCheckButton GtkCheckButton;</programlisting>
<para>
<structfield>toggle_button</structfield> is a <link linkend="GtkToggleButton"><type>GtkToggleButton</type></link> representing the actual toggle button that composes the check button.
</para></refsect2>
<refsect2>
<title><anchor id="gtk-check-button-new" role="function"/>gtk_check_button_new ()</title>
<indexterm><primary>gtk_check_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_check_button_new (void);</programlisting>
<para>
Creates a new <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link>.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a <link linkend="GtkWidget"><type>GtkWidget</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gtk-check-button-new-with-label" role="function"/>gtk_check_button_new_with_label ()</title>
<indexterm><primary>gtk_check_button_new_with_label</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_check_button_new_with_label (const <link linkend="gchar">gchar</link> *label);</programlisting>
<para>
Creates a new <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link> with a <link linkend="GtkLabel"><type>GtkLabel</type></link> to the right of it.
</para><variablelist role="params">
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara>the text for the check button.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a <link linkend="GtkWidget"><type>GtkWidget</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gtk-check-button-new-with-mnemonic" role="function"/>gtk_check_button_new_with_mnemonic ()</title>
<indexterm><primary>gtk_check_button_new_with_mnemonic</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_check_button_new_with_mnemonic (const <link linkend="gchar">gchar</link> *label);</programlisting>
<para>
Creates a new <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link> containing a label. The label
will be created using <link linkend="gtk-label-new-with-mnemonic"><function>gtk_label_new_with_mnemonic()</function></link>, so underscores
in <parameter>label</parameter> indicate the mnemonic for the check button.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> The text of the button, with an underscore in front of the
mnemonic character
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="style_properties_details">
<title role="style_properties_details.title">Style Property Details</title>
<refsect2><title><anchor id="GtkCheckButton--indicator-size"/>The :<literal>indicator-size</literal> style property</title>
<indexterm><primary>GtkCheckButton:indicator-size</primary></indexterm><programlisting> indicator-size <link linkend="gint">gint</link> : Read</programlisting>
<para>Size of check or radio indicator.</para><para>Allowed values: >= 0</para>
<para>Default value: 13</para>
</refsect2>
<refsect2><title><anchor id="GtkCheckButton--indicator-spacing"/>The :<literal>indicator-spacing</literal> style property</title>
<indexterm><primary>GtkCheckButton:indicator-spacing</primary></indexterm><programlisting> indicator-spacing <link linkend="gint">gint</link> : Read</programlisting>
<para>Spacing around check or radio indicator.</para><para>Allowed values: >= 0</para>
<para>Default value: 2</para>
</refsect2>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<variablelist>
<varlistentry>
<term><link linkend="GtkCheckMenuItem"><type>GtkCheckMenuItem</type></link></term>
<listitem><para>add check buttons to your menus.</para></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GtkButton"><type>GtkButton</type></link></term>
<listitem><para>a more general button.</para></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GtkToggleButton"><type>GtkToggleButton</type></link></term>
<listitem><para><link linkend="GtkCheckButton"><type>GtkCheckButton</type></link>'s parent.</para></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GtkRadioButton"><type>GtkRadioButton</type></link></term>
<listitem><para>group check buttons together.</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>
|