fw4spl
fwGui::layoutManager::IFrameLayoutManager Class Referenceabstract

Defines an interface for managing a frame. More...

#include <IFrameLayoutManager.hpp>

+ Inheritance diagram for fwGui::layoutManager::IFrameLayoutManager:
+ Collaboration diagram for fwGui::layoutManager::IFrameLayoutManager:

Classes

class  FrameInfo
 

Public Types

enum  Style { DEFAULT, STAY_ON_TOP, MODAL }
 Defines all possible style for a frame.
 
enum  FrameState { UNKNOWN, ICONIZED, MAXIMIZED, FULL_SCREEN }
 
typedef ::fwRuntime::ConfigurationElement::sptr ConfigurationType
 
typedef std::string RegistryKeyType
 
typedef std::function< void() > CloseCallback
 
- 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 IFrameLayoutManager ()
 Constructor. Do nothing.
 
virtual FWGUI_API ~IFrameLayoutManager ()
 Destructor. Do nothing.
 
virtual FWGUI_API void initialize (ConfigurationType configuration)
 Configure the layout before creation.
 
virtual FWGUI_API void createFrame ()=0
 Instantiate frame.
 
virtual FWGUI_API void destroyFrame ()=0
 Destroy frame.
 
virtual ::fwGui::container::fwContainer::sptr getFrame ()
 Return the frame container.
 
virtual ::fwGui::container::fwContainer::sptr getContainer ()
 Return the first container into the frame.
 
virtual FWGUI_API void setCloseCallback (CloseCallback fct)
 
- 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

static const std::string SOFTWARE_UI = "SOFTWARE_UI"
 
static const std::string FRAME_STATE_UI = "FRAME_STATE_UI"
 
static const std::string FRAME_SIZE_W_UI = "FRAME_SIZE_W_UI"
 
static const std::string FRAME_SIZE_H_UI = "FRAME_SIZE_H_UI"
 
static const std::string FRAME_POSITION_X_UI = "FRAME_POSITION_X_UI"
 
static const std::string FRAME_POSITION_Y_UI = "FRAME_POSITION_Y_UI"
 
static FWGUI_API const RegistryKeyType REGISTRY_KEY = "::fwGui::FrameLayoutManager"
 

Protected Member Functions

FWGUI_API void readConfig ()
 
FWGUI_API void writeConfig ()
 
FWGUI_API::fwData::Composite::sptr getPreferenceUI ()
 
const FrameInfogetFrameInfo () const
 Configuration definition.
 
FrameInfogetFrameInfo ()
 Configuration definition.
 
void setFrameInfo (const FrameInfo &frameInfo)
 Configuration definition.
 
- Protected Member Functions inherited from fwGui::GuiBaseObject
 GuiBaseObject ()
 
virtual ~GuiBaseObject ()
 

Protected Attributes

::fwGui::container::fwContainer::sptr m_frame
 
::fwGui::container::fwContainer::sptr m_container
 
CloseCallback m_closeCallback
 

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
 

Detailed Description

Defines an interface for managing a frame.

Definition at line 30 of file IFrameLayoutManager.hpp.

Member Enumeration Documentation

Enumerator
UNKNOWN 

the unknown state

ICONIZED 

the minimized state

MAXIMIZED 

the maximied state

FULL_SCREEN 

the full screen state

Definition at line 56 of file IFrameLayoutManager.hpp.


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