#include "stage/panel/panel.hpp"

Description

The base class for all dockable panels.

Definition at line 40 of file panel.hpp.

Public Member Functions
	~Panel ()

Gdl::DockItem &	getDockItem ()

void	show (bool show=true)
	Shows or hides the panel.

bool	is_shown () const

void	iconify ()

bool	is_iconified () const

void	lock (bool show=true)
	Locks or unlocks the panel against modifications.

bool	is_locked () const

workspace::PanelManager &	getPanelManager ()

sigc::signal< void > &	signal_hidePanel ()
	fires when the dock item gets hidden.

Protected Member Functions
	Panel (workspace::PanelManager &, Gdl::DockItem &, const gchar longName, const gchar stockID)

workspace::WorkspaceWindow &	getWorkspaceWindow ()

Protected Attributes
workspace::PanelManager &	panelManager_
	The owner panel manager object.

Gdl::DockItem &	dockItem_
	owner dock item widget that will host the widgets in this panel.

sigc::signal< void >	hidePanelSignal_
	signal that fires when the dock item is hidden.

widget::PanelBar	panelBar_
	panel bar to attach to the panel grip.

Private Member Functions
void	on_item_hidden ()
	event handler when dockItem is hidden.

Constructor & Destructor Documentation

◆ Panel()

Panel	(	workspace::PanelManager &	panelManager,
		Gdl::DockItem &	dockItem,
		const gchar *	longName,
		const gchar *	stockID
	)

protected

Parameters

panel_manager	owner panel manager widget
dock_item	GdlDockItem that will host this panel
long_name	title of this panel
stock_id	ID of this panel

Definition at line 32 of file panel.cpp.

References Panel::on_item_hidden(), and Panel::panelBar_.

Here is the call graph for this function:

◆ ~Panel()

~Panel ( )

Definition at line 67 of file panel.cpp.

References Panel::dockItem_, and Panel::panelBar_.

Member Function Documentation

◆ getDockItem()

Gdl::DockItem & getDockItem ( )

Returns: pointer to the underlying GdlDockItem structure

Definition at line 86 of file panel.cpp.

References Panel::dockItem_.

Referenced by DockArea::createPanels(), PanelManager::createPanels(), DockArea::showPanel(), PanelManager::showPanel(), DockArea::splitPanel(), PanelManager::splitPanel(), DockArea::switchPanel(), and PanelManager::switchPanel().

Here is the caller graph for this function:

◆ show()

void show ( bool show = true )

Shows or hides the panel.

Definition at line 92 of file panel.cpp.

References Panel::dockItem_, and Panel::show().

Referenced by InfoBoxPanel::getLog(), PanelBar::on_hide(), Panel::show(), DockArea::showPanel(), and PanelManager::showPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_shown()

bool is_shown ( ) const

Definition at line 100 of file panel.cpp.

References Panel::dockItem_.

Referenced by DockArea::on_panel_shown(), PanelManager::on_panel_shown(), DockArea::showPanel(), and PanelManager::showPanel().

Here is the caller graph for this function:

◆ iconify()

void iconify ( )

Definition at line 107 of file panel.cpp.

References Panel::dockItem_.

◆ is_iconified()

bool is_iconified ( ) const

Gdlmm as of v1.30.0 does not have a facility for checking the whether a dock item is iconified or not ////////////////////TODO explicit usings please!

Definition at line 113 of file panel.cpp.

References Panel::dockItem_, and NULL.

Referenced by DockArea::on_panel_shown(), and PanelManager::on_panel_shown().

Here is the caller graph for this function: