Defines the base for cardinal layout manager. More...

#include <CardinalLayoutManagerBase.hpp>

Inheritance diagram for fwGui::layoutManager::CardinalLayoutManagerBase:

Collaboration diagram for fwGui::layoutManager::CardinalLayoutManagerBase:

Classes
class	ViewInfo

Public Types
enum	Align { CENTER, RIGHT, LEFT, BOTTOM, TOP }
	Defines all possible position for a CardinalLayout.

typedef std::string	RegistryKeyType

Public Types inherited from fwGui::layoutManager::IViewLayoutManager
typedef ::fwRuntime::ConfigurationElement::sptr	ConfigurationType

Public Types inherited from fwGui::GuiBaseObject
typedef ::fwGui::factory::Key	Key

Public Member Functions
virtual bool	isA (const std::string &type) const override

FWGUI_API	CardinalLayoutManagerBase ()
	Constructor. Do nothing.

virtual FWGUI_API	~CardinalLayoutManagerBase ()
	Destructor. Do nothing.

virtual FWGUI_API void	initialize (ConfigurationType configuration) override
	Initialize cardinal layout manager before the creation of layout. More...

Public Member Functions inherited from fwGui::layoutManager::IViewLayoutManager
FWGUI_API	IViewLayoutManager ()
	Constructor. Do nothing.

virtual FWGUI_API	~IViewLayoutManager ()
	Destructor. Do nothing.

virtual FWGUI_API void	createLayout (::fwGui::container::fwContainer::sptr parent)=0
	Instantiate layout with parent container. More...

virtual FWGUI_API void	destroyLayout ()=0
	Destroy local layout with sub containers. More...

virtual FWGUI_API std::vector< ::fwGui::container::fwContainer::sptr >	getSubViews ()
	Returns all sub containers managed by this layout.

Public Member Functions inherited from fwGui::GuiBaseObject
Public Member Functions inherited from fwCore::BaseObject
virtual const std::string &	getLeafClassname () const
	return object's classname without its namespace, i.e. BaseObject

Static Public Member Functions
static bool	isTypeOf (const std::string &type)

Static Public Member Functions inherited from fwGui::layoutManager::IViewLayoutManager
static bool	isTypeOf (const std::string &type)

static const std::string &	classname ()
	return full object's classname with its namespace, i.e. fwCore::BaseObject

Static Public Member Functions inherited from fwGui::GuiBaseObject
static bool	isTypeOf (const std::string &type)

static const std::string &	classname ()
	return full object's classname with its namespace, i.e. fwCore::BaseObject

Static Public Member Functions inherited from fwCore::BaseObject
static bool	isTypeOf (const std::string &type)

static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject

static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Static Public Attributes
static FWGUI_API const RegistryKeyType	REGISTRY_KEY

Protected Member Functions
std::list< ViewInfo >	getViewsInfo ()

Protected Member Functions inherited from fwGui::layoutManager::IViewLayoutManager
virtual FWGUI_API void	destroySubViews ()
	Helper to destroy local sub views.

Protected Member Functions inherited from fwGui::GuiBaseObject
	GuiBaseObject ()

virtual	~GuiBaseObject ()

Demangling methods
virtual const std::string &	getClassname () const override
	return full object's classname with its namespace, i.e. fwCore::BaseObject

static const std::string &	classname ()
	return full object's classname with its namespace, i.e. fwCore::BaseObject

Additional Inherited Members
Protected Attributes inherited from fwGui::layoutManager::IViewLayoutManager
std::vector< ::fwGui::container::fwContainer::sptr >	m_subViews
	All sub containers managed by this layout.

Detailed Description

Defines the base for cardinal layout manager.

Definition at line 26 of file CardinalLayoutManagerBase.hpp.

Member Function Documentation

void fwGui::layoutManager::CardinalLayoutManagerBase::initialize ( ConfigurationType configuration )

overridevirtual

Initialize cardinal layout manager before the creation of layout.

Example of configuration with cardinal layout.

 <service uid="subView2" type="::gui::view::SDefaultView" autoConnect="no" >
     <gui>
         <layout type="::fwGui::CardinalLayoutManager" >
             <view caption="CardinalView1" align="center" />
             <view caption="CardinalView2" align="right" minWidth="400" />
             <view caption="CardinalView3" align="bottom" minHeight="400" />
         </layout>
     </gui>
     <registry>
         <view sid="view1" start="yes" />
         <view sid="view2" start="yes" />
         <view sid="view3" start="yes" />
     </registry>
 </service>

<layout type="::fwGui::CardinalLayoutManager" > : define a cardinal layout.
<view caption="CardinalView1" align="center" /> : define a new view with following attribute
- caption : name of the view (display on the screen).
- align {center | bottom | top | right | left}: define the position of the view
- minWidth : minimal width of the view
- minHeight : minimal height of the view
- resizable {yes | no}: define if the view can be resized.
- position : indicates the sequential position, starting with zero. It uses if more than one view as the same align value (available only with wxWidget see wxAuiManager in wxWidgets documenattion for more details).
- layer : available only with wxWidget. See wxAuiManager in wxWidgets documenattion for more details
- row : use to place several view next to each other (available only with wxWidget). See wxAuiManager in wxWidgets documenattion for more details
- visible {true | yes | false | no} : define if the view is visible or not.