gdlmm  3.7.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gdl::DockLayout Class Reference

Inherits Object.

Public Member Functions

 DockLayout (DockLayout&& src) noexcept
 
DockLayoutoperator= (DockLayout&& src) noexcept
 
 ~DockLayout () noexcept override
 
GdlDockLayout* gobj ()
 Provides access to the underlying C GObject. More...
 
const GdlDockLayout* gobj () const
 Provides access to the underlying C GObject. More...
 
GdlDockLayout* 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 attach (const Glib::RefPtr< DockMaster >& master)
 
bool load_layout (const Glib::ustring& name)
 
void save_layout (const Glib::ustring& name)
 
void delete_layout (const Glib::ustring& name)
 
std::vector< Glib::ustring > get_layouts (bool include_default)
 
bool load_from_file (const std::string& filename)
 
bool save_to_file (const std::string& filename)
 
bool is_dirty () const
 
Glib::PropertyProxy_ReadOnly< bool > property_dirty () const
 True if the layouts have changed and need to be saved to a file. More...
 
Glib::PropertyProxy< Glib::RefPtr< DockMaster > > property_master ()
 GdlDockMaster or GdlDockObject object which the layout object is attached to. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< DockMaster > > property_master () const
 GdlDockMaster or GdlDockObject object which the layout object is attached to. 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< DockLayoutcreate (Dock& dock)
 

Protected Member Functions

 DockLayout (Dock& dock)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gdl::DockLayoutwrap (GdlDockLayout* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Constructor & Destructor Documentation

§ DockLayout() [1/2]

Gdl::DockLayout::DockLayout ( DockLayout&&  src)
noexcept

§ ~DockLayout()

Gdl::DockLayout::~DockLayout ( )
overridenoexcept

§ DockLayout() [2/2]

Gdl::DockLayout::DockLayout ( Dock dock)
protected

Member Function Documentation

§ attach()

void Gdl::DockLayout::attach ( const Glib::RefPtr< DockMaster >&  master)

§ create()

static Glib::RefPtr<DockLayout> Gdl::DockLayout::create ( Dock dock)
static

§ delete_layout()

void Gdl::DockLayout::delete_layout ( const Glib::ustring &  name)

§ get_layouts()

std::vector<Glib::ustring> Gdl::DockLayout::get_layouts ( bool  include_default)

§ get_type()

static GType Gdl::DockLayout::get_type ( )
static

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

§ gobj() [1/2]

GdlDockLayout* Gdl::DockLayout::gobj ( )
inline

Provides access to the underlying C GObject.

§ gobj() [2/2]

const GdlDockLayout* Gdl::DockLayout::gobj ( ) const
inline

Provides access to the underlying C GObject.

§ gobj_copy()

GdlDockLayout* Gdl::DockLayout::gobj_copy ( )

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

§ is_dirty()

bool Gdl::DockLayout::is_dirty ( ) const

§ load_from_file()

bool Gdl::DockLayout::load_from_file ( const std::string filename)

§ load_layout()

bool Gdl::DockLayout::load_layout ( const Glib::ustring &  name)

§ operator=()

DockLayout& Gdl::DockLayout::operator= ( DockLayout&&  src)
noexcept

§ property_dirty()

Glib::PropertyProxy_ReadOnly< bool > Gdl::DockLayout::property_dirty ( ) const

True if the layouts have changed and need to be saved to a file.

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_master() [1/2]

Glib::PropertyProxy< Glib::RefPtr<DockMaster> > Gdl::DockLayout::property_master ( )

GdlDockMaster or GdlDockObject object which the layout object is attached to.

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_master() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<DockMaster> > Gdl::DockLayout::property_master ( ) const

GdlDockMaster or GdlDockObject object which the layout object is attached to.

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

§ save_layout()

void Gdl::DockLayout::save_layout ( const Glib::ustring &  name)

§ save_to_file()

bool Gdl::DockLayout::save_to_file ( const std::string filename)

Friends And Related Function Documentation

§ wrap()

Glib::RefPtr< Gdl::DockLayout > wrap ( GdlDockLayout *  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: