logo top
Main Page   Widgets   Namespaces   Book  

Gtk::Toolbar Class Reference
[WidgetsContainer Widgets]

Inheritance diagram for Gtk::Toolbar:

List of all members.


Detailed Description

Bars of buttons and other widgets.

Public Member Functions

void append (ToggleToolButton& item, const sigc::slot<void>& toggled_slot)
void append (ToolButton& item, const sigc::slot<void>& clicked_slot)
void append (ToolItem& item)
int get_drop_index (int x, int y) const
 Return value: The position corresponding to the point ( x, y) on the toolbar.
IconSize get_icon_size () const
 Retrieves the icon size for the toolbar.
int get_item_index (const ToolItem& item) const
 Return value: the position of item on the toolbar.
int get_n_items () const
 Return value: the number of items on the toolbar.
const ToolItemget_nth_item (int n) const
 Return value: The n'th Gtk::ToolItem on toolbar, or 0 if there.
ToolItemget_nth_item (int n)
 Return value: The n'th Gtk::ToolItem on toolbar, or 0 if there.
Orientation get_orientation () const
 Retrieves the current orientation of the toolbar.
ReliefStyle get_relief_style () const
 Return value: The relief style of buttons on toolbar.
bool get_show_arrow () const
 Return value: true if the toolbar has an overflow menu.
ToolbarStyle get_toolbar_style () const
 Retrieves whether the toolbar has text, icons, or both .
bool get_tooltips () const
 Retrieves whether tooltips are enabled.
Tooltipsget_tooltips_object () const
const GtkToolbar* gobj () const
 Provides access to the underlying C GtkObject.
GtkToolbar* gobj ()
 Provides access to the underlying C GtkObject.
void insert (ToggleToolButton& item, int pos, const sigc::slot<void>& toggled_slot)
void insert (ToolButton& item, int pos, const sigc::slot<void>& clicked_slot)
void insert (ToolItem& item, int pos)
 Insert a Gtk::ToolItem into the toolbar at position pos.
void prepend (ToggleToolButton& item, const sigc::slot<void>& toggled_slot)
void prepend (ToolButton& item, const sigc::slot<void>& clicked_slot)
void prepend (ToolItem& item)
Glib::PropertyProxy_ReadOnly
<Orientation
property_orientation () const
 The orientation of the orientable.
Glib::PropertyProxy<Orientationproperty_orientation ()
 The orientation of the orientable.
Glib::PropertyProxy_ReadOnly
<bool> 
property_show_arrow () const
 If an arrow should be shown if the toolbar doesn't fit.
Glib::PropertyProxy<bool> property_show_arrow ()
 If an arrow should be shown if the toolbar doesn't fit.
Glib::PropertyProxy_ReadOnly
<ToolbarStyle
property_toolbar_style () const
 How to draw the toolbar.
Glib::PropertyProxy<ToolbarStyleproperty_toolbar_style ()
 How to draw the toolbar.
void set_drop_highlight_item (ToolItem& tool_item, int 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.
void set_icon_size (IconSize icon_size)
 This function sets the size of stock icons in the toolbar.
void set_orientation (Orientation orientation)
 Sets whether a toolbar should appear horizontally or vertically.
void set_show_arrow (bool show_arrow=true)
 Sets whether to show an overflow menu when toolbar doesn't have room for all items on it.
void set_toolbar_style (ToolbarStyle style)
 Alters the view of toolbar to display either icons only, text only, or both.
void set_tooltips (bool enable=true)
 Sets if the tooltips of a toolbar should be active or not.
Glib::SignalProxy1< void,
Orientation
signal_orientation_changed ()
 Emitted when the orientation of the toolbar changes.
Glib::SignalProxy3< bool, int,
int, int > 
signal_popup_context_menu ()
 Emitted when the user right-clicks the toolbar or uses the keybinding to display a popup menu.
Glib::SignalProxy1< void,
ToolbarStyle
signal_toolbar_style_changed ()
 Emitted when the style of the toolbar changes.
 Toolbar ()
void unset_drop_highlight_item ()
void unset_icon_size ()
 Unsets toolbar icon size set with set_icon_size(), so that user preferences will be used to determine the icon size.
void unset_toolbar_style ()
 Unsets a toolbar style set with set_style(), so that user preferences will be used to determine the toolbar style.
virtual ~Toolbar ()

Protected Member Functions

virtual void on_orientation_changed (Orientation orientation)
virtual bool on_popup_context_menu (int x, int y, int button_number)
virtual void on_toolbar_style_changed (ToolbarStyle style)

Related Functions

(Note that these are not member functions.)

Gtk::Toolbarwrap (GtkToolbar* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Constructor & Destructor Documentation

virtual Gtk::Toolbar::~Toolbar (  )  [virtual]

Gtk::Toolbar::Toolbar (  ) 


Member Function Documentation

void Gtk::Toolbar::append ( ToggleToolButton item,
const sigc::slot< void > &  toggled_slot 
)

void Gtk::Toolbar::append ( ToolButton item,
const sigc::slot< void > &  clicked_slot 
)

void Gtk::Toolbar::append ( ToolItem item  ) 

int Gtk::Toolbar::get_drop_index ( int  x,
int  y 
) const

Return value: The position corresponding to the point ( x, y) on the toolbar.

Parameters:
x X coordinate of a point on the toolbar.
y Y coordinate of a point on the toolbar.
Returns:
The position corresponding to the point ( x, y) on the toolbar.
Since gtkmm 2.4:

IconSize Gtk::Toolbar::get_icon_size (  )  const

Retrieves the icon size for the toolbar.

See set_icon_size().

Returns:
The current icon size for the icons on the toolbar.

int Gtk::Toolbar::get_item_index ( const ToolItem item  )  const

Return value: the position of item on the toolbar.

Parameters:
item A Gtk::ToolItem that is a child of toolbar.
Returns:
The position of item on the toolbar.
Since gtkmm 2.4:

int Gtk::Toolbar::get_n_items (  )  const

Return value: the number of items on the toolbar.

Returns:
The number of items on the toolbar
Since gtkmm 2.4:

const ToolItem* Gtk::Toolbar::get_nth_item ( int  n  )  const

Return value: The n'th Gtk::ToolItem on toolbar, or 0 if there.

Parameters:
n A position on the toolbar.
Returns:
The n'th Gtk::ToolItem on toolbar, or 0 if there isn't an n'th item.
Since gtkmm 2.4:

ToolItem* Gtk::Toolbar::get_nth_item ( int  n  ) 

Return value: The n'th Gtk::ToolItem on toolbar, or 0 if there.

Parameters:
n A position on the toolbar.
Returns:
The n'th Gtk::ToolItem on toolbar, or 0 if there isn't an n'th item.
Since gtkmm 2.4:

Orientation Gtk::Toolbar::get_orientation (  )  const

Retrieves the current orientation of the toolbar.

See set_orientation().

Returns:
The orientation
Deprecated: 2.16: Use Gtk::Orientable::get_orientation() instead.

ReliefStyle Gtk::Toolbar::get_relief_style (  )  const

Return value: The relief style of buttons on toolbar.

Returns:
The relief style of buttons on toolbar.
Since gtkmm 2.4:

bool Gtk::Toolbar::get_show_arrow (  )  const

Return value: true if the toolbar has an overflow menu.

Returns:
true if the toolbar has an overflow menu.
Since gtkmm 2.4:

ToolbarStyle Gtk::Toolbar::get_toolbar_style (  )  const

Retrieves whether the toolbar has text, icons, or both .

See set_style().

Returns:
The current style of toolbar.

bool Gtk::Toolbar::get_tooltips (  )  const

Retrieves whether tooltips are enabled.

See set_tooltips().

Deprecated:
Use The toolkit-wide Gtk::Settings::property_gtk_enable_tooltips instead
Returns:
true if tooltips are enabled
Deprecated: 2.14: The toolkit-wide Gtk::Settings:gtk-enable-tooltips property is now used instead.

Tooltips* Gtk::Toolbar::get_tooltips_object (  )  const

Deprecated:
Use the Gtk::Tooltip API instead.

const GtkToolbar* Gtk::Toolbar::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Container.

GtkToolbar* Gtk::Toolbar::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Container.

void Gtk::Toolbar::insert ( ToggleToolButton item,
int  pos,
const sigc::slot< void > &  toggled_slot 
)

void Gtk::Toolbar::insert ( ToolButton item,
int  pos,
const sigc::slot< void > &  clicked_slot 
)

void Gtk::Toolbar::insert ( ToolItem item,
int  pos 
)

Insert a Gtk::ToolItem 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 gtkmm 2.4:
Parameters:
item A Gtk::ToolItem.
pos The position of the new item.

virtual void Gtk::Toolbar::on_orientation_changed ( Orientation  orientation  )  [protected, virtual]

virtual bool Gtk::Toolbar::on_popup_context_menu ( int  x,
int  y,
int  button_number 
) [protected, virtual]

virtual void Gtk::Toolbar::on_toolbar_style_changed ( ToolbarStyle  style  )  [protected, virtual]

void Gtk::Toolbar::prepend ( ToggleToolButton item,
const sigc::slot< void > &  toggled_slot 
)

void Gtk::Toolbar::prepend ( ToolButton item,
const sigc::slot< void > &  clicked_slot 
)

void Gtk::Toolbar::prepend ( ToolItem item  ) 

Glib::PropertyProxy_ReadOnly<Orientation> Gtk::Toolbar::property_orientation (  )  const

The orientation of the orientable.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Orientation> Gtk::Toolbar::property_orientation (  ) 

The orientation of the orientable.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::Toolbar::property_show_arrow (  )  const

If an arrow should be shown if the toolbar doesn't fit.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::Toolbar::property_show_arrow (  ) 

If an arrow should be shown if the toolbar doesn't fit.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<ToolbarStyle> Gtk::Toolbar::property_toolbar_style (  )  const

How to draw the toolbar.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<ToolbarStyle> Gtk::Toolbar::property_toolbar_style (  ) 

How to draw the toolbar.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

void Gtk::Toolbar::set_drop_highlight_item ( ToolItem tool_item,
int  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 0, 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.

Since gtkmm 2.4:
Parameters:
tool_item A Gtk::ToolItem, or 0 to turn of highlighting.
index A position on toolbar.

void Gtk::Toolbar::set_icon_size ( IconSize  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.

Since gtkmm 2.12:
Parameters:
icon_size The Gtk::IconSize that stock icons in the toolbar shall have.

void Gtk::Toolbar::set_orientation ( Orientation  orientation  ) 

Sets whether a toolbar should appear horizontally or vertically.

Deprecated: 2.16: Use Gtk::Orientable::set_orientation() instead.

Parameters:
orientation A new Gtk::Orientation.

void Gtk::Toolbar::set_show_arrow ( bool  show_arrow = true  ) 

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 gtkmm 2.4:
Parameters:
show_arrow Whether to show an overflow menu.

void Gtk::Toolbar::set_toolbar_style ( ToolbarStyle  style  ) 

Alters the view of toolbar to display either icons only, text only, or both.

Parameters:
style The new style for toolbar.

void Gtk::Toolbar::set_tooltips ( bool  enable = true  ) 

Sets if the tooltips of a toolbar should be active or not.

Deprecated: 2.14: The toolkit-wide Gtk::Settings:gtk-enable-tooltips property is now used instead.

Deprecated:
Use The toolkit-wide Gtk::Settings::property_gtk_enable_tooltips instead
Parameters:
enable Set to false to disable the tooltips, or true to enable them.

Glib::SignalProxy1<void,Orientation> Gtk::Toolbar::signal_orientation_changed (  ) 

Emitted when the orientation of the toolbar changes.

Parameters:
orientation The new Orientation of the toolbar.
Prototype:
void on_my_orientation_changed(Orientation orientation)

Glib::SignalProxy3< bool,int,int,int > Gtk::Toolbar::signal_popup_context_menu (  ) 

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:
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 true if the signal was handled, false if not.
Prototype:
bool on_my_popup_context_menu(int x, int y, int button_number)

Glib::SignalProxy1<void,ToolbarStyle> Gtk::Toolbar::signal_toolbar_style_changed (  ) 

Emitted when the style of the toolbar changes.

Parameters:
@style The new ToolbarStyle of the toolbar.
Prototype:
void on_my_toolbar_style_changed(ToolbarStyle style)

void Gtk::Toolbar::unset_drop_highlight_item (  ) 

void Gtk::Toolbar::unset_icon_size (  ) 

Unsets toolbar icon size set with set_icon_size(), so that user preferences will be used to determine the icon size.

Since gtkmm 2.12:

void Gtk::Toolbar::unset_toolbar_style (  ) 

Unsets a toolbar style set with set_style(), so that user preferences will be used to determine the toolbar style.


Friends And Related Function Documentation

Gtk::Toolbar* wrap ( GtkToolbar *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:

Generated for gtkmm 2.4 by Doxygen 1.5.6 © 1997-2001