Top | ![]() |
![]() |
![]() |
![]() |
GtkWidget * | gtk_toolbar_new () |
void | gtk_toolbar_insert () |
gint | gtk_toolbar_get_item_index () |
gint | gtk_toolbar_get_n_items () |
GtkToolItem * | gtk_toolbar_get_nth_item () |
gint | gtk_toolbar_get_drop_index () |
void | gtk_toolbar_set_drop_highlight_item () |
void | gtk_toolbar_set_show_arrow () |
gboolean | gtk_toolbar_get_show_arrow () |
GtkToolbarStyle | gtk_toolbar_get_style () |
void | gtk_toolbar_set_style () |
void | gtk_toolbar_unset_style () |
gboolean | focus-home-or-end | Action |
void | orientation-changed | Run First |
gboolean | popup-context-menu | Run Last |
void | style-changed | Run First |
GtkToolbar implements AtkImplementor, GtkBuildable, GtkToolShell and GtkOrientable.
A toolbar is created with a call to gtk_toolbar_new()
.
A toolbar can contain instances of a subclass of GtkToolItem. To add
a GtkToolItem to the a toolbar, use gtk_toolbar_insert()
. To remove
an item from the toolbar use gtk_container_remove()
. To add a button
to the toolbar, add an instance of GtkToolButton.
Toolbar items can be visually grouped by adding instances of GtkSeparatorToolItem to the toolbar. If the GtkToolbar child property “expand” is TRUE and the property “draw” is set to FALSE, the effect is to force all following items to the end of the toolbar.
By default, a toolbar can be shrunk, upon which it will add an arrow button
to show an overflow menu offering access to any GtkToolItem child that has
a proxy menu item. To disable this and request enough size for all children,
call gtk_toolbar_set_show_arrow()
to set “show-arrow” to FALSE
.
Creating a context menu for the toolbar can be done by connecting to the “popup-context-menu” signal.
void gtk_toolbar_insert (GtkToolbar *toolbar
,GtkToolItem *item
,gint pos
);
Insert a GtkToolItem into the toolbar at position pos
. If pos
is
0 the item is prepended to the start of the toolbar. If pos
is
negative, the item is appended to the end of the toolbar.
gint gtk_toolbar_get_item_index (GtkToolbar *toolbar
,GtkToolItem *item
);
Returns the position of item
on the toolbar, starting from 0.
It is an error if item
is not a child of the toolbar.
gint
gtk_toolbar_get_n_items (GtkToolbar *toolbar
);
Returns the number of items on the toolbar.
GtkToolItem * gtk_toolbar_get_nth_item (GtkToolbar *toolbar
,gint n
);
Returns the n
'th item on toolbar
, or NULL
if the
toolbar does not contain an n
'th item.
The n
'th GtkToolItem on toolbar
,
or NULL
if there isn’t an n
'th item.
[nullable][transfer none]
gint gtk_toolbar_get_drop_index (GtkToolbar *toolbar
,gint x
,gint y
);
Returns the position corresponding to the indicated point on
toolbar
. This is useful when dragging items to the toolbar:
this function returns the position a new item should be
inserted.
x
and y
are in toolbar
coordinates.
void gtk_toolbar_set_drop_highlight_item (GtkToolbar *toolbar
,GtkToolItem *tool_item
,gint index_
);
Highlights toolbar
to give an idea of what it would look like
if item
was added to toolbar
at the position indicated by index_
.
If item
is NULL
, highlighting is turned off. In that case index_
is ignored.
The tool_item
passed to this function must not be part of any widget
hierarchy. When an item is set as drop highlight item it can not
added to any widget hierarchy or used as highlight item for another
toolbar.
toolbar |
||
tool_item |
a GtkToolItem, or |
[allow-none] |
index_ |
a position on |
void gtk_toolbar_set_show_arrow (GtkToolbar *toolbar
,gboolean show_arrow
);
Sets whether to show an overflow menu when toolbar
isn’t allocated enough
size to show all of its items. If TRUE
, items which can’t fit in toolbar
,
and which have a proxy menu item set by gtk_tool_item_set_proxy_menu_item()
or “create-menu-proxy”, will be available in an overflow menu,
which can be opened by an added arrow button. If FALSE
, toolbar
will
request enough size to fit all of its child items without any overflow.
gboolean
gtk_toolbar_get_show_arrow (GtkToolbar *toolbar
);
Returns whether the toolbar has an overflow menu.
See gtk_toolbar_set_show_arrow()
.
GtkToolbarStyle
gtk_toolbar_get_style (GtkToolbar *toolbar
);
Retrieves whether the toolbar has text, icons, or both . See
gtk_toolbar_set_style()
.
void gtk_toolbar_set_style (GtkToolbar *toolbar
,GtkToolbarStyle style
);
Alters the view of toolbar
to display either icons only, text only, or both.
void
gtk_toolbar_unset_style (GtkToolbar *toolbar
);
Unsets a toolbar style set with gtk_toolbar_set_style()
, so that
user preferences will be used to determine the toolbar style.
“show-arrow”
property “show-arrow” gboolean
If an arrow should be shown if the toolbar doesn’t fit.
Flags: Read / Write
Default value: TRUE
“toolbar-style”
property“toolbar-style” GtkToolbarStyle
How to draw the toolbar.
Flags: Read / Write
Default value: GTK_TOOLBAR_BOTH_HORIZ
“focus-home-or-end”
signalgboolean user_function (GtkToolbar *toolbar, gboolean focus_home, gpointer user_data)
A keybinding signal used internally by GTK+. This signal can't be used in application code
toolbar |
the GtkToolbar which emitted the signal |
|
focus_home |
|
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“orientation-changed”
signalvoid user_function (GtkToolbar *toolbar, GtkOrientation orientation, gpointer user_data)
Emitted when the orientation of the toolbar changes.
toolbar |
the object which emitted the signal |
|
orientation |
the new GtkOrientation of the toolbar |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“popup-context-menu”
signalgboolean user_function (GtkToolbar *toolbar, gint x, gint y, gint button, gpointer user_data)
Emitted when the user right-clicks the toolbar or uses the keybinding to display a popup menu.
Application developers should handle this signal if they want
to display a context menu on the toolbar. The context-menu should
appear at the coordinates given by x
and y
. The mouse button
number is given by the button
parameter. If the menu was popped
up using the keybaord, button
is -1.
toolbar |
the GtkToolbar which emitted the signal |
|
x |
the x coordinate of the point where the menu should appear |
|
y |
the y coordinate of the point where the menu should appear |
|
button |
the mouse button the user pressed, or -1 |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“style-changed”
signalvoid user_function (GtkToolbar *toolbar, GtkToolbarStyle style, gpointer user_data)
Emitted when the style of the toolbar changes.
toolbar |
The GtkToolbar which emitted the signal |
|
style |
the new GtkToolbarStyle of the toolbar |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First