![]() |
![]() |
![]() |
GTK+ 3 Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
#include <gtk/gtk.h> GtkToolbar; enum GtkToolbarSpaceStyle; GtkWidget * gtk_toolbar_new (void
); void gtk_toolbar_insert (GtkToolbar *toolbar
,GtkToolItem *item
,gint pos
); gint gtk_toolbar_get_item_index (GtkToolbar *toolbar
,GtkToolItem *item
); gint gtk_toolbar_get_n_items (GtkToolbar *toolbar
); GtkToolItem * gtk_toolbar_get_nth_item (GtkToolbar *toolbar
,gint n
); gint gtk_toolbar_get_drop_index (GtkToolbar *toolbar
,gint x
,gint y
); void gtk_toolbar_set_drop_highlight_item (GtkToolbar *toolbar
,GtkToolItem *tool_item
,gint index_
); void gtk_toolbar_set_show_arrow (GtkToolbar *toolbar
,gboolean show_arrow
); void gtk_toolbar_unset_icon_size (GtkToolbar *toolbar
); gboolean gtk_toolbar_get_show_arrow (GtkToolbar *toolbar
); GtkToolbarStyle gtk_toolbar_get_style (GtkToolbar *toolbar
); GtkIconSize gtk_toolbar_get_icon_size (GtkToolbar *toolbar
); GtkReliefStyle gtk_toolbar_get_relief_style (GtkToolbar *toolbar
); void gtk_toolbar_set_style (GtkToolbar *toolbar
,GtkToolbarStyle style
); void gtk_toolbar_set_icon_size (GtkToolbar *toolbar
,GtkIconSize icon_size
); void gtk_toolbar_unset_style (GtkToolbar *toolbar
);
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.
typedef enum { GTK_TOOLBAR_SPACE_EMPTY, GTK_TOOLBAR_SPACE_LINE } GtkToolbarSpaceStyle;
GtkWidget * gtk_toolbar_new (void
);
Creates a new toolbar.
Returns : |
the newly-created toolbar. |
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.
|
a GtkToolbar |
|
a GtkToolItem |
|
the position of the new item |
Since 2.4
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.
|
a GtkToolbar |
|
a GtkToolItem that is a child of toolbar
|
Returns : |
the position of item on the toolbar. |
Since 2.4
gint gtk_toolbar_get_n_items (GtkToolbar *toolbar
);
Returns the number of items on the toolbar.
|
a GtkToolbar |
Returns : |
the number of items on the toolbar |
Since 2.4
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.
|
a GtkToolbar |
|
A position on the toolbar |
Returns : |
The n 'th GtkToolItem on toolbar ,
or NULL if there isn't an n 'th item. [transfer none]
|
Since 2.4
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.
|
a GtkToolbar |
|
x coordinate of a point on the toolbar |
|
y coordinate of a point on the toolbar |
Returns : |
The position corresponding to the point (x , y ) on the toolbar.
|
Since 2.4
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.
|
a GtkToolbar |
|
a GtkToolItem, or NULL to turn of highlighting. [allow-none]
|
|
a position on toolbar
|
Since 2.4
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.
|
a GtkToolbar |
|
Whether to show an overflow menu |
Since 2.4
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.
|
a GtkToolbar |
gboolean gtk_toolbar_get_show_arrow (GtkToolbar *toolbar
);
Returns whether the toolbar has an overflow menu.
See gtk_toolbar_set_show_arrow()
.
|
a GtkToolbar |
Returns : |
TRUE if the toolbar has an overflow menu.
|
Since 2.4
GtkToolbarStyle gtk_toolbar_get_style (GtkToolbar *toolbar
);
Retrieves whether the toolbar has text, icons, or both . See
gtk_toolbar_set_style()
.
|
a GtkToolbar |
Returns : |
the current style of toolbar
|
GtkIconSize gtk_toolbar_get_icon_size (GtkToolbar *toolbar
);
Retrieves the icon size for the toolbar. See gtk_toolbar_set_icon_size()
.
|
a GtkToolbar |
Returns : |
the current icon size for the icons on the toolbar. [type int] |
GtkReliefStyle gtk_toolbar_get_relief_style (GtkToolbar *toolbar
);
Returns the relief style of buttons on toolbar
. See
gtk_button_set_relief()
.
|
a GtkToolbar |
Returns : |
The relief style of buttons on toolbar .
|
Since 2.4
void gtk_toolbar_set_style (GtkToolbar *toolbar
,GtkToolbarStyle style
);
Alters the view of toolbar
to display either icons only, text only, or both.
|
a GtkToolbar. |
|
the new style for toolbar .
|
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.
|
A GtkToolbar |
|
The GtkIconSize that stock icons in the toolbar shall have. [type int] |
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.
|
a GtkToolbar |