blob: d333aa4e3d61eae7a1a570c3d472049e160231cf (
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
|
<?xml version="1.0" standalone="no"?>
<!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="class-gtktoolshell">
<refnamediv>
<refname>gtk.ToolShell</refname>
<refpurpose>Interface for containers containing GtkToolItem widgets.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.ToolShell</classname></ooclass>
<ooclass><classname><link linkend="class-ginterface">gobject.GInterface</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktoolshell--get-icon-size">get_icon_size</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktoolshell--get-orientation">get_orientation</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktoolshell--get-relief-style">get_relief_style</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktoolshell--get-style">get_style</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktoolshell--rebuild-menu">rebuild_menu</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-ginterface">gobject.GInterface</link>
+-- <link linkend="class-gtktoolshell">gtk.ToolShell</link>
</synopsis>
</refsect1>
<refsect1>
<title>Known Implementation</title>
<para>
<link linkend="class-gtktoolshell"><classname>gtk.ToolShell</classname></link>
is implementated by
<link linkend="class-gtktoolbar"><classname>gtk.ToolBar</classname></link>,
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
The <link linkend="class-gtktoolshell"><classname>gtk.ToolShell</classname></link>
interface allows container widgets to provide additional information when embedding GtkToolItem widgets.
see_also: <link linkend="class-gtktoolbar"><classname>gtk.ToolBar</classname></link>,
<link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtktoolshell--get-icon-size">
<title>gtk.ToolShell.get_icon_size</title>
<programlisting><methodsynopsis language="python">
<methodname>get_icon_size</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The current size for icons of shell.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_icon_size</methodname>() method retrieves the
icon size for the tool shell. Tool items must not call this
function directly, but rely on
<methodname><link linkend="method-gtktoolitem--get-icon-size">gtk.ToolItem.get_icon_size</link></methodname>()
instead.
</para>
</refsect2>
<refsect2 id="method-gtktoolshell--get-orientation">
<title>gtk.ToolShell.get_orientation</title>
<programlisting><methodsynopsis language="python">
<methodname>get_orientation</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The current orientation of shell.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_orientation</methodname>() method retrieves the
current orientation for the tool shell. Tool items must not call
this function directly, but rely on
<methodname><link linkend="method-gtktoolitem--get-orientation">gtk.ToolItem.get_orientation</link></methodname>()
instead.
</para>
</refsect2>
<refsect2 id="method-gtktoolshell--get-relief-style">
<title>gtk.ToolShell.get_relief_style</title>
<programlisting><methodsynopsis language="python">
<methodname>get_relief_style</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The relief style of buttons on shell.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_relief_style</methodname>() method returns the relief
style of buttons on shell. Tool items must not call this function directly, but rely on
<methodname><link linkend="method-gtktoolitem--get-relief-style">gtk.ToolItem.get_relief_style</link></methodname>()
instead.
</para>
</refsect2>
<refsect2 id="method-gtktoolshell--get-style">
<title>gtk.ToolShell.get_style</title>
<programlisting><methodsynopsis language="python">
<methodname>get_style</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The current style of shell.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_style</methodname>() method retrieves whether the tool
shell has text, icons, or both. Tool items must not call this function directly, but rely on
<methodname><link linkend="method-gtktoolitem--get-style">gtk.ToolItem.get_style</link></methodname>()
instead.
</para>
</refsect2>
<refsect2 id="method-gtktoolshell--rebuild-menu">
<title>gtk.ToolShell.rebuild_menu</title>
<programlisting><methodsynopsis language="python">
<methodname>rebuild_menu</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem>
</listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>rebuild_menu</methodname>() method calling this function signals the
tool shell that the overflow menu item for tool items have changed.
If there is an overflow menu and if it is visible when this function it called, the menu will be rebuilt.
Tool items must not call this function directly, but rely on
<methodname><link linkend="method-gtktoolitem--get-relief-style">gtk.ToolItem.get_relief_style</link></methodname>()
instead.
</para>
</refsect2>
</refsect1>
</refentry>
|
