gtkmm  4.8.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::LayoutChild Class Reference

An object containing layout properties. More...

#include <gtkmm/layoutchild.h>

Inheritance diagram for Gtk::LayoutChild:
Inheritance graph
[legend]

Public Member Functions

 LayoutChild (LayoutChild && src) noexcept
 
LayoutChildoperator= (LayoutChild && src) noexcept
 
 ~LayoutChild () noexcept override
 
GtkLayoutChild * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkLayoutChild * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkLayoutChild * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::RefPtr< LayoutManagerget_layout_manager ()
 Retrieves the Gtk::LayoutManager instance that created the given layout_child. More...
 
Glib::RefPtr< const LayoutManagerget_layout_manager () const
 Retrieves the Gtk::LayoutManager instance that created the given layout_child. More...
 
Widgetget_child_widget ()
 Retrieves the Gtk::Widget associated to the given layout_child. More...
 
const Widgetget_child_widget () const
 Retrieves the Gtk::Widget associated to the given layout_child. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< LayoutManager > > property_layout_manager () const
 The layout manager that created the Gtk::LayoutChild instance. More...
 
Glib::PropertyProxy_ReadOnly< Widget * > property_child_widget () const
 The widget that is associated to the Gtk::LayoutChild instance. More...
 

Static Public Member Functions

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

Protected Member Functions

 LayoutChild ()
 There is no create() method that corresponds to this constructor, because only derived classes shall be created. More...
 

Related Functions

(Note that these are not member functions.)

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

Detailed Description

An object containing layout properties.

Gtk::LayoutChild is the base class for objects that are meant to hold layout properties. If a Gtk::LayoutManager has per-child properties, like their packing type, or the horizontal and vertical span, or the icon name, then the layout manager should use a Gtk::LayoutChild implementation to store those properties.

A Gtk::LayoutChild instance is only ever valid while a widget is part of a layout.

Since gtkmm 3.96:

Constructor & Destructor Documentation

◆ LayoutChild() [1/2]

Gtk::LayoutChild::LayoutChild ( LayoutChild &&  src)
noexcept

◆ ~LayoutChild()

Gtk::LayoutChild::~LayoutChild ( )
overridenoexcept

◆ LayoutChild() [2/2]

Gtk::LayoutChild::LayoutChild ( )
protected

There is no create() method that corresponds to this constructor, because only derived classes shall be created.

Member Function Documentation

◆ get_child_widget() [1/2]

Widget* Gtk::LayoutChild::get_child_widget ( )

Retrieves the Gtk::Widget associated to the given layout_child.

Returns
A Gtk::Widget.

◆ get_child_widget() [2/2]

const Widget* Gtk::LayoutChild::get_child_widget ( ) const

Retrieves the Gtk::Widget associated to the given layout_child.

Returns
A Gtk::Widget.

◆ get_layout_manager() [1/2]

Glib::RefPtr<LayoutManager> Gtk::LayoutChild::get_layout_manager ( )

Retrieves the Gtk::LayoutManager instance that created the given layout_child.

Returns
A Gtk::LayoutManager.

◆ get_layout_manager() [2/2]

Glib::RefPtr<const LayoutManager> Gtk::LayoutChild::get_layout_manager ( ) const

Retrieves the Gtk::LayoutManager instance that created the given layout_child.

Returns
A Gtk::LayoutManager.

◆ get_type()

static GType Gtk::LayoutChild::get_type ( )
static

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

◆ gobj() [1/2]

GtkLayoutChild* Gtk::LayoutChild::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkLayoutChild* Gtk::LayoutChild::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkLayoutChild* Gtk::LayoutChild::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ operator=()

LayoutChild& Gtk::LayoutChild::operator= ( LayoutChild &&  src)
noexcept

◆ property_child_widget()

Glib::PropertyProxy_ReadOnly< Widget* > Gtk::LayoutChild::property_child_widget ( ) const

The widget that is associated to the Gtk::LayoutChild instance.

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

◆ property_layout_manager()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<LayoutManager> > Gtk::LayoutChild::property_layout_manager ( ) const

The layout manager that created the Gtk::LayoutChild instance.

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

Friends And Related Function Documentation

◆ wrap()

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