gdlmm  3.7.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gdl::DockObject Class Reference
Inheritance diagram for Gdl::DockObject:
Inheritance graph
[legend]

Public Member Functions

 DockObject (DockObject&& src) noexcept
 
DockObjectoperator= (DockObject&& src) noexcept
 
 DockObject (const DockObject&)=delete
 
DockObjectoperator= (const DockObject&)=delete
 
 ~DockObject () noexcept override
 
GdlDockObject* gobj ()
 Provides access to the underlying C GtkObject. More...
 
const GdlDockObject* gobj () const
 Provides access to the underlying C GtkObject. More...
 
bool is_compound () const
 
void detach (bool recursive=true)
 
DockObjectget_parent_object () const
 
void freeze ()
 
void thaw ()
 
void reduce ()
 
template<class OtherType >
void dock (DockObject& requestor, const OtherType& other_data, DockPlacement position=static_cast< DockPlacement >(DOCK_NONE))
 
void dock (DockObject& requestor, DockPlacement position=static_cast< DockPlacement >(DOCK_NONE))
 
void bind (const Glib::RefPtr< DockMaster >& master)
 
void unbind ()
 
bool is_bound () const
 
template<class OtherType >
bool reorder (DockObject& child, const OtherType& other_data, DockPlacement new_position=static_cast< DockPlacement >(DOCK_NONE))
 
bool reorder (DockObject& child, DockPlacement new_position=static_cast< DockPlacement >(DOCK_NONE))
 
void present (DockObject& child)
 
bool child_placement (DockObject& child, DockPlacement placement=static_cast< DockPlacement >(DOCK_NONE))
 
bool is_automatic ()
 
void set_manual ()
 
Glib::RefPtr< DockMasterget_master ()
 
Glib::PropertyProxy< Glib::ustring > property_long_name ()
 Human readable name for the dock object. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_long_name () const
 Human readable name for the dock object. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_name () const
 Unique name for identifying the dock object. More...
 
Glib::PropertyProxy< Glib::RefPtr< DockMaster > > property_master ()
 Dock master this dock object is bound to. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< DockMaster > > property_master () const
 Dock master this dock object is bound to. More...
 
Glib::PropertyProxy< Glib::ustring > property_stock_id ()
 Stock icon for the dock object. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_stock_id () const
 Stock icon for the dock object. More...
 
Glib::SignalProxy< void, bool > signal_detach ()
 
Glib::SignalProxy< void, DockObject&, DockPlacement, const Glib::ValueBase*> signal_dock ()
 

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

 DockObject ()
 
void dock (DockObject& requestor, const Glib::ValueBase& other_data, DockPlacement position=static_cast< DockPlacement >(DOCK_NONE))
 
bool reorder (DockObject& child, const Glib::ValueBase& other_data, DockPlacement new_position=static_cast< DockPlacement >(DOCK_NONE))
 

Related Functions

(Note that these are not member functions.)

Gdl::DockObjectwrap (GdlDockObject* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Constructor & Destructor Documentation

§ DockObject() [1/3]

Gdl::DockObject::DockObject ( DockObject&&  src)
noexcept

§ DockObject() [2/3]

Gdl::DockObject::DockObject ( const DockObject )
delete

§ ~DockObject()

Gdl::DockObject::~DockObject ( )
overridenoexcept

§ DockObject() [3/3]

Gdl::DockObject::DockObject ( )
protected

Member Function Documentation

§ bind()

void Gdl::DockObject::bind ( const Glib::RefPtr< DockMaster >&  master)

§ child_placement()

bool Gdl::DockObject::child_placement ( DockObject child,
DockPlacement  placement = static_cast< DockPlacement >(DOCK_NONE) 
)

§ detach()

void Gdl::DockObject::detach ( bool  recursive = true)

§ dock() [1/3]

template <class OtherType >
void Gdl::DockObject::dock ( DockObject requestor,
const OtherType &  other_data,
DockPlacement  position = static_cast<DockPlacement>(DOCK_NONE) 
)

§ dock() [2/3]

void Gdl::DockObject::dock ( DockObject requestor,
DockPlacement  position = static_cast< DockPlacement >(DOCK_NONE) 
)

§ dock() [3/3]

void Gdl::DockObject::dock ( DockObject requestor,
const Glib::ValueBase &  other_data,
DockPlacement  position = static_cast< DockPlacement >(DOCK_NONE) 
)
protected

§ freeze()

void Gdl::DockObject::freeze ( )

§ get_master()

Glib::RefPtr<DockMaster> Gdl::DockObject::get_master ( )

§ get_parent_object()

DockObject* Gdl::DockObject::get_parent_object ( ) const

§ get_type()

static GType Gdl::DockObject::get_type ( )
static

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

§ gobj() [1/2]

GdlDockObject* Gdl::DockObject::gobj ( )
inline

Provides access to the underlying C GtkObject.

§ gobj() [2/2]

const GdlDockObject* Gdl::DockObject::gobj ( ) const
inline

Provides access to the underlying C GtkObject.

§ is_automatic()

bool Gdl::DockObject::is_automatic ( )

§ is_bound()

bool Gdl::DockObject::is_bound ( ) const

§ is_compound()

bool Gdl::DockObject::is_compound ( ) const

§ operator=() [1/2]

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

§ operator=() [2/2]

DockObject& Gdl::DockObject::operator= ( const DockObject )
delete

§ present()

void Gdl::DockObject::present ( DockObject child)

§ property_long_name() [1/2]

Glib::PropertyProxy< Glib::ustring > Gdl::DockObject::property_long_name ( )

Human readable name for the dock object.

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

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gdl::DockObject::property_long_name ( ) const

Human readable name for the dock object.

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::DockObject::property_master ( )

Dock master this dock object is bound 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::DockObject::property_master ( ) const

Dock master this dock object is bound 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.

§ property_name()

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gdl::DockObject::property_name ( ) const

Unique name for identifying the dock object.

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

Glib::PropertyProxy< Glib::ustring > Gdl::DockObject::property_stock_id ( )

Stock icon for the dock object.

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

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gdl::DockObject::property_stock_id ( ) const

Stock icon for the dock object.

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

§ reduce()

void Gdl::DockObject::reduce ( )

§ reorder() [1/3]

template <class OtherType >
bool Gdl::DockObject::reorder ( DockObject child,
const OtherType &  other_data,
DockPlacement  new_position = static_cast<DockPlacement>(DOCK_NONE) 
)

§ reorder() [2/3]

bool Gdl::DockObject::reorder ( DockObject child,
DockPlacement  new_position = static_cast< DockPlacement >(DOCK_NONE) 
)

§ reorder() [3/3]

bool Gdl::DockObject::reorder ( DockObject child,
const Glib::ValueBase &  other_data,
DockPlacement  new_position = static_cast< DockPlacement >(DOCK_NONE) 
)
protected

§ set_manual()

void Gdl::DockObject::set_manual ( )

§ signal_detach()

Glib::SignalProxy< void,bool > Gdl::DockObject::signal_detach ( )
Slot Prototype:
void on_my_detach(bool arg1)

§ signal_dock()

Glib::SignalProxy< void,DockObject&,DockPlacement,const Glib::ValueBase* > Gdl::DockObject::signal_dock ( )
Slot Prototype:
void on_my_dock(DockObject& arg1, DockPlacement arg2, const Glib::ValueBase* arg3)

§ thaw()

void Gdl::DockObject::thaw ( )

§ unbind()

void Gdl::DockObject::unbind ( )

Friends And Related Function Documentation

§ wrap()

Gdl::DockObject* wrap ( GdlDockObject *  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: