gtkmm: Gtk::ToolShell Class Reference

# Gtk::ToolShell Class Reference

A base class for containers containing ToolItem widgets. More...

Inherits Glib::Interface.

Inherited by Gtk::ToolItemGroup.

Collaboration diagram for Gtk::ToolShell:
[legend]

List of all members.

## Public Member Functions

virtual | ~ToolShell ()
GtkToolShell* | gobj ()
| Provides access to the underlying C GObject.
const GtkToolShell* | gobj () const
| Provides access to the underlying C GObject.
IconSize | get_icon_size () const
| Retrieves the icon size for the tool shell.
Orientation | get_orientation () const
| Retrieves the current orientation for the tool shell.
ToolbarStyle | get_style () const
| Retrieves whether the tool shell has text, icons, or both.
ReliefStyle | get_relief_style () const
| Returns the relief style of buttons on shell.
void | rebuild_menu ()
| Calling this function signals the tool shell that the overflow menu item for tool items have changed.
Orientation | get_text_orientation () const
| Retrieves the current text orientation for the tool shell.
float | get_text_alignment () const
| Retrieves the current text alignment for the tool shell.
Pango::EllipsizeMode | get_ellipsize_mode () const
| Retrieves the current ellipsize mode for the tool shell.
Glib::RefPtr< SizeGroup > | get_text_size_group ()
| Retrieves the current text size group for the tool shell.
Glib::RefPtr< const SizeGroup > | get_text_size_group () const
| Retrieves the current text size group for the tool shell.

## Static Public Member Functions

static void | add_interface (GType gtype_implementer)

## Protected Member Functions

virtual IconSize | get_icon_size_vfunc ()
virtual Orientation | get_orientation_vfunc ()
virtual ToolbarStyle | get_style_vfunc ()
virtual ReliefStyle | get_relief_style_vfunc ()
virtual void | rebuild_menu_vfunc ()

## Related Functions

(Note that these are not member functions.)
Glib::RefPtr< Gtk::ToolShell > | wrap (GtkToolShell* object, bool take_copy=false)
| A Glib::wrap() method for this object.

## Detailed Description

A base class for containers containing ToolItem widgets.

This interface allows container widgets to provide additional information when embedding ToolItem widgets.

Since gtkmm 2.14:

## Constructor & Destructor Documentation

virtual Gtk::ToolShell::~ToolShell | ( |  | ) | `[virtual]`

## Member Function Documentation

static void Gtk::ToolShell::add_interface | ( | GType | gtype_implementer | ) | `[static]`

Pango::EllipsizeMode Gtk::ToolShell::get_ellipsize_mode | ( |  | ) | const

Retrieves the current ellipsize mode for the tool shell.

Tool items must not call this function directly, but rely on Gtk::ToolItem::get_ellipsize_mode() instead.

Since gtkmm 2.14:

Returns:
  The current ellipsize mode of shell.

IconSize Gtk::ToolShell::get_icon_size | ( |  | ) | const

Retrieves the icon size for the tool shell.

Tool items must not call this function directly, but rely on Gtk::ToolItem::get_icon_size() instead.

Since gtkmm 2.14:

Returns:
  The current size for icons of shell.

virtual IconSize Gtk::ToolShell::get_icon_size_vfunc | ( |  | ) | `[protected, virtual]`

Orientation Gtk::ToolShell::get_orientation | ( |  | ) | const

Retrieves the current orientation for the tool shell.

Tool items must not call this function directly, but rely on Gtk::ToolItem::get_orientation() instead.

Since gtkmm 2.14:

Returns:
  The current orientation of shell.

virtual Orientation Gtk::ToolShell::get_orientation_vfunc | ( |  | ) | `[protected, virtual]`

ReliefStyle Gtk::ToolShell::get_relief_style | ( |  | ) | const

Returns the relief style of buttons on shell.

Tool items must not call this function directly, but rely on Gtk::ToolItem::get_relief_style() instead.

Since gtkmm 2.14:

Returns:
  The relief style of buttons on shell.

virtual ReliefStyle Gtk::ToolShell::get_relief_style_vfunc | ( |  | ) | `[protected, virtual]`

ToolbarStyle Gtk::ToolShell::get_style | ( |  | ) | const

Retrieves whether the tool shell has text, icons, or both.

Tool items must not call this function directly, but rely on gtk_tool_item_get_style() instead.

Since gtkmm 2.14:

Returns:
  The current style of shell.

virtual ToolbarStyle Gtk::ToolShell::get_style_vfunc | ( |  | ) | `[protected, virtual]`

float Gtk::ToolShell::get_text_alignment | ( |  | ) | const

Retrieves the current text alignment for the tool shell.

Tool items must not call this function directly, but rely on Gtk::ToolItem::get_text_alignment() instead.

Since gtkmm 2.14:

Returns:
  The current text alignment of shell.

Orientation Gtk::ToolShell::get_text_orientation | ( |  | ) | const

Retrieves the current text orientation for the tool shell.

Tool items must not call this function directly, but rely on Gtk::ToolItem::get_text_orientation() instead.

Since gtkmm 2.14:

Returns:
  The current text orientation of shell.

Glib::RefPtr<const SizeGroup> Gtk::ToolShell::get_text_size_group | ( |  | ) | const

Retrieves the current text size group for the tool shell.

Tool items must not call this function directly, but rely on Gtk::ToolItem::get_text_size_group() instead.

Since gtkmm 2.14:

Returns:
  The current text size group of shell.

Glib::RefPtr<SizeGroup> Gtk::ToolShell::get_text_size_group | ( |  | ) |

Retrieves the current text size group for the tool shell.

Tool items must not call this function directly, but rely on Gtk::ToolItem::get_text_size_group() instead.

Since gtkmm 2.14:

Returns:
  The current text size group of shell.

const GtkToolShell* Gtk::ToolShell::gobj | ( |  | ) | const`[inline]`

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gtk::ToolItemGroup.

GtkToolShell* Gtk::ToolShell::gobj | ( |  | ) | `[inline]`

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gtk::ToolItemGroup.

void Gtk::ToolShell::rebuild_menu | ( |  | ) |

Calling this function signals the tool shell that the overflow menu item for tool items have changed.

If there is an overflow menu and if it is visible when this function it called, the menu will be rebuilt.

Tool items must not call this function directly, but rely on Gtk::ToolItem::rebuild_menu() instead.

Since gtkmm 2.14:

virtual void Gtk::ToolShell::rebuild_menu_vfunc | ( |  | ) | `[protected, virtual]`

## Friends And Related Function Documentation

Glib::RefPtr< Gtk::ToolShell > wrap | ( | GtkToolShell * | 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:

- gtkmm/toolshell.h