Gtk::Orientable Class Reference

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

`#include <gtkmm/orientable.h>`

Inheritance diagram for Gtk::Orientable:
[legend]

## Public Member Functions

| Orientable (Orientable&& src) noexcept
Orientable& | operator= (Orientable&& src) noexcept
| ~Orientable () noexcept override
GtkOrientable* | gobj ()
| Provides access to the underlying C GObject. More...
const GtkOrientable* | gobj () const
| Provides access to the underlying C GObject. More...
void | set_orientation (Orientation orientation)
| Sets the orientation of the orientable. More...
Orientation | get_orientation () const
| Retrieves the orientation of the orientable. More...
Glib::PropertyProxy< Orientation > | property_orientation ()
| The orientation of the orientable. More...
Glib::PropertyProxy_ReadOnly< Orientation > | property_orientation () const
| The orientation of the orientable. More...

## 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. More...

## Protected Member Functions

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

## Related Functions

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

## 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

## Orientable() [1/2]

Gtk::Orientable::Orientable | ( |  | ) |

protected

You should derive from this class to use it.

## Orientable() [2/2]

Gtk::Orientable::Orientable | ( | Orientable&& | src | ) |

noexcept

## ~Orientable()

Gtk::Orientable::~Orientable | ( |  | ) |

override noexcept

## Member Function Documentation

## add_interface()

static void Gtk::Orientable::add_interface | ( | GType | gtype_implementer | ) |

static

## get_orientation()

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

Retrieves the orientation of the orientable.

Since gtkmm 2.16:

Returns
  The orientation of the orientable.

## get_type()

static GType Gtk::Orientable::get_type | ( |  | ) |

static

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

## gobj() [1/2]

GtkOrientable* Gtk::Orientable::gobj | ( |  | ) |

inline

Provides access to the underlying C GObject.

## gobj() [2/2]

const GtkOrientable* Gtk::Orientable::gobj | ( |  | ) | const

inline

Provides access to the underlying C GObject.

## operator=()

Orientable& Gtk::Orientable::operator= | ( | Orientable&& | src | ) |

noexcept

## property_orientation() [1/2]

Glib::PropertyProxy< Orientation > Gtk::Orientable::property_orientation | ( |  | ) |

The orientation of the orientable.

Since gtkmm 2.16:

Default value: Gtk::ORIENTATION_HORIZONTAL

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

## property_orientation() [2/2]

Glib::PropertyProxy_ReadOnly< Orientation > Gtk::Orientable::property_orientation | ( |  | ) | const

The orientation of the orientable.

Since gtkmm 2.16:

Default value: Gtk::ORIENTATION_HORIZONTAL

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

## set_orientation()

void Gtk::Orientable::set_orientation | ( | Orientation | orientation | ) |

Sets the orientation of the orientable.

Since gtkmm 2.16:

Parameters

  orientation | The orientable’s new orientation.

## Friends And Related Function Documentation

## wrap()

Glib::RefPtr< Gtk::Orientable > wrap | ( | GtkOrientable * | 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.