summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtktoolbutton.sgml
blob: 299e9c09dcae1e683e7dab4dc010d330e583c195 (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
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<!-- ##### SECTION Title ##### -->
GtkToolButton

<!-- ##### SECTION Short_Description ##### -->
A GtkToolItem subclass that displays buttons

<!-- ##### SECTION Long_Description ##### -->
<para>
#GtkToolButton<!-- -->s are #GtkToolItems containing buttons.
</para>

<para>
Use gtk_tool_button_new() to create a new #GtkToolButton. Use
gtk_tool_button_new_with_stock() to create a #GtkToolButton
containing a stock item.
</para>

<para>
The label of a #GtkToolButton is determined by the properties
"label_widget", "label", and "stock_id". If "label_widget" is
non-%NULL, then that widget is used as the label. Otherwise, if
"label" is non-%NULL, that string is used as the label. Otherwise, if
"stock_id" is non-%NULL, the label is determined by the stock
item. Otherwise, the button does not have a label.
</para>

<para>
The icon of a #GtkToolButton is determined by the properties
"icon_widget" and "stock_id". If "icon_widget" is non-%NULL, then
that widget is used as the icon. Otherwise, if "stock_id" is
non-%NULL, the icon is determined by the stock item. Otherwise,
the button does not have a label.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>

<varlistentry>
<term>#GtkToolbar</term>
<listitem><para>The toolbar widget</para></listitem>
</varlistentry>

<varlistentry>
<term>#GtkMenuToolButton</term>
<listitem><para>A subclass of #GtkToolButton that displays on 
    the toolbar a button with an additional dropdown
    menu</para></listitem>
</varlistentry>

<varlistentry>
<term>#GtkToggleToolButton</term>
<listitem><para>A subclass of #GtkToolButton that displays toggle
    buttons on the toolbar</para></listitem>
</varlistentry>

<varlistentry>
<term>#GtkRadioToolButton</term>
<listitem><para>A subclass of #GtkToolButton that displays radio
    buttons on the toolbar</para></listitem>
</varlistentry>

<varlistentry>
<term>#GtkSeparatorToolItem</term>
<listitem><para>A subclass of #GtkToolItem that separates groups of
    items on a toolbar</para></listitem>
</varlistentry>

</variablelist>
</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT GtkToolButton ##### -->
<para>
The #GtkToolButton struct contains only private. It should only be
accessed with the function described below.
</para>


<!-- ##### SIGNAL GtkToolButton::clicked ##### -->
<para>

</para>

@toolbutton: the object which received the signal.

<!-- ##### ARG GtkToolButton:icon-widget ##### -->
<para>

</para>

<!-- ##### ARG GtkToolButton:label ##### -->
<para>

</para>

<!-- ##### ARG GtkToolButton:label-widget ##### -->
<para>

</para>

<!-- ##### ARG GtkToolButton:stock-id ##### -->
<para>

</para>

<!-- ##### ARG GtkToolButton:use-underline ##### -->
<para>

</para>

<!-- ##### FUNCTION gtk_tool_button_new ##### -->
<para>

</para>

@icon_widget: 
@label: 
@Returns: 


<!-- ##### FUNCTION gtk_tool_button_new_from_stock ##### -->
<para>

</para>

@stock_id: 
@Returns: 


<!-- ##### FUNCTION gtk_tool_button_set_label ##### -->
<para>

</para>

@button: 
@label: 


<!-- ##### FUNCTION gtk_tool_button_get_label ##### -->
<para>

</para>

@button: 
@Returns: 


<!-- ##### FUNCTION gtk_tool_button_set_use_underline ##### -->
<para>

</para>

@button: 
@use_underline: 


<!-- ##### FUNCTION gtk_tool_button_get_use_underline ##### -->
<para>

</para>

@button: 
@Returns: 


<!-- ##### FUNCTION gtk_tool_button_set_stock_id ##### -->
<para>

</para>

@button: 
@stock_id: 


<!-- ##### FUNCTION gtk_tool_button_get_stock_id ##### -->
<para>

</para>

@button: 
@Returns: 


<!-- ##### FUNCTION gtk_tool_button_set_icon_widget ##### -->
<para>

</para>

@button: 
@icon_widget: 


<!-- ##### FUNCTION gtk_tool_button_get_icon_widget ##### -->
<para>

</para>

@button: 
@Returns: 


<!-- ##### FUNCTION gtk_tool_button_set_label_widget ##### -->
<para>

</para>

@button: 
@label_widget: 


<!-- ##### FUNCTION gtk_tool_button_get_label_widget ##### -->
<para>

</para>

@button: 
@Returns: