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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ExoToolbarsEditor</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Exo Reference Manual">
<link rel="up" href="exo-toolbars.html" title="Part II. Editable Toolbars">
<link rel="prev" href="ExoToolbarsModel.html" title="ExoToolbarsModel">
<link rel="next" href="ExoToolbarsEditorDialog.html" title="ExoToolbarsEditorDialog">
<meta name="generator" content="GTK-Doc V1.17 (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="ExoToolbarsModel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="exo-toolbars.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">Exo Reference Manual</th>
<td><a accesskey="n" href="ExoToolbarsEditorDialog.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ExoToolbarsEditor.synopsis" class="shortcut">Top</a>
|
<a href="#ExoToolbarsEditor.description" class="shortcut">Description</a>
|
<a href="#ExoToolbarsEditor.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#ExoToolbarsEditor.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#ExoToolbarsEditor.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="ExoToolbarsEditor"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ExoToolbarsEditor.top_of_page"></a>ExoToolbarsEditor</span></h2>
<p>ExoToolbarsEditor — Widget to edit toolbars</p>
</td>
<td valign="top" align="right"><img src="exo-toolbars-editor.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ExoToolbarsEditor.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <exo/exo.h>
<a class="link" href="ExoToolbarsEditor.html#ExoToolbarsEditor-struct" title="ExoToolbarsEditor">ExoToolbarsEditor</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="ExoToolbarsEditor.html#exo-toolbars-editor-new" title="exo_toolbars_editor_new ()">exo_toolbars_editor_new</a> (<em class="parameter"><code><span class="type">GtkUIManager</span> *ui_manager</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="ExoToolbarsEditor.html#exo-toolbars-editor-new-with-model" title="exo_toolbars_editor_new_with_model ()">exo_toolbars_editor_new_with_model</a> (<em class="parameter"><code><span class="type">GtkUIManager</span> *ui_manager</code></em>,
<em class="parameter"><code><a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a> *model</code></em>);
<a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="returnvalue">ExoToolbarsModel</span></a> * <a class="link" href="ExoToolbarsEditor.html#exo-toolbars-editor-get-model" title="exo_toolbars_editor_get_model ()">exo_toolbars_editor_get_model</a> (<em class="parameter"><code><a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> *editor</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ExoToolbarsEditor.html#exo-toolbars-editor-set-model" title="exo_toolbars_editor_set_model ()">exo_toolbars_editor_set_model</a> (<em class="parameter"><code><a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> *editor</code></em>,
<em class="parameter"><code><a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a> *model</code></em>);
<span class="returnvalue">GtkUIManager</span> * <a class="link" href="ExoToolbarsEditor.html#exo-toolbars-editor-get-ui-manager" title="exo_toolbars_editor_get_ui_manager ()">exo_toolbars_editor_get_ui_manager</a> (<em class="parameter"><code><a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> *editor</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ExoToolbarsEditor.html#exo-toolbars-editor-set-ui-manager" title="exo_toolbars_editor_set_ui_manager ()">exo_toolbars_editor_set_ui_manager</a> (<em class="parameter"><code><a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> *editor</code></em>,
<em class="parameter"><code><span class="type">GtkUIManager</span> *ui_manager</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ExoToolbarsEditor.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBox
+----GtkVBox
+----ExoToolbarsEditor
</pre>
</div>
<div class="refsect1">
<a name="ExoToolbarsEditor.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ExoToolbarsEditor implements
AtkImplementorIface, GtkBuildable and GtkOrientable.</p>
</div>
<div class="refsect1">
<a name="ExoToolbarsEditor.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="ExoToolbarsEditor.html#ExoToolbarsEditor--model" title='The "model" property'>model</a>" <a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a>* : Read / Write
"<a class="link" href="ExoToolbarsEditor.html#ExoToolbarsEditor--ui-manager" title='The "ui-manager" property'>ui-manager</a>" <span class="type">GtkUIManager</span>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="ExoToolbarsEditor.description"></a><h2>Description</h2>
<p>
<a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> is a widget that allows the user to edit toolbars
used within your application by simply dragging and dropping toolbar
items between the editor widget and the toolbar widgets.
</p>
<p>
Most applications should simply use the <a class="link" href="ExoToolbarsEditorDialog.html" title="ExoToolbarsEditorDialog"><span class="type">ExoToolbarsEditorDialog</span></a>
class, which includes an <a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> as main widget.
</p>
</div>
<div class="refsect1">
<a name="ExoToolbarsEditor.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ExoToolbarsEditor-struct"></a><h3>ExoToolbarsEditor</h3>
<pre class="programlisting">typedef struct _ExoToolbarsEditor ExoToolbarsEditor;</pre>
<p>
The <a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> struct contains only private fields and
should not be directly accessed.
</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-toolbars-editor-new"></a><h3>exo_toolbars_editor_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * exo_toolbars_editor_new (<em class="parameter"><code><span class="type">GtkUIManager</span> *ui_manager</code></em>);</pre>
<p>
Creates a new <a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> that will
be associated with <em class="parameter"><code>ui_manager</code></em>. <em class="parameter"><code>ui_manager</code></em> must
be a valid <span class="type">GtkUIManager</span>, <code class="literal">NULL</code> is not allowed
at this point.
</p>
<p>
The newly created <a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> will not
be usable until you associate an <a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a>
with it, using the function <a class="link" href="ExoToolbarsEditor.html#exo-toolbars-editor-set-model" title="exo_toolbars_editor_set_model ()"><code class="function">exo_toolbars_editor_set_model()</code></a>.
You should probably use <a class="link" href="ExoToolbarsEditor.html#exo-toolbars-editor-new-with-model" title="exo_toolbars_editor_new_with_model ()"><code class="function">exo_toolbars_editor_new_with_model()</code></a>
instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ui_manager</code></em> :</span></p></td>
<td>A <span class="type">GtkUIManager</span>.</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="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-toolbars-editor-new-with-model"></a><h3>exo_toolbars_editor_new_with_model ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * exo_toolbars_editor_new_with_model (<em class="parameter"><code><span class="type">GtkUIManager</span> *ui_manager</code></em>,
<em class="parameter"><code><a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a> *model</code></em>);</pre>
<p>
Creates a new <a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> that will be
associated with <em class="parameter"><code>model</code></em> and <em class="parameter"><code>ui_manager</code></em>. You
must supply a valid <span class="type">GtkUIManager</span> and a valid
<a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a> here or the function will
fail.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ui_manager</code></em> :</span></p></td>
<td>A <span class="type">GtkUIManager</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>An <a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a>.</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="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-toolbars-editor-get-model"></a><h3>exo_toolbars_editor_get_model ()</h3>
<pre class="programlisting"><a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="returnvalue">ExoToolbarsModel</span></a> * exo_toolbars_editor_get_model (<em class="parameter"><code><a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> *editor</code></em>);</pre>
<p>
Returns the <a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a> currently associated
with <em class="parameter"><code>editor</code></em> or <code class="literal">NULL</code> if no <a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a> is
currently associated with <em class="parameter"><code>editor</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>editor</code></em> :</span></p></td>
<td>An <a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An <a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a> or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-toolbars-editor-set-model"></a><h3>exo_toolbars_editor_set_model ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> exo_toolbars_editor_set_model (<em class="parameter"><code><a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> *editor</code></em>,
<em class="parameter"><code><a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a> *model</code></em>);</pre>
<p>
Sets the model to edit by this <em class="parameter"><code>editor</code></em>. If you specify
<code class="literal">NULL</code> for <em class="parameter"><code>model</code></em>, the editor widget will be disabled.
Else the editor widget will load the toolbars from
<em class="parameter"><code>model</code></em> and reinitialize its user interface according
to <em class="parameter"><code>model</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>editor</code></em> :</span></p></td>
<td>An <a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>An <a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a> or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-toolbars-editor-get-ui-manager"></a><h3>exo_toolbars_editor_get_ui_manager ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkUIManager</span> * exo_toolbars_editor_get_ui_manager (<em class="parameter"><code><a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> *editor</code></em>);</pre>
<p>
Returns the <span class="type">GtkUIManager</span> associated with
<em class="parameter"><code>editor</code></em> or <code class="literal">NULL</code> if no user interface
manager is associated with <em class="parameter"><code>editor</code></em> currently.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>editor</code></em> :</span></p></td>
<td>An <a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <span class="type">GtkUIManager</span> or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-toolbars-editor-set-ui-manager"></a><h3>exo_toolbars_editor_set_ui_manager ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> exo_toolbars_editor_set_ui_manager (<em class="parameter"><code><a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a> *editor</code></em>,
<em class="parameter"><code><span class="type">GtkUIManager</span> *ui_manager</code></em>);</pre>
<p>
Sets the <span class="type">GtkUIManager</span> to use by this <a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a>. If you
specify <code class="literal">NULL</code> for <em class="parameter"><code>ui_manager</code></em>, the editor widget will be disabled.
Else the editor will load the available actions from <em class="parameter"><code>ui_manager</code></em>
and reinitialize the user interface.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>editor</code></em> :</span></p></td>
<td>An <a class="link" href="ExoToolbarsEditor.html" title="ExoToolbarsEditor"><span class="type">ExoToolbarsEditor</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ui_manager</code></em> :</span></p></td>
<td>A <span class="type">GtkUIManager</span> or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="ExoToolbarsEditor.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ExoToolbarsEditor--model"></a><h3>The <code class="literal">"model"</code> property</h3>
<pre class="programlisting"> "model" <a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a>* : Read / Write</pre>
<p>
The <a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a> that should be edited from within this
toolbars editor. If you set this property to <code class="literal">NULL</code>, the editor
widget will be disabled, else the editor widget will load the
toolbars from the given <a class="link" href="ExoToolbarsModel.html" title="ExoToolbarsModel"><span class="type">ExoToolbarsModel</span></a> and initialize its
user interface according to the model.
</p>
</div>
<hr>
<div class="refsect2">
<a name="ExoToolbarsEditor--ui-manager"></a><h3>The <code class="literal">"ui-manager"</code> property</h3>
<pre class="programlisting"> "ui-manager" <span class="type">GtkUIManager</span>* : Read / Write</pre>
<p>
The <span class="type">GtkUIManager</span> used by this editor. If this property is
<code class="literal">NULL</code>, the editor widget will be disabled, else if you specify
a valid <span class="type">GtkUIManager</span>, the editor widget will load the available
actions from the given user interface manager and initialize
its user interface according to the specified <span class="type">GtkUIManager</span>.
</p>
<p>
The given <em class="parameter"><code>ui</code></em>-manager needs to support all actions that were
specified for the model, used by the editor, with the
<a class="link" href="ExoToolbarsModel.html#exo-toolbars-model-set-actions" title="exo_toolbars_model_set_actions ()"><code class="function">exo_toolbars_model_set_actions()</code></a> method.
</p>
</div>
</div>
<div class="refsect1">
<a name="ExoToolbarsEditor.see-also"></a><h2>See Also</h2>
<a class="link" href="ExoToolbarsEditorDialog.html" title="ExoToolbarsEditorDialog"><span class="type">ExoToolbarsEditorDialog</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|
