--- name: "Gtk2::Toolbar" section: "3pm" platform: "linux" package: "libgtk2-perl-doc" version: "2:1.24992-1" release: "Debian 10 (Buster)" platforms: ["linux"] url: "https://new.carta.tech/Gtk2::Toolbar" --- # Gtk2::Toolbar(3pm) wrapper for GtkToolbar ## NAME Gtk2::Toolbar - wrapper for GtkToolbar ## HIERARCHY ``` Glib::Object +----Glib::InitiallyUnowned +----Gtk2::Object +----Gtk2::Widget +----Gtk2::Container +----Gtk2::Toolbar ``` ## INTERFACES ``` Glib::Object::_Unregistered::AtkImplementorIface Gtk2::Buildable Gtk2::ToolShell Gtk2::Orientable ``` ## METHODS ### widget = Gtk2::Toolbar-\>new ### widget = $toolbar-\>append\_element ($type, $widget, $text, $tooltip\_text, $tooltip\_private\_text, $icon, $callback=undef, $user\_data=undef) - • `$type` (Gtk2::ToolbarChildType) - • `$widget` (Gtk2::Widget or undef) - • `$text` (string) - • `$tooltip_text` (string or undef) - • `$tooltip_private_text` (string or undef) - • `$icon` (Gtk2::Widget or undef) - • `$callback` (subroutine) - • `$user_data` (scalar) ### widget = $toolbar-\>append\_item ($text, $tooltip\_text, $tooltip\_private\_text, $icon, $callback=undef, $user\_data=undef) - • `$text` (string) - • `$tooltip_text` (string or undef) - • `$tooltip_private_text` (string or undef) - • `$icon` (Gtk2::Widget or undef) - • `$callback` (subroutine) - • `$user_data` (scalar) ### $toolbar-\>append\_space ### $toolbar-\>append\_widget ($widget, $tooltip\_text, $tooltip\_private\_text) - • `$widget` (Gtk2::Widget) - • `$tooltip_text` (string or undef) - • `$tooltip_private_text` (string or undef) ### $toolbar-\>set\_drop\_highlight\_item ($tool\_item, $index) - • `$tool_item` (Gtk2::ToolItem or undef) - • `$index` (integer) Since: gtk+ 2.4 ### integer = $toolbar-\>get\_drop\_index ($x, $y) - • `$x` (integer) - • `$y` (integer) Since: gtk+ 2.4 ### iconsize = $toolbar-\>get\_icon\_size ### $toolbar-\>set\_icon\_size ($icon\_size) - • `$icon_size` (Gtk2::IconSize) ### $toolbar-\>insert ($item, $pos) - • `$item` (Gtk2::ToolItem) - • `$pos` (integer) Since: gtk+ 2.4 ### widget = $toolbar-\>insert\_element ($type, $widget, $text, $tooltip\_text, $tooltip\_private\_text, $icon, $callback, $user\_data, $position) - • `$type` (Gtk2::ToolbarChildType) - • `$widget` (Gtk2::Widget or undef) - • `$text` (string) - • `$tooltip_text` (string or undef) - • `$tooltip_private_text` (string or undef) - • `$icon` (Gtk2::Widget or undef) - • `$callback` (subroutine) - • `$user_data` (scalar) - • `$position` (integer) ### widget = $toolbar-\>insert\_item ($text, $tooltip\_text, $tooltip\_private\_text, $icon, $callback, $user\_data, $position) - • `$text` (string) - • `$tooltip_text` (string or undef) - • `$tooltip_private_text` (string or undef) - • `$icon` (Gtk2::Widget or undef) - • `$callback` (subroutine) - • `$user_data` (scalar) - • `$position` (integer) ### $toolbar-\>insert\_space ($position) - • `$position` (integer) ### widget = $toolbar-\>insert\_stock ($stock\_id, $tooltip\_text, $tooltip\_private\_text, $callback, $user\_data, $position) - • `$stock_id` (string) - • `$tooltip_text` (string or undef) - • `$tooltip_private_text` (string or undef) - • `$callback` (subroutine) - • `$user_data` (scalar) - • `$position` (integer) ### $toolbar-\>insert\_widget ($widget, $tooltip\_text, $tooltip\_private\_text, $position) - • `$widget` (Gtk2::Widget) - • `$tooltip_text` (string or undef) - • `$tooltip_private_text` (string or undef) - • `$position` (integer) ### integer = $toolbar-\>get\_item\_index ($item) - • `$item` (Gtk2::ToolItem) Since: gtk+ 2.4 ### integer = $toolbar-\>get\_n\_items Since: gtk+ 2.4 ### toolitem or undef = $toolbar-\>get\_nth\_item ($n) - • `$n` (integer) Since: gtk+ 2.4 ### orientation = $toolbar-\>get\_orientation ### $toolbar-\>set\_orientation ($orientation) - • `$orientation` (Gtk2::Orientation) ### widget = $toolbar-\>prepend\_element ($type, $widget, $text, $tooltip\_text, $tooltip\_private\_text, $icon, $callback=undef, $user\_data=undef) - • `$type` (Gtk2::ToolbarChildType) - • `$widget` (Gtk2::Widget or undef) - • `$text` (string) - • `$tooltip_text` (string or undef) - • `$tooltip_private_text` (string or undef) - • `$icon` (Gtk2::Widget or undef) - • `$callback` (subroutine) - • `$user_data` (scalar) ### widget = $toolbar-\>prepend\_item ($text, $tooltip\_text, $tooltip\_private\_text, $icon, $callback=undef, $user\_data=undef) - • `$text` (string) - • `$tooltip_text` (string or undef) - • `$tooltip_private_text` (string or undef) - • `$icon` (Gtk2::Widget or undef) - • `$callback` (subroutine) - • `$user_data` (scalar) ### $toolbar-\>prepend\_space ### $toolbar-\>prepend\_widget ($widget, $tooltip\_text, $tooltip\_private\_text) - • `$widget` (Gtk2::Widget) - • `$tooltip_text` (string or undef) - • `$tooltip_private_text` (string or undef) ### reliefstyle = $toolbar-\>get\_relief\_style Since: gtk+ 2.4 ### $toolbar-\>remove\_space ($position) - • `$position` (integer) ### boolean = $toolbar-\>get\_show\_arrow Since: gtk+ 2.4 ### $toolbar-\>set\_show\_arrow ($show\_arrow) - • `$show_arrow` (boolean) Since: gtk+ 2.4 ### toolbarstyle = $toolbar-\>get\_style ### $toolbar-\>set\_style ($style) - • `$style` (Gtk2::ToolbarStyle) ### boolean = $toolbar-\>get\_tooltips ### $toolbar-\>set\_tooltips ($enable) - • `$enable` (boolean) ### $toolbar-\>unset\_icon\_size ### $toolbar-\>unset\_style ## PROPERTIES - 'icon-size' (integer : default 3 : readable / writable / private) Size of icons in this toolbar - 'icon-size-set' (boolean : default false : readable / writable / private) Whether the icon-size property has been set - 'show-arrow' (boolean : default true : readable / writable / private) If an arrow should be shown if the toolbar doesn't fit - 'toolbar-style' (Gtk2::ToolbarStyle : default "both" : readable / writable / private) How to draw the toolbar - 'tooltips' (boolean : default true : readable / writable / private) If the tooltips of the toolbar should be active or not ## CHILD PROPERTIES - 'expand' (boolean : default false : readable / writable / private) Whether the item should receive extra space when the toolbar grows - 'homogeneous' (boolean : default false : readable / writable / private) Whether the item should be the same size as other homogeneous items ## STYLE PROPERTIES - 'button-relief' (Gtk2::ReliefStyle : default "none" : readable / private) Type of bevel around toolbar buttons - 'internal-padding' (integer : default 0 : readable / private) Amount of border space between the toolbar shadow and the buttons - 'max-child-expand' (integer : default INT\_MAX : readable / private) Maximum amount of space an expandable item will be given - 'shadow-type' (Gtk2::ShadowType : default "out" : readable / private) Style of bevel around the toolbar - 'space-size' (integer : default 12 : readable / private) Size of spacers - 'space-style' (Gtk2::ToolbarSpaceStyle : default "line" : readable / private) Whether spacers are vertical lines or just blank ## SIGNALS - boolean = **focus-home-or-end** (Gtk2::Toolbar, boolean) - **orientation-changed** (Gtk2::Toolbar, Gtk2::Orientation) - boolean = **popup-context-menu** (Gtk2::Toolbar, integer, integer, integer) - **style-changed** (Gtk2::Toolbar, Gtk2::ToolbarStyle) ## ENUMS AND FLAGS ### enum Gtk2::IconSize - • 'invalid' / 'GTK\_ICON\_SIZE\_INVALID' - • 'menu' / 'GTK\_ICON\_SIZE\_MENU' - • 'small-toolbar' / 'GTK\_ICON\_SIZE\_SMALL\_TOOLBAR' - • 'large-toolbar' / 'GTK\_ICON\_SIZE\_LARGE\_TOOLBAR' - • 'button' / 'GTK\_ICON\_SIZE\_BUTTON' - • 'dnd' / 'GTK\_ICON\_SIZE\_DND' - • 'dialog' / 'GTK\_ICON\_SIZE\_DIALOG' ### enum Gtk2::Orientation - • 'horizontal' / 'GTK\_ORIENTATION\_HORIZONTAL' - • 'vertical' / 'GTK\_ORIENTATION\_VERTICAL' ### enum Gtk2::ReliefStyle - • 'normal' / 'GTK\_RELIEF\_NORMAL' - • 'half' / 'GTK\_RELIEF\_HALF' - • 'none' / 'GTK\_RELIEF\_NONE' ### enum Gtk2::ToolbarChildType - • 'space' / 'GTK\_TOOLBAR\_CHILD\_SPACE' - • 'button' / 'GTK\_TOOLBAR\_CHILD\_BUTTON' - • 'togglebutton' / 'GTK\_TOOLBAR\_CHILD\_TOGGLEBUTTON' - • 'radiobutton' / 'GTK\_TOOLBAR\_CHILD\_RADIOBUTTON' - • 'widget' / 'GTK\_TOOLBAR\_CHILD\_WIDGET' ### enum Gtk2::ToolbarStyle - • 'icons' / 'GTK\_TOOLBAR\_ICONS' - • 'text' / 'GTK\_TOOLBAR\_TEXT' - • 'both' / 'GTK\_TOOLBAR\_BOTH' - • 'both-horiz' / 'GTK\_TOOLBAR\_BOTH\_HORIZ' ## SEE ALSO Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container ## COPYRIGHT Copyright (C) 2003-2011 by the gtk2-perl team. This software is licensed under the LGPL. See Gtk2 for a full notice.