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

A layout manager for bin-like widgets. More...

#include <gtkmm/binlayout.h>

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

Public Member Functions

 BinLayout (BinLayout && src) noexcept
 
BinLayoutoperator= (BinLayout && src) noexcept
 
 ~BinLayout () noexcept override
 
GtkBinLayout * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkBinLayout * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkBinLayout * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
- Public Member Functions inherited from Gtk::LayoutManager
 LayoutManager (LayoutManager && src) noexcept
 
LayoutManageroperator= (LayoutManager && src) noexcept
 
 ~LayoutManager () noexcept override
 
GtkLayoutManager * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkLayoutManager * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkLayoutManager * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
void measure (Widget & widget, Orientation orientation, int for_size, int & minimum, int & natural, int & minimum_baseline, int & natural_baseline) const
 Measures the size of the widget using manager, for the given orientation and size. More...
 
void allocate (Widget & widget, int width, int height, int baseline)
 Assigns the given width, height, and baseline to a widget, and computes the position and sizes of the children of the widget using the layout management policy of manager. More...
 
SizeRequestMode get_request_mode () const
 Retrieves the request mode of manager. More...
 
Widgetget_widget ()
 Retrieves the Gtk::Widget using the given Gtk::LayoutManager. More...
 
const Widgetget_widget () const
 Retrieves the Gtk::Widget using the given Gtk::LayoutManager. More...
 
void layout_changed ()
 Queues a resize on the Gtk::Widget using manager, if any. More...
 
Glib::RefPtr< LayoutChildget_layout_child (Widget & child)
 Retrieves a Gtk::LayoutChild instance for the Gtk::LayoutManager, creating one if necessary. More...
 
Glib::RefPtr< const LayoutChildget_layout_child (Widget & child) const
 Retrieves a Gtk::LayoutChild instance for the Gtk::LayoutManager, creating one if necessary. More...
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static Glib::RefPtr< BinLayoutcreate ()
 
- Static Public Member Functions inherited from Gtk::LayoutManager
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Protected Member Functions

 BinLayout ()
 
- Protected Member Functions inherited from Gtk::LayoutManager
 LayoutManager ()
 There is no create() method that corresponds to this constructor, because only derived classes shall be created. More...
 
virtual SizeRequestMode get_request_mode_vfunc (const Widget & widget) const
 
virtual void measure_vfunc (const Widget & widget, Orientation orientation, int for_size, int & minimum, int & natural, int & minimum_baseline, int & natural_baseline) const
 
virtual void allocate_vfunc (const Widget & widget, int width, int height, int baseline)
 
virtual Glib::RefPtr< LayoutChildcreate_layout_child_vfunc (const Widget & widget, const Widget & for_child)
 
virtual void root_vfunc ()
 
virtual void unroot_vfunc ()
 

Related Functions

(Note that these are not member functions.)

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

Detailed Description

A layout manager for bin-like widgets.

Gtk::BinLayout is a Gtk::LayoutManager subclass useful for creating "bins" of widgets. Gtk::BinLayout will stack each child of a widget on top of each other, using Gtk::Widget::property_hexpand(), Gtk::Widget::property_vexpand(), Gtk::Widget::property_halign(), and Gtk::Widget::property_valign() of each child to determine where they should be positioned.

Since gtkmm 3.96:

Constructor & Destructor Documentation

◆ BinLayout() [1/2]

Gtk::BinLayout::BinLayout ( BinLayout &&  src)
noexcept

◆ ~BinLayout()

Gtk::BinLayout::~BinLayout ( )
overridenoexcept

◆ BinLayout() [2/2]

Gtk::BinLayout::BinLayout ( )
protected

Member Function Documentation

◆ create()

static Glib::RefPtr< BinLayout > Gtk::BinLayout::create ( )
static

◆ get_type()

static GType Gtk::BinLayout::get_type ( )
static

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

◆ gobj() [1/2]

GtkBinLayout * Gtk::BinLayout::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkBinLayout * Gtk::BinLayout::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkBinLayout * Gtk::BinLayout::gobj_copy ( )

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

◆ operator=()

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

Friends And Related Function Documentation

◆ wrap()

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