Gtk::ToolShell Class Reference

#include <toolshell.h>

Inheritance diagram for Gtk::ToolShell:

Public Member Functions
virtual	~ToolShell ()
GtkToolShell *	gobj ()
	Provides access to the underlying C GObject. More...
const GtkToolShell *	gobj () const
	Provides access to the underlying C GObject. More...
IconSize	get_icon_size () const
Orientation	get_orientation () const
ToolbarStyle	get_style () const
ReliefStyle	get_relief_style () const
void	rebuild_menu ()
Orientation	get_text_orientation () const
float	get_text_alignment () const
Pango::EllipsizeMode	get_ellipsize_mode () const
Glib::RefPtr< SizeGroup >	get_text_size_group ()
Glib::RefPtr< const SizeGroup >	get_text_size_group () const

Static Public Member Functions
static void	add_interface (GType gtype_implementer)
static GType	get_type () G_GNUC_CONST

Protected Member Functions
	ToolShell ()
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)

Detailed Description

A base class for containers containing ToolItem widgets. This interface allows container widgets to provide additional information when embedding ToolItem widgets.

Definition at line 60 of file toolshell.h.

Constructor & Destructor Documentation

ToolShell()

Gtk::ToolShell::ToolShell ( )

protected

You should derive from this class to use it.

~ToolShell()

virtual Gtk::ToolShell::~ToolShell ( )

virtual

Member Function Documentation

add_interface()

static void Gtk::ToolShell::add_interface ( GType  gtype_implementer )

static

get_ellipsize_mode()

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.

Returns

The current ellipsize mode of shell.

get_icon_size()

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.

Returns

The current size for icons of shell.

get_icon_size_vfunc()

virtual IconSize Gtk::ToolShell::get_icon_size_vfunc ( )

protectedvirtual

get_orientation()

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.

Returns

The current orientation of shell.

get_orientation_vfunc()

virtual Orientation Gtk::ToolShell::get_orientation_vfunc ( )

protectedvirtual

get_relief_style()

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.

Returns

The relief style of buttons on shell.

get_relief_style_vfunc()

virtual ReliefStyle Gtk::ToolShell::get_relief_style_vfunc ( )

protectedvirtual

get_style()

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.

Returns

The current style of shell.

get_style_vfunc()

virtual ToolbarStyle Gtk::ToolShell::get_style_vfunc ( )

protectedvirtual

get_text_alignment()

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.

Returns

The current text alignment of shell.

get_text_orientation()

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.

Returns

The current text orientation of shell.

get_text_size_group() [1/2]

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.

Returns

The current text size group of shell.

get_text_size_group() [2/2]

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.

Returns

The current text size group of shell.

get_type()

static GType Gtk::ToolShell::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

gobj() [1/2]

GtkToolShell* Gtk::ToolShell::gobj ( )

inline

Provides access to the underlying C GObject.

Definition at line 118 of file toolshell.h.

gobj() [2/2]

const GtkToolShell* Gtk::ToolShell::gobj ( ) const

inline

Provides access to the underlying C GObject.

Definition at line 121 of file toolshell.h.

rebuild_menu()

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.

rebuild_menu_vfunc()

virtual void Gtk::ToolShell::rebuild_menu_vfunc ( )

protectedvirtual

Friends And Related Function Documentation

wrap()

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:

• toolshell.h