fw4spl
fwGui::builder::ISlideViewBuilder Class Referenceabstract

Defines the interface class for the slide view builder. More...

#include <ISlideViewBuilder.hpp>

+ Inheritance diagram for fwGui::builder::ISlideViewBuilder:
+ Collaboration diagram for fwGui::builder::ISlideViewBuilder:

Public Types

enum  Aligment { TOP, BOTTOM, RIGHT, LEFT }
 
typedef std::string RegistryKeyType
 
- 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 ISlideViewBuilder ()
 Constructor. Do nothing.
 
virtual FWGUI_API ~ISlideViewBuilder ()
 Destructor. Do nothing.
 
virtual FWGUI_API::fwGui::container::fwContainer::sptr getContainer () const
 Returns the builded tool bar.
 
virtual FWGUI_API void initialize (::fwRuntime::ConfigurationElement::sptr configuration)
 Initialize the tool bar.
 
virtual FWGUI_API void createContainer (::fwGui::container::fwContainer::sptr parent)=0
 Instantiate layout with parent toolBar. More...
 
virtual FWGUI_API void destroyContainer ()=0
 Destroy local layout with sub containers. More...
 
- 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::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

FWGUI_API static const RegistryKeyType REGISTRY_KEY = "::fwGui::SlideViewBuilder"
 

Protected Attributes

::fwGui::container::fwContainer::sptr m_container
 
int m_size
 
double m_opacity
 
Aligment m_aligment
 
std::string m_styleSheet
 

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 Member Functions inherited from fwGui::GuiBaseObject
 GuiBaseObject ()
 
virtual ~GuiBaseObject ()
 

Detailed Description

Defines the interface class for the slide view builder.

Example of configuration

1 <slideView align="top" size="200" opacity="1.0">
2  <styleSheet>color: blue; background-color: yellow</styleSheet>
3 </slideView>
  • align (optional, default=left) : defines the widget side ('left', 'right', 'top' or 'bottom')
  • size (optional, default=200) : defines the widget width or height (width if side is 'left' or 'right' and height if side is 'top' or 'bottom')
  • opacity (optional, default=1.0) : defines the widget opacity
  • styleSheet (optional) : defines the style of the widget (see Qt style sheets http://doc.qt.io/qt-5/stylesheet-examples.html )

Definition at line 38 of file ISlideViewBuilder.hpp.

Member Function Documentation

virtual FWGUI_API void fwGui::builder::ISlideViewBuilder::createContainer ( ::fwGui::container::fwContainer::sptr  parent)
pure virtual

Instantiate layout with parent toolBar.

Precondition
LayoutManager must be initialized before.
parent toolBar must be instanced.

Implemented in fwGui::builder::SlideViewBuilder.

virtual FWGUI_API void fwGui::builder::ISlideViewBuilder::destroyContainer ( )
pure virtual

Destroy local layout with sub containers.

Precondition
services using this sub containers must be stopped before.

Implemented in fwGui::builder::SlideViewBuilder.


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