File: eog-eog-thumb-nav.html

package info (click to toggle)
eog 2.30.2-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 14,044 kB
  • ctags: 3,758
  • sloc: ansic: 29,896; xml: 16,113; sh: 10,620; makefile: 678
file content (273 lines) | stat: -rw-r--r-- 17,597 bytes parent folder | download
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EogThumbNav</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Eye of GNOME Reference Manual">
<link rel="up" href="ch01.html" title="User Interface">
<link rel="prev" href="EogFileChooser.html" title="EogFileChooser">
<link rel="next" href="eog-eog-thumb-view.html" title="EogThumbView">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="EogFileChooser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Eye of GNOME Reference Manual</th>
<td><a accesskey="n" href="eog-eog-thumb-view.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#eog-eog-thumb-nav.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#eog-eog-thumb-nav.description" class="shortcut">Description</a>
                   | 
                  <a href="#eog-eog-thumb-nav.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#eog-eog-thumb-nav.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#eog-eog-thumb-nav.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="EogThumbNav">
<a name="eog-eog-thumb-nav"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eog-eog-thumb-nav.top_of_page"></a>EogThumbNav</span></h2>
<p>EogThumbNav</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="eog-eog-thumb-nav.synopsis"></a><h2>Synopsis</h2>
<a name="EogThumbNav"></a><pre class="synopsis">enum                <a class="link" href="eog-eog-thumb-nav.html#EogThumbNavMode" title="enum EogThumbNavMode">EogThumbNavMode</a>;
                    <a class="link" href="eog-eog-thumb-nav.html#EogThumbNav-struct" title="EogThumbNav">EogThumbNav</a>;
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="eog-eog-thumb-nav.html#eog-thumb-nav-new" title="eog_thumb_nav_new ()">eog_thumb_nav_new</a>                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *thumbview</code></em>,
                                                         <em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNavMode" title="enum EogThumbNavMode"><span class="type">EogThumbNavMode</span></a> mode</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_buttons</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="eog-eog-thumb-nav.html#eog-thumb-nav-get-show-buttons" title="eog_thumb_nav_get_show_buttons ()">eog_thumb_nav_get_show_buttons</a>      (<em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a> *nav</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="eog-eog-thumb-nav.html#eog-thumb-nav-set-show-buttons" title="eog_thumb_nav_set_show_buttons ()">eog_thumb_nav_set_show_buttons</a>      (<em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a> *nav</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_buttons</code></em>);
<a class="link" href="eog-eog-thumb-nav.html#EogThumbNavMode" title="enum EogThumbNavMode"><span class="returnvalue">EogThumbNavMode</span></a>     <a class="link" href="eog-eog-thumb-nav.html#eog-thumb-nav-get-mode" title="eog_thumb_nav_get_mode ()">eog_thumb_nav_get_mode</a>              (<em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a> *nav</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="eog-eog-thumb-nav.html#eog-thumb-nav-set-mode" title="eog_thumb_nav_set_mode ()">eog_thumb_nav_set_mode</a>              (<em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a> *nav</code></em>,
                                                         <em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNavMode" title="enum EogThumbNavMode"><span class="type">EogThumbNavMode</span></a> mode</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="eog-eog-thumb-nav.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
         +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a>
               +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a>
                     +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html">GtkContainer</a>
                           +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkBox.html">GtkBox</a>
                                 +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkHBox.html">GtkHBox</a>
                                       +----EogThumbNav
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="eog-eog-thumb-nav.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EogThumbNav implements
 AtkImplementorIface,  <a href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a> and  <a href="http://library.gnome.org/devel/gtk/unstable/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="eog-eog-thumb-nav.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="eog-eog-thumb-nav.html#EogThumbNav--mode" title='The "mode" property'>mode</a>"                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  "<a class="link" href="eog-eog-thumb-nav.html#EogThumbNav--show-buttons" title='The "show-buttons" property'>show-buttons</a>"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  "<a class="link" href="eog-eog-thumb-nav.html#EogThumbNav--thumbview" title='The "thumbview" property'>thumbview</a>"                <a class="link" href="eog-eog-thumb-view.html#EogThumbView"><span class="type">EogThumbView</span></a>*         : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" title="Description">
<a name="eog-eog-thumb-nav.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="eog-eog-thumb-nav.details"></a><h2>Details</h2>
<div class="refsect2" title="enum EogThumbNavMode">
<a name="EogThumbNavMode"></a><h3>enum EogThumbNavMode</h3>
<pre class="programlisting">typedef enum {
	EOG_THUMB_NAV_MODE_ONE_ROW,
	EOG_THUMB_NAV_MODE_ONE_COLUMN,
	EOG_THUMB_NAV_MODE_MULTIPLE_ROWS,
	EOG_THUMB_NAV_MODE_MULTIPLE_COLUMNS
} EogThumbNavMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="EogThumbNav">
<a name="EogThumbNav-struct"></a><h3>EogThumbNav</h3>
<pre class="programlisting">typedef struct _EogThumbNav EogThumbNav;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="eog_thumb_nav_new ()">
<a name="eog-thumb-nav-new"></a><h3>eog_thumb_nav_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         eog_thumb_nav_new                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *thumbview</code></em>,
                                                         <em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNavMode" title="enum EogThumbNavMode"><span class="type">EogThumbNavMode</span></a> mode</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_buttons</code></em>);</pre>
<p>
Creates a new thumbnail navigation widget.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>thumbview</code></em> :</span></p></td>
<td>an <a class="link" href="eog-eog-thumb-view.html#EogThumbView"><span class="type">EogThumbView</span></a> to embed in the navigation widget.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>The navigation mode.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>show_buttons</code></em> :</span></p></td>
<td>Whether to show the navigation buttons.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a> object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="eog_thumb_nav_get_show_buttons ()">
<a name="eog-thumb-nav-get-show-buttons"></a><h3>eog_thumb_nav_get_show_buttons ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            eog_thumb_nav_get_show_buttons      (<em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a> *nav</code></em>);</pre>
<p>
Gets whether the navigation buttons are visible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nav</code></em> :</span></p></td>
<td>an <a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the navigation buttons are visible,
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="eog_thumb_nav_set_show_buttons ()">
<a name="eog-thumb-nav-set-show-buttons"></a><h3>eog_thumb_nav_set_show_buttons ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                eog_thumb_nav_set_show_buttons      (<em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a> *nav</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_buttons</code></em>);</pre>
<p>
Sets whether the navigation buttons to the left and right of the
widget should be visible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nav</code></em> :</span></p></td>
<td>an <a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>show_buttons</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to show the buttons, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to hide them.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="eog_thumb_nav_get_mode ()">
<a name="eog-thumb-nav-get-mode"></a><h3>eog_thumb_nav_get_mode ()</h3>
<pre class="programlisting"><a class="link" href="eog-eog-thumb-nav.html#EogThumbNavMode" title="enum EogThumbNavMode"><span class="returnvalue">EogThumbNavMode</span></a>     eog_thumb_nav_get_mode              (<em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a> *nav</code></em>);</pre>
<p>
Gets the navigation mode in <em class="parameter"><code>nav</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nav</code></em> :</span></p></td>
<td>an <a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A value in <a class="link" href="eog-eog-thumb-nav.html#EogThumbNavMode" title="enum EogThumbNavMode"><span class="type">EogThumbNavMode</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="eog_thumb_nav_set_mode ()">
<a name="eog-thumb-nav-set-mode"></a><h3>eog_thumb_nav_set_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                eog_thumb_nav_set_mode              (<em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a> *nav</code></em>,
                                                         <em class="parameter"><code><a class="link" href="eog-eog-thumb-nav.html#EogThumbNavMode" title="enum EogThumbNavMode"><span class="type">EogThumbNavMode</span></a> mode</code></em>);</pre>
<p>
Sets the navigation mode in <em class="parameter"><code>nav</code></em>. See <a class="link" href="eog-eog-thumb-nav.html#EogThumbNavMode" title="enum EogThumbNavMode"><span class="type">EogThumbNavMode</span></a> for details.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nav</code></em> :</span></p></td>
<td>An <a class="link" href="eog-eog-thumb-nav.html#EogThumbNav"><span class="type">EogThumbNav</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>One of <a class="link" href="eog-eog-thumb-nav.html#EogThumbNavMode" title="enum EogThumbNavMode"><span class="type">EogThumbNavMode</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="eog-eog-thumb-nav.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "mode" property'>
<a name="EogThumbNav--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
<pre class="programlisting">  "mode"                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
<p>Thumb navigator mode.</p>
<p>Allowed values: [0,2]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "show-buttons" property'>
<a name="EogThumbNav--show-buttons"></a><h3>The <code class="literal">"show-buttons"</code> property</h3>
<pre class="programlisting">  "show-buttons"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
<p>Whether to show navigation buttons or not.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2" title='The "thumbview" property'>
<a name="EogThumbNav--thumbview"></a><h3>The <code class="literal">"thumbview"</code> property</h3>
<pre class="programlisting">  "thumbview"                <a class="link" href="eog-eog-thumb-view.html#EogThumbView"><span class="type">EogThumbView</span></a>*         : Read / Write / Construct Only</pre>
<p>The internal thumbnail viewer widget.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>