gtkmm: Gtk::Orientable Class Reference

This interface is implemented by all widgets that can be oriented horizontally or vertically. More...

Inheritance diagram for Gtk::Orientable:

List of all members.

Public Member Functions

virtual ~Orientable ()
GtkOrientable* gobj ()
 Provides access to the underlying C GObject.

const GtkOrientable* gobj () const
 Provides access to the underlying C GObject.

void set_orientation (Orientation orientation)
 Sets the orientation of the orientable.

Orientation get_orientation () const
 Retrieves the orientation of the orientable.

Glib::PropertyProxy< Orientationproperty_orientation ()
 The orientation of the orientable.

Glib::PropertyProxy_ReadOnly

< Orientation
property_orientation () const
 The orientation of the orientable.

- Public Member Functions inherited from Glib::Interface
 Interface (const Glib::Interface_Class &interface_class)
 Interface (GObject *castitem)
virtual ~Interface ()
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
void set_property (const Glib::ustring &property_name, const PropertyType &value)
void get_property (const Glib::ustring &property_name, PropertyType &value) const
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
void freeze_notify ()
void thaw_notify ()
virtual void reference () const
virtual void unreference () const
GObject * gobj_copy () const

Static Public Member Functions

static void add_interface (GType gtype_implementer)
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.

Protected Member Functions

 Orientable ()
 You should derive from this class to use it.

- Protected Member Functions inherited from Glib::Interface
 ObjectBase ()
 ObjectBase (const char *custom_type_name)
 ObjectBase (const std::type_info &custom_type_info)
virtual ~ObjectBase ()=0
void initialize (GObject *castitem)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gtk::Orientablewrap (GtkOrientable* object, bool take_copy=false)
 A Glib::wrap() method for this object.


Detailed Description

This interface is implemented by all widgets that can be oriented horizontally or vertically.

Historically, such widgets have been realized as subclasses of a common base class (e.g GtkBox/GtkHBox/GtkVBox and GtkScale/GtkHScale/GtkVScale). GtkOrientable is more flexible in that it allows the orientation to be changed at runtime, allowing the widgets to 'flip'.

Since gtkmm 2.16:

Constructor & Destructor Documentation

Gtk::Orientable::Orientable ( )
protected

You should derive from this class to use it.

virtual Gtk::Orientable::~Orientable ( )
virtual

Member Function Documentation

static void Gtk::Orientable::add_interface ( GType  gtype_implementer)
static
Orientation Gtk::Orientable::get_orientation ( ) const

Retrieves the orientation of the orientable.

Since gtkmm 2.16:
Returns:
The orientation of the orientable.
Glib::PropertyProxy< Orientation > Gtk::Orientable::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< Orientation > Gtk::Orientable::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.
void Gtk::Orientable::set_orientation ( Orientation  orientation)

Sets the orientation of the orientable.

Since gtkmm 2.16:
Parameters:
orientationThe orientable's new orientation.

Friends And Related Function Documentation

Glib::RefPtr< Gtk::Orientable > wrap ( GtkOrientable *  object,
bool  take_copy = false 
)
related

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

Parameters:
objectThe C instance.
take_copyFalse 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/orientable.h