fwGui::layoutManager::LineLayoutManagerBase Class Reference

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

#include <LineLayoutManagerBase.hpp>

Inheritance diagram for fwGui::layoutManager::LineLayoutManagerBase:

Collaboration diagram for fwGui::layoutManager::LineLayoutManagerBase:

Classes
class	ViewInfo

Public Types
enum	Orientation { VERTICAL, HORIZONTAL }
	Defines all possible orientation for a LineLayout.
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	LineLayoutManagerBase ()
	Constructor. Do nothing.
virtual FWGUI_API	~LineLayoutManagerBase ()
	Destructor. Do nothing.
virtual FWGUI_API void	initialize (ConfigurationType configuration) override
	Initialize Line layout manager before the creation of layout. More...
Orientation	getOrientation ()
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 = "::fwGui::LineLayoutManager"

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 line layout manager.

Definition at line 24 of file LineLayoutManagerBase.hpp.

Member Function Documentation

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

overridevirtual

Initialize Line 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::LineLayoutManager" >
             <orientation value="horizontal" />
             <view proportion="0" minWidth="30" />
             <view proportion="0" minWidth="50" />
        </layout>
    </gui>
    <registry>
        <view sid="view1" start="yes" />
        <view sid="view2" start="yes" />
    </registry>
</service>

• <layout type="::fwGui::LineLayoutManager" > : define a line layout.
• <view proportion="0" minWidth="30" /> : define a new view which can have the following attributes
  • orientation {horizontal | vertical} : define if the layout is vertical or horizontal.
  • proportion : define if the space allocate in proportion of the proportion factor (bigger it is, more space are used).
  • border : define the size of the border in the layout
  • caption : define the title to display.
  • minWidth : minimal width of the view.
  • minHeight : minimal height of the view.
  • visible {true | yes | false | no} : define if the view is visible or not.

Implements fwGui::layoutManager::IViewLayoutManager.

Definition at line 42 of file LineLayoutManagerBase.cpp.

References OSLM_ASSERT, SLM_ASSERT, and SLM_FATAL_IF.

---

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

• LineLayoutManagerBase.hpp
• LineLayoutManagerBase.cpp