Inheritance diagram for Gdl::DockItem:

Collaboration diagram for Gdl::DockItem:

Public Member Functions
	DockItem (DockItem&& src) noexcept

DockItem&	operator= (DockItem&& src) noexcept

	DockItem (const DockItem&)=delete

DockItem&	operator= (const DockItem&)=delete

	~DockItem () noexcept override

GdlDockItem*	gobj ()
	Provides access to the underlying C GtkObject. More...

const GdlDockItem*	gobj () const
	Provides access to the underlying C GtkObject. More...

	DockItem (const Glib::ustring& name, const Glib::ustring& long_name, DockItemBehavior behavior=static_cast< DockItemBehavior >(DOCK_ITEM_BEH_NORMAL))

	DockItem (const Glib::ustring& name, const Glib::ustring& long_name, const Gtk::StockID& stock_id, DockItemBehavior behavior=static_cast< DockItemBehavior >(DOCK_ITEM_BEH_NORMAL))

void	dock_to (DockItem& target, DockPlacement position=static_cast< DockPlacement >(DOCK_NONE), int docking_param=-1)

void	dock_floating (int docking_param=-1)

void	set_orientation (Gtk::Orientation orientation)

Gtk::Widget*	get_tablabel () const

void	set_tablabel (Gtk::Widget& tablabel)

Gtk::Widget*	get_grip () const

void	hide_grip ()

void	show_grip ()

void	notify_selected ()

void	bind (Gtk::Widget&dock)

void	unbind ()

void	hide_item ()

void	iconify_item ()

void	show_item ()

void	lock ()

void	unlock ()

void	set_default_position (DockObject& reference)

void	preferred_size (Gtk::Requisition& req)

Glib::PropertyProxy< DockItemBehavior >	property_behavior ()
	General behavior for the dock item (i.e. More...

Glib::PropertyProxy_ReadOnly< DockItemBehavior >	property_behavior () const
	General behavior for the dock item (i.e. More...

Glib::PropertyProxy< bool >	property_locked ()
	If set, the dock item cannot be dragged around and it doesn't show a grip. More...

Glib::PropertyProxy_ReadOnly< bool >	property_locked () const
	If set, the dock item cannot be dragged around and it doesn't show a grip. More...

Glib::PropertyProxy< Gtk::Orientation >	property_orientation ()
	Orientation of the docking item. More...

Glib::PropertyProxy_ReadOnly< Gtk::Orientation >	property_orientation () const
	Orientation of the docking item. More...

Glib::PropertyProxy< int >	property_preferred_height ()
	Preferred height for the dock item. More...

Glib::PropertyProxy_ReadOnly< int >	property_preferred_height () const
	Preferred height for the dock item. More...

Glib::PropertyProxy< int >	property_preferred_width ()
	Preferred width for the dock item. More...

Glib::PropertyProxy_ReadOnly< int >	property_preferred_width () const
	Preferred width for the dock item. More...

Glib::PropertyProxy< bool >	property_resize ()
	If set, the dock item can be resized when docked in a GtkPanel widget. More...

Glib::PropertyProxy_ReadOnly< bool >	property_resize () const
	If set, the dock item can be resized when docked in a GtkPanel widget. More...

Glib::SignalProxy< void >	signal_dock_drag_begin ()

Glib::SignalProxy< void, bool >	signal_dock_drag_end ()

Glib::SignalProxy< void, const Glib::RefPtr< Gdk::Device >&, int, int >	signal_dock_drag_motion ()

Glib::SignalProxy< void >	signal_selected ()

Public Member Functions inherited from Gdl::DockObject
	DockObject (DockObject&& src) noexcept

DockObject&	operator= (DockObject&& src) noexcept

	DockObject (const DockObject&)=delete

DockObject&	operator= (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)

DockObject*	get_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< DockMaster >	get_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...

Static Public Member Functions inherited from Gdl::DockObject
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
virtual void	on_dock_drag_begin ()
	This is a default handler for the signal signal_dock_drag_begin(). More...

virtual void	on_dock_drag_end (bool cancel)
	This is a default handler for the signal signal_dock_drag_end(). More...

virtual void	on_dock_drag_motion (const Glib::RefPtr< Gdk::Device >& device, int x, int y)
	This is a default handler for the signal signal_dock_drag_motion(). More...

Protected Member Functions inherited from Gdl::DockObject
	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::DockItem*	wrap (GdlDockItem* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Gdl::DockObject
Gdl::DockObject*	wrap (GdlDockObject* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Constructor & Destructor Documentation

◆ DockItem() [1/4]

Gdl::DockItem::DockItem ( DockItem&& src )

noexcept

◆ DockItem() [2/4]

Gdl::DockItem::DockItem ( const DockItem& )

delete

◆ ~DockItem()

Gdl::DockItem::~DockItem ( )

overridenoexcept

◆ DockItem() [3/4]

Gdl::DockItem::DockItem	(	const Glib::ustring &	name,
		const Glib::ustring &	long_name,
		DockItemBehavior	behavior = `static_cast< DockItemBehavior >(DOCK_ITEM_BEH_NORMAL)`
	)

◆ DockItem() [4/4]

Gdl::DockItem::DockItem	(	const Glib::ustring &	name,
		const Glib::ustring &	long_name,
		const Gtk::StockID &	stock_id,
		DockItemBehavior	behavior = `static_cast< DockItemBehavior >(DOCK_ITEM_BEH_NORMAL)`
	)

Member Function Documentation

◆ bind()

void Gdl::DockItem::bind ( Gtk::Widget & dock )

◆ dock_floating()

void Gdl::DockItem::dock_floating ( int docking_param = -1 )

◆ dock_to()

void Gdl::DockItem::dock_to	(	DockItem&	target,
		DockPlacement	position = `static_cast< DockPlacement >(DOCK_NONE)`,
		int	docking_param = `-1`
	)

◆ get_grip()

Gtk::Widget* Gdl::DockItem::get_grip ( ) const

◆ get_tablabel()

Gtk::Widget* Gdl::DockItem::get_tablabel ( ) const

◆ get_type()

static GType Gdl::DockItem::get_type ( )

static

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

◆ gobj() [1/2]

GdlDockItem* Gdl::DockItem::gobj ( )

inline

Provides access to the underlying C GtkObject.

◆ gobj() [2/2]

const GdlDockItem* Gdl::DockItem::gobj ( ) const

inline

Provides access to the underlying C GtkObject.

◆ hide_grip()

void Gdl::DockItem::hide_grip ( )

◆ hide_item()

void Gdl::DockItem::hide_item ( )

◆ iconify_item()

void Gdl::DockItem::iconify_item ( )

◆ lock()

void Gdl::DockItem::lock ( )

◆ notify_selected()

void Gdl::DockItem::notify_selected ( )

◆ on_dock_drag_begin()

virtual void Gdl::DockItem::on_dock_drag_begin ( )

protectedvirtual

This is a default handler for the signal signal_dock_drag_begin().

◆ on_dock_drag_end()

virtual void Gdl::DockItem::on_dock_drag_end ( bool cancel )

protectedvirtual

This is a default handler for the signal signal_dock_drag_end().

◆ on_dock_drag_motion()

virtual void Gdl::DockItem::on_dock_drag_motion	(	const Glib::RefPtr< Gdk::Device > &	device,
		int	x,
		int	y
	)

protectedvirtual

This is a default handler for the signal signal_dock_drag_motion().

◆ operator=() [1/2]

DockItem& Gdl::DockItem::operator= ( DockItem&& src )

noexcept

◆ operator=() [2/2]

DockItem& Gdl::DockItem::operator= ( const DockItem& )

delete

◆ preferred_size()

void Gdl::DockItem::preferred_size ( Gtk::Requisition & req )

◆ property_behavior() [1/2]

Glib::PropertyProxy< DockItemBehavior > Gdl::DockItem::property_behavior ( )

General behavior for the dock item (i.e.

whether it can float, if it's locked, etc.).

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

Glib::PropertyProxy_ReadOnly< DockItemBehavior > Gdl::DockItem::property_behavior ( ) const

General behavior for the dock item (i.e.

whether it can float, if it's locked, etc.).

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

Glib::PropertyProxy< bool > Gdl::DockItem::property_locked ( )

If set, the dock item cannot be dragged around and it doesn't show a grip.

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

Glib::PropertyProxy_ReadOnly< bool > Gdl::DockItem::property_locked ( ) const

If set, the dock item cannot be dragged around and it doesn't show a grip.

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

Glib::PropertyProxy< Gtk::Orientation > Gdl::DockItem::property_orientation ( )

Orientation of the docking item.

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< Gtk::Orientation > Gdl::DockItem::property_orientation ( ) const

Orientation of the docking item.

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

Glib::PropertyProxy< int > Gdl::DockItem::property_preferred_height ( )

Preferred height for the dock item.

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

Glib::PropertyProxy_ReadOnly< int > Gdl::DockItem::property_preferred_height ( ) const

Preferred height for the dock item.

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

Glib::PropertyProxy< int > Gdl::DockItem::property_preferred_width ( )

Preferred width for the dock item.

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

Glib::PropertyProxy_ReadOnly< int > Gdl::DockItem::property_preferred_width ( ) const

Preferred width for the dock item.

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

Glib::PropertyProxy< bool > Gdl::DockItem::property_resize ( )

If set, the dock item can be resized when docked in a GtkPanel widget.

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

Glib::PropertyProxy_ReadOnly< bool > Gdl::DockItem::property_resize ( ) const

If set, the dock item can be resized when docked in a GtkPanel widget.

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_default_position()

void Gdl::DockItem::set_default_position ( DockObject& reference )

◆ set_orientation()

void Gdl::DockItem::set_orientation ( Gtk::Orientation orientation )

◆ set_tablabel()

void Gdl::DockItem::set_tablabel ( Gtk::Widget & tablabel )

◆ show_grip()

void Gdl::DockItem::show_grip ( )

◆ show_item()

void Gdl::DockItem::show_item ( )

◆ signal_dock_drag_begin()

Glib::SignalProxy< void > Gdl::DockItem::signal_dock_drag_begin ( )

Slot Prototype:: void on_my_dock_drag_begin()

Flags: Run First

◆ signal_dock_drag_end()

Glib::SignalProxy< void,bool > Gdl::DockItem::signal_dock_drag_end ( )

Slot Prototype:: void on_my_dock_drag_end(bool cancel)

Flags: Run First

◆ signal_dock_drag_motion()

Glib::SignalProxy< void,const Glib::RefPtr<Gdk::Device>&,int,int > Gdl::DockItem::signal_dock_drag_motion ( )

Slot Prototype:: void on_my_dock_drag_motion(const Glib::RefPtr<Gdk::Device>& device, int x, int y)

Flags: Run First

◆ signal_selected()

Glib::SignalProxy< void > Gdl::DockItem::signal_selected ( )

Slot Prototype:: void on_my_selected()

Flags: Run First

◆ unbind()

void Gdl::DockItem::unbind ( )

◆ unlock()

void Gdl::DockItem::unlock ( )

Friends And Related Function Documentation

◆ wrap()

Gdl::DockItem* wrap	(	GdlDockItem *	object,
		bool	take_copy = `false`
	)

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.

The documentation for this class was generated from the following file:

gdlmm/dockitem.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Constructor & Destructor Documentation

◆ DockItem() [1/4]

◆ DockItem() [2/4]

◆ ~DockItem()

◆ DockItem() [3/4]

◆ DockItem() [4/4]

Member Function Documentation

◆ bind()

◆ dock_floating()

◆ dock_to()

◆ get_grip()

◆ get_tablabel()

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ hide_grip()

◆ hide_item()

◆ iconify_item()

◆ lock()

◆ notify_selected()

◆ on_dock_drag_begin()

◆ on_dock_drag_end()

◆ on_dock_drag_motion()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ preferred_size()

◆ property_behavior() [1/2]

◆ property_behavior() [2/2]

◆ property_locked() [1/2]

◆ property_locked() [2/2]

◆ property_orientation() [1/2]

◆ property_orientation() [2/2]

◆ property_preferred_height() [1/2]

◆ property_preferred_height() [2/2]

◆ property_preferred_width() [1/2]

◆ property_preferred_width() [2/2]

◆ property_resize() [1/2]

◆ property_resize() [2/2]

◆ set_default_position()

◆ set_orientation()

◆ set_tablabel()

◆ show_grip()

◆ show_item()

◆ signal_dock_drag_begin()

◆ signal_dock_drag_end()

◆ signal_dock_drag_motion()

◆ signal_selected()

◆ unbind()

◆ unlock()

Friends And Related Function Documentation

◆ wrap()