Lumiera  0.pre.03
»edityourfreedom«
Panel Class Reference

#include "gui/panel/panel.hpp"

Description

The base class for all dockable panels.

Definition at line 49 of file panel.hpp.

Public Member Functions

 ~Panel ()
 
Gdl::DockItem & getDockItem ()
 
workspace::PanelManagergetPanelManager ()
 
void iconify ()
 
bool is_iconified () const
 
bool is_locked () const
 
bool is_shown () const
 
void lock (bool show=true)
 Locks or unlocks the panel against modifications. More...
 
void show (bool show=true)
 Shows or hides the panel. More...
 
sigc::signal< void > & signal_hidePanel ()
 fires when the dock item gets hidden. More...
 

Protected Member Functions

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

Protected Attributes

Gdl::DockItem & dockItem_
 owner dock item widget that will host the widgets in this panel. More...
 
sigc::signal< void > hidePanelSignal_
 signal that fires when the dock item is hidden. More...
 
widget::PanelBar panelBar_
 panel bar to attach to the panel grip. More...
 
workspace::PanelManagerpanelManager_
 The owner panel manager object. More...
 

Private Member Functions

void on_item_hidden ()
 event handler when dockItem is hidden. More...
 

Constructor & Destructor Documentation

◆ Panel()

Panel ( workspace::PanelManager panelManager,
Gdl::DockItem &  dockItem,
const gchar *  longName,
const gchar *  stockID 
)
protected
Parameters
panel_managerowner panel manager widget
dock_itemGdlDockItem that will host this panel
long_nametitle of this panel
stock_idID of this panel

Definition at line 41 of file panel.cpp.

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

+ Here is the call graph for this function:

◆ ~Panel()

~Panel ( )

Definition at line 76 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 95 of file panel.cpp.

References Panel::dockItem_.

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

+ Here is the caller graph for this function:

◆ show()

void show ( bool  show = true)

Shows or hides the panel.

Definition at line 101 of file panel.cpp.

References Panel::dockItem_.

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

+ Here is the caller graph for this function:

◆ is_shown()

bool is_shown ( ) const

Definition at line 109 of file panel.cpp.

References Panel::dockItem_.

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

+ Here is the caller graph for this function:

◆ iconify()

void iconify ( )

Definition at line 116 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 122 of file panel.cpp.

References Panel::dockItem_, and NULL.

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

+ Here is the caller graph for this function:

◆ lock()

void lock ( bool  show = true)

Locks or unlocks the panel against modifications.

Definition at line 134 of file panel.cpp.

References Panel::dockItem_.

Referenced by PanelBar::on_lock().

+ Here is the caller graph for this function:

◆ is_locked()

bool is_locked ( ) const

Definition at line 141 of file panel.cpp.

References Panel::dockItem_, and NULL.

Referenced by PanelBar::on_lock(), and PanelBar::setupPanelButton().

+ Here is the caller graph for this function:

◆ getPanelManager()

workspace::PanelManager & getPanelManager ( )
Returns
the owner

Definition at line 148 of file panel.cpp.

References Panel::panelManager_.

Referenced by PanelBar::on_panel_type(), and PanelBar::on_split_panel().

+ Here is the caller graph for this function:

◆ signal_hidePanel()

sigc::signal< void > & signal_hidePanel ( )

fires when the dock item gets hidden.

Definition at line 160 of file panel.cpp.

References Panel::hidePanelSignal_.

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

+ Here is the caller graph for this function:

◆ getWorkspaceWindow()

workspace::WorkspaceWindow & getWorkspaceWindow ( )
protected

Definition at line 154 of file panel.cpp.

References PanelManager::getWorkspaceWindow(), and Panel::panelManager_.

+ Here is the call graph for this function:

◆ on_item_hidden()

void on_item_hidden ( )
private

event handler when dockItem is hidden.

Definition at line 166 of file panel.cpp.

References Panel::hidePanelSignal_.

Referenced by Panel::Panel().

+ Here is the caller graph for this function:

Member Data Documentation

◆ panelManager_

workspace::PanelManager& panelManager_
protected

The owner panel manager object.

Definition at line 103 of file panel.hpp.

Referenced by Panel::getPanelManager(), Panel::getWorkspaceWindow(), and Panel::Panel().

◆ dockItem_

Gdl::DockItem& dockItem_
protected

owner dock item widget that will host the widgets in this panel.

Definition at line 106 of file panel.hpp.

Referenced by Panel::getDockItem(), Panel::iconify(), Panel::is_iconified(), Panel::is_locked(), Panel::is_shown(), Panel::lock(), Panel::Panel(), Panel::show(), and Panel::~Panel().

◆ hidePanelSignal_

sigc::signal<void> hidePanelSignal_
protected

signal that fires when the dock item is hidden.

Definition at line 109 of file panel.hpp.

Referenced by Panel::on_item_hidden(), and Panel::signal_hidePanel().

◆ panelBar_

widget::PanelBar panelBar_
protected

panel bar to attach to the panel grip.

Definition at line 112 of file panel.hpp.

Referenced by Panel::Panel(), TimelinePanelObsolete::TimelinePanelObsolete(), and Panel::~Panel().

+ Inheritance diagram for Panel:
+ Collaboration diagram for Panel:

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