4
@deffn Function gnome-accelerators-sync
5
Flush the accelerator definitions into the application specific configuration
6
file $HOME/.gnome2/accels/<app-id>.
10
@deffn Function gnome-app-fill-menu (menu_shell@tie{}@code{<gtk-menu-shell>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (accel_group@tie{}@code{<gtk-accel-group>}) (uline_accels@tie{}@code{bool}) (pos@tie{}@code{int})
11
Fills the specified @var{menu-shell} with items created from the specified
12
@var{uiinfo}, inserting them from the item number @var{pos} on. The @var{accel}
13
group will be used as the accel group for all newly created sub menus and serves
14
as the global accel group for all menu item hotkeys. If it is passed as
15
@samp{@code{#f}}, global hotkeys will be disabled.
19
A @code{<gtk-menu-shell>} instance (a menu bar).
22
A pointer to the first element in an array of @code{<gnome-ui-info>} structures.
23
The last element of the array should have a type of
24
@code{<gnome-app-ui-endofinfo>}.
27
A @code{<gtk-accel-group>}.
30
@samp{@code{#t}} if underline accelerators will be drawn for the menu item
34
The position in the menu bar at which to start inserting items.
40
@deffn Function gnome-app-fill-menu-with-data (menu_shell@tie{}@code{<gtk-menu-shell>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (accel_group@tie{}@code{<gtk-accel-group>}) (uline_accels@tie{}@code{bool}) (pos@tie{}@code{int}) (user_data@tie{}@code{<gpointer>})
41
This is the same as @code{gnome-app-fill-menu}, except that all the user data
42
pointers are filled with the value of @var{user-data}.
46
A @code{<gtk-menu-shell>} instance (a menu bar).
49
A pointer to the first element in an array of @code{<gnome-ui-info>} structures.
50
The last element of the array should have a type of
51
@code{<gnome-app-ui-endofinfo>}.
54
A @code{<gtk-accel-group>}.
57
@samp{@code{#t}} if underline accelerators will be drawn for the menu item
61
The position in the menu bar at which to start inserting items.
64
Some application-specific data.
70
@deffn Function gnome-app-fill-menu-custom (menu_shell@tie{}@code{<gtk-menu-shell>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (uibdata@tie{}@code{<gnome-ui-builder-data*>}) (accel_group@tie{}@code{<gtk-accel-group>}) (uline_accels@tie{}@code{bool}) (pos@tie{}@code{int})
71
Fills the specified menu shell with items created from the specified
72
@var{uiinfo}, inserting them from item number @var{pos} on and using the
73
specified builder data (@var{uibdata}) -- this is intended for language
76
The other parameters have the same meaning as in @code{gnome-app-fill-menu}.
80
A @code{<gtk-menu-shell>} instance (a menu bar).
83
A pointer to the first element in an array of @code{<gnome-ui-info>} structures.
84
The last element of the array should have a type of
85
@code{<gnome-app-ui-endofinfo>}.
88
A @code{<gnome-ui-info-builder-data>} instance.
91
A @code{<gtk-accel-group>}.
94
@samp{@code{#t}} if underline accelerators will be drawn for the menu item
98
The position in the menu bar at which to start inserting items.
104
@deffn Function gnome-app-ui-configure-configurable (uiinfo@tie{}@code{<gnome-ui-info*>})
105
Configure all user-configurable elements in the given UI info structure. This
106
includes loading and setting previously-set options from GNOME config files.
108
Normally, @code{gnome-app-create-menus} calls this function for the developer,
109
but if something needs to be altered afterwards, this function can be called
110
first. The main reason for this function being a public interface is so that it
111
can be called from @code{gnome-popup-menu-new}, which clears a copy of the pass
112
in @code{<gnome-ui-info>} structures.
116
Pointer to GNOME UI menu/toolbar info
122
@deffn Function gnome-app-create-menus (self@tie{}@code{<gnome-app>}) (uiinfo@tie{}@code{<gnome-ui-info*>})
123
@deffnx Method create-menus
124
Constructs a menu bar and attaches it to the specified application window.
128
A @code{<gnome-app>} instance representing the current application.
131
The first in an array @code{<gnome-ui-info>} instances containing the menu data.
137
@deffn Function gnome-app-create-menus-interp (self@tie{}@code{<gnome-app>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (relay_func@tie{}@code{<gtk-callback-marshal>}) (data@tie{}@code{<gpointer>}) (destroy_func@tie{}@code{<gtk-destroy-notify>})
138
@deffnx Method create-menus-interp
139
Identical to @code{gnome-app-create-menus}, except that extra functions and data
140
can be passed in for finer control of the destruction and marshalling.
144
A @code{<gnome-app>} instance, representing the current application.
147
The first item in an array of @code{<gnome-ui-info>} structures describing the
151
A marshaller for the signal callbacks.
154
Application specific data passed to the signal callback functions.
157
The function to call when the menu bar is destroyed.
163
@deffn Function gnome-app-create-menus-with-data (self@tie{}@code{<gnome-app>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (user_data@tie{}@code{<gpointer>})
164
@deffnx Method create-menus-with-data
165
Identical to @code{gnome-app-create-menus}, except that @var{user-data} is
166
passed to all the callback functions when signals are emitted.
170
A @code{<gnome-app>} instance representing the current application.
173
The first in an array @code{<gnome-ui-info>} instances containing the menu data.
176
Application-specific data that is passed to every callback function.
182
@deffn Function gnome-app-create-menus-custom (self@tie{}@code{<gnome-app>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (uibdata@tie{}@code{<gnome-ui-builder-data*>})
183
@deffnx Method create-menus-custom
184
Identical to @code{gnome-app-create-menus}, except that @var{uibdata} is also
185
specified for creating the signal handlers. Mostly for use by language bindings.
189
A @code{<gnome-app>} instance representing the current application.
192
The first in an array @code{<gnome-ui-info>} instances containing the menu data.
195
An appropriate @code{<gnome-ui-builder-data>} instance.
201
@deffn Function gnome-app-fill-toolbar (toolbar@tie{}@code{<gtk-toolbar>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (accel_group@tie{}@code{<gtk-accel-group>})
202
Fills @var{toolbar} with buttons specified in @var{uiinfo}. If @var{accel-group}
203
is not @samp{@code{#f}}, the items' accelrator keys are put into it.
207
A @code{<gtk-toolbar>} instance.
210
An array of @code{<gnome-ui-info>} structures containing the items for the
214
A @code{<gtk-accel-group>} for holding the accelerator keys of the items (or
221
@deffn Function gnome-app-fill-toolbar-with-data (toolbar@tie{}@code{<gtk-toolbar>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (accel_group@tie{}@code{<gtk-accel-group>}) (user_data@tie{}@code{<gpointer>})
222
The same as @code{gnome-app-fill-toolbar}, except that the user data pointers in
223
the signal handlers are set to @var{user-data}.
227
A @code{<gtk-toolbar>} instance.
230
An array of @code{<gnome-ui-info>} structures containing the items for the
234
A @code{<gtk-accel-group>} for holding the accelerator keys of the items (or
238
Application specific data.
244
@deffn Function gnome-app-fill-toolbar-custom (toolbar@tie{}@code{<gtk-toolbar>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (uibdata@tie{}@code{<gnome-ui-builder-data*>}) (accel_group@tie{}@code{<gtk-accel-group>})
245
The same as @code{gnome-app-fill-toolbar}, except that the sepcified
246
@var{uibdata} instance is used. This is mostly for the benefit of language
251
A @code{<gtk-toolbar>} instance.
254
An array of @code{<gnome-ui-info>} structures containing the items for the
258
The @code{<gnome-ui-builder-data>} data for the toolbar.
261
A @code{<gtk-accel-group>} for holding the accelerator keys of the items (or
268
@deffn Function gnome-app-create-toolbar (self@tie{}@code{<gnome-app>}) (uiinfo@tie{}@code{<gnome-ui-info*>})
269
@deffnx Method create-toolbar
270
Constructs a toolbar and attaches it to the specified application window.
274
A @code{<gnome-app>} instance.
277
A @code{<gnome-ui-info>} array specifying the contents of the toolbar.
283
@deffn Function gnome-app-create-toolbar-interp (self@tie{}@code{<gnome-app>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (relay_func@tie{}@code{<gtk-callback-marshal>}) (data@tie{}@code{<gpointer>}) (destroy_func@tie{}@code{<gtk-destroy-notify>})
284
@deffnx Method create-toolbar-interp
285
Constructs a toolbar and attaches it to the specified application window -- this
286
version is intended for language bindings.
290
A @code{<gnome-app>} instance.
293
A @code{<gnome-ui-info>} array specifying the contents of the toolbar.
296
Argument marshalling function.
299
Application specific data to pass to signal callbacks.
302
The function to call when the toolbar is destroyed.
308
@deffn Function gnome-app-create-toolbar-with-data (self@tie{}@code{<gnome-app>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (user_data@tie{}@code{<gpointer>})
309
@deffnx Method create-toolbar-with-data
310
Constructs a toolbar, sets all the user data pointers to @var{user-data}, and
311
attaches it to @var{app}.
315
A @code{<gnome-app>} instance.
318
A @code{<gnome-ui-info>} array specifying the contents of the toolbar.
321
Application specific data to be sent to each signal callback function.
327
@deffn Function gnome-app-create-toolbar-custom (self@tie{}@code{<gnome-app>}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (uibdata@tie{}@code{<gnome-ui-builder-data*>})
328
@deffnx Method create-toolbar-custom
329
Constructs a toolbar and attaches it to the @var{app} window, using
330
@var{uibdata} builder data -- intended for language bindings.
334
A @code{<gnome-app>} instance.
337
A @code{<gnome-ui-info>} array specifying the contents of the toolbar.
340
A @code{<gnome-ui-builder-data>} instance specifying the handlers to use for the
347
@deffn Function gnome-app-find-menu-pos (parent@tie{}@code{<gtk-widget>}) (path@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>}) (pos@tie{}@code{int})
348
Finds a menu item described by path starting in the @code{<gtk-menu-shell>} top
349
and returns its parent @code{<gtk-menu-shell>} and the position after this item
350
in @var{pos}. The meaning of @var{pos} is that a subsequent call to
351
gtk_menu_shell_insert(p, w, pos) would then insert widget w in GtkMenuShell p
352
right after the menu item described by path.
356
Root menu shell widget containing menu items to be searched.
359
Specifies the target menu item by menu path.
362
Used to hold the returned menu items' position.
365
The parent menu shell of @var{path}.
371
@deffn Function gnome-app-remove-menus (self@tie{}@code{<gnome-app>}) (path@tie{}@code{mchars}) (items@tie{}@code{int})
372
@deffnx Method remove-menus
373
Removes @var{items} items from the existing @var{app}'s menu structure,
374
beginning with item described by @var{path}.
376
The @var{path} argument should be in the form "File/.../.../Something". "" will
377
insert the item as the first one in the menubar, "File/" will insert it as the
378
first one in the File menu, "File/Settings" will insert it after the Setting
379
item in the File menu use of "File/<Separator>" should be obvious. However, the
380
use of "<Seperator>" stops after the first separator.
384
A @code{<gnome-app>} instance.
387
A path to the menu item concerned.
390
The number of items to remove.
396
@deffn Function gnome-app-remove-menu-range (self@tie{}@code{<gnome-app>}) (path@tie{}@code{mchars}) (start@tie{}@code{int}) (items@tie{}@code{int})
397
@deffnx Method remove-menu-range
398
Same as the @code{gnome-app-remove-menus}, except it removes the specified
399
number of @var{items} from the existing @var{app}'s menu structure begining with
400
item described by (@var{path} plus @var{start}). This is very useful for adding
401
and removing Recent document items in the File menu.
405
A @code{<gnome-app>} instance.
408
A path to the menu item concerned.
411
An offset beyond the start of @var{path} at which to begin removing.
414
The number of items to remove.
420
@deffn Function gnome-app-insert-menus-custom (self@tie{}@code{<gnome-app>}) (path@tie{}@code{mchars}) (uiinfo@tie{}@code{<gnome-ui-info*>}) (uibdata@tie{}@code{<gnome-ui-builder-data*>})
421
@deffnx Method insert-menus-custom
422
Inserts menus described by @var{uiinfo} in existing @var{app}'s menu structure
423
right after the item described by @var{path}. The @var{uibdata} parameter makes
424
this, again, most useful for language bindings.
428
A @code{<gnome-app>} instance.
431
A path to the menu item concerned.
434
A @code{<gnome-ui-info>} array describing the menus.
437
A @code{<gnome-ui-builder-data>} instance describing the functions to attach as
438
the menu's callbacks.
444
@deffn Function gnome-app-insert-menus (self@tie{}@code{<gnome-app>}) (path@tie{}@code{mchars}) (menuinfo@tie{}@code{<gnome-ui-info*>})
445
@deffnx Method insert-menus
446
Insert the menus given by @var{menuinfo} beginning at @var{path} into the
447
pre-existing @var{app}.
451
A @code{<gnome-app>} instance.
454
A path to the menu item concerned.
457
A @code{<gnome-ui-info>} array describing the menus.
463
@deffn Function gnome-app-insert-menus-with-data (self@tie{}@code{<gnome-app>}) (path@tie{}@code{mchars}) (menuinfo@tie{}@code{<gnome-ui-info*>}) (data@tie{}@code{<gpointer>})
464
@deffnx Method insert-menus-with-data
465
This is the same as @code{gnome-app-insert-menus}, except that the specified
466
@var{data} is passed to each signal callback.
470
A @code{<gnome-app>} instance.
473
A path to the menu item concerned.
476
A @code{<gnome-ui-info>} array describing the menus.
479
Application specific data to send to each signal callback.
485
@deffn Function gnome-app-insert-menus-interp (self@tie{}@code{<gnome-app>}) (path@tie{}@code{mchars}) (menuinfo@tie{}@code{<gnome-ui-info*>}) (relay_func@tie{}@code{<gtk-callback-marshal>}) (data@tie{}@code{<gpointer>}) (destroy_func@tie{}@code{<gtk-destroy-notify>})
486
@deffnx Method insert-menus-interp
487
THe same as @code{gnome-app-insert-menus}, except that the given functions are
488
attached to each menu item. Mostly of use for language bindings.
492
A @code{<gnome-app>} instance.
495
A path to the menu item concerned.
498
A @code{<gnome-ui-info>} array describing the menus.
501
A custom marshallar for signal data.,
504
Application-specific data to send to each signal callback.
507
The function to call when the menu item is destroyed.
513
@deffn Function gnome-app-install-appbar-menu-hints (appbar@tie{}@code{<gnome-app-bar>}) (uiinfo@tie{}@code{<gnome-ui-info*>})
514
Install menu hints for the given @var{appbar} object. This function cannot just
515
be called automatically, since it is impossible to reliably find the correct
520
An existing @code{<gnome-app-bar>} instance.
523
A @code{<gnome-ui-info>} array of a menu for which hints will be set.
529
@deffn Function gnome-app-install-menu-hints (self@tie{}@code{<gnome-app>}) (uiinfo@tie{}@code{<gnome-ui-info*>})
530
@deffnx Method install-menu-hints
531
Set menu hints for the @var{app} object's attached status bar.
535
An existing @code{<gnome-app-bar>} instance.
538
A @code{<gnome-ui-info>} array of a menu for which hints will be set.
544
@deffn Function gnome-app-setup-toolbar (toolbar@tie{}@code{<gtk-toolbar>}) (dock_item@tie{}@code{<bonobo-dock-item*>})
545
Sets up a toolbar to use GNOME user preferences.
549
Pointer to a @code{<gtk-toolbar>} instance.
552
Pointer to the @code{<bonobo-dock-item>} the toolbar is inside, or
553
@samp{@code{#f}} for none.
559
@deffn Function gnome-app-helper-gettext (string@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{mchars})
560
Translate @var{string} by calling @code{gettext} and then, if that did not
561
change the string, @code{dgettext} with the domain set to libgnome's message
566
The string to translate.
569
The localised value of the string.
added
removed
libgnomeui/doc/defuns-gnome-app-helper.xml.texi
