Top |
Functions
Properties
GtkIconSize | icon-size | Read / Write |
gboolean | icon-size-set | Read / Write |
gboolean | show-arrow | Read / Write |
GtkToolbarStyle | toolbar-style | Read / Write |
Style Properties
GtkReliefStyle | button-relief | Read |
gint | internal-padding | Read |
gint | max-child-expand | Read |
GtkShadowType | shadow-type | Read |
gint | space-size | Read |
GtkToolbarSpaceStyle | space-style | Read |
Signals
gboolean | focus-home-or-end | Action |
void | orientation-changed | Run First |
gboolean | popup-context-menu | Run Last |
void | style-changed | Run First |
Implemented Interfaces
GtkToolbar implements AtkImplementorIface, GtkBuildable, GtkToolShell and GtkOrientable.
Description
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.
Creating a context menu for the toolbar can be done by connecting to the “popup-context-menu” signal.
Functions
gtk_toolbar_insert ()
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.
Since 2.4
gtk_toolbar_get_item_index ()
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.
Since 2.4
gtk_toolbar_get_n_items ()
gint
gtk_toolbar_get_n_items (GtkToolbar *toolbar
);
Returns the number of items on the toolbar.
Since 2.4
gtk_toolbar_get_nth_item ()
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.
Since 2.4
gtk_toolbar_get_drop_index ()
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.
Parameters
toolbar |
||
x |
x coordinate of a point on the toolbar |
|
y |
y coordinate of a point on the toolbar |
Since 2.4
gtk_toolbar_set_drop_highlight_item ()
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.
Parameters
toolbar |
||
tool_item |
a GtkToolItem, or |
[allow-none] |
index_ |
a position on |
Since 2.4
gtk_toolbar_set_show_arrow ()
void gtk_toolbar_set_show_arrow (GtkToolbar *toolbar
,gboolean show_arrow
);
Sets whether to show an overflow menu when
toolbar
doesn’t have room for all items on it. If TRUE
,
items that there are not room are available through an
overflow menu.
Since 2.4
gtk_toolbar_unset_icon_size ()
void
gtk_toolbar_unset_icon_size (GtkToolbar *toolbar
);
Unsets toolbar icon size set with gtk_toolbar_set_icon_size()
, so that
user preferences will be used to determine the icon size.
gtk_toolbar_get_show_arrow ()
gboolean
gtk_toolbar_get_show_arrow (GtkToolbar *toolbar
);
Returns whether the toolbar has an overflow menu.
See gtk_toolbar_set_show_arrow()
.
Since 2.4
gtk_toolbar_get_style ()
GtkToolbarStyle
gtk_toolbar_get_style (GtkToolbar *toolbar
);
Retrieves whether the toolbar has text, icons, or both . See
gtk_toolbar_set_style()
.
gtk_toolbar_get_icon_size ()
GtkIconSize
gtk_toolbar_get_icon_size (GtkToolbar *toolbar
);
Retrieves the icon size for the toolbar. See gtk_toolbar_set_icon_size()
.
gtk_toolbar_get_relief_style ()
GtkReliefStyle
gtk_toolbar_get_relief_style (GtkToolbar *toolbar
);
Returns the relief style of buttons on toolbar
. See
gtk_button_set_relief()
.
Since 2.4
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.
gtk_toolbar_set_icon_size ()
void gtk_toolbar_set_icon_size (GtkToolbar *toolbar
,GtkIconSize icon_size
);
This function sets the size of stock icons in the toolbar. You can call it both before you add the icons and after they’ve been added. The size you set will override user preferences for the default icon size.
This should only be used for special-purpose toolbars, normal application toolbars should respect the user preferences for the size of icons.
gtk_toolbar_unset_style ()
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.
Property Details
The “icon-size”
property
“icon-size” GtkIconSize
The size of the icons in a toolbar is normally determined by the toolbar-icon-size setting. When this property is set, it overrides the setting.
This should only be used for special-purpose toolbars, normal application toolbars should respect the user preferences for the size of icons.
Flags: Read / Write
Default value: GTK_ICON_SIZE_LARGE_TOOLBAR
Since 2.10
The “icon-size-set”
property
“icon-size-set” gboolean
Is TRUE
if the icon-size property has been set.
Flags: Read / Write
Default value: FALSE
Since 2.10
The “show-arrow”
property
“show-arrow” gboolean
If an arrow should be shown if the toolbar doesn't fit.
Flags: Read / Write
Default value: TRUE
The “toolbar-style”
property
“toolbar-style” GtkToolbarStyle
How to draw the toolbar.
Flags: Read / Write
Default value: GTK_TOOLBAR_BOTH_HORIZ
Child Property Details
The “expand”
child property
“expand” gboolean
Whether the item should receive extra space when the toolbar grows.
Flags: Read / Write
Default value: FALSE
The “homogeneous”
child property
“homogeneous” gboolean
Whether the item should be the same size as other homogeneous items.
Flags: Read / Write
Default value: FALSE
Style Property Details
The “button-relief”
style property
“button-relief” GtkReliefStyle
Type of bevel around toolbar buttons.
Flags: Read
Default value: GTK_RELIEF_NONE
The “internal-padding”
style property
“internal-padding” gint
Amount of border space between the toolbar shadow and the buttons.
GtkToolbar:internal-padding
has been deprecated since version 3.6 and should not be used in newly-written code.
Use the standard padding CSS property (through objects like GtkStyleContext and GtkCssProvider); the value of this style property is ignored.
Flags: Read
Allowed values: >= 0
Default value: 0
The “max-child-expand”
style property
“max-child-expand” gint
Maximum amount of space an expandable item will be given.
Flags: Read
Allowed values: >= 0
Default value: 2147483647
The “shadow-type”
style property
“shadow-type” GtkShadowType
Style of bevel around the toolbar.
GtkToolbar:shadow-type
has been deprecated since version 3.6 and should not be used in newly-written code.
Use the standard border CSS property (through objects like GtkStyleContext and GtkCssProvider); the value of this style property is ignored.
Flags: Read
Default value: GTK_SHADOW_OUT
The “space-size”
style property
“space-size” gint
Size of spacers.
Flags: Read
Allowed values: >= 0
Default value: 12
The “space-style”
style property
“space-style” GtkToolbarSpaceStyle
Whether spacers are vertical lines or just blank.
Flags: Read
Default value: GTK_TOOLBAR_SPACE_LINE
Signal Details
The “focus-home-or-end”
signal
gboolean 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
Parameters
toolbar |
the GtkToolbar which emitted the signal |
|
focus_home |
|
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
The “orientation-changed”
signal
void user_function (GtkToolbar *toolbar, GtkOrientation orientation, gpointer user_data)
Emitted when the orientation of the toolbar changes.
Parameters
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
The “popup-context-menu”
signal
gboolean 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.
Parameters
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
The “style-changed”
signal
void user_function (GtkToolbar *toolbar, GtkToolbarStyle style, gpointer user_data)
Emitted when the style of the toolbar changes.
Parameters
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