fw4spl
fwGui::dialog::IMessageDialog Class Referenceabstract

Defines the generic message box for IHM. More...

#include <IMessageDialog.hpp>

+ Inheritance diagram for fwGui::dialog::IMessageDialog:
+ Collaboration diagram for fwGui::dialog::IMessageDialog:

Public Types

enum  Icons {
  CRITICAL, WARNING, INFO, QUESTION,
  NONE
}
 Icon type.
 
enum  Buttons {
  NOBUTTON = 0, OK = 1 << 1, YES = 1 << 2, NO = 1 << 3,
  CANCEL = 1 << 4, YES_NO = YES | NO
}
 Buttons type.
 
typedef std::string FactoryRegistryKeyType
 
- 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 IMessageDialog ()
 Constructor. Do nothing.
 
virtual FWGUI_API ~IMessageDialog ()
 Destructor. Do nothing.
 
virtual FWGUI_API void setTitle (const std::string &title)=0
 Set the title of the message box.
 
virtual FWGUI_API void setMessage (const std::string &msg)=0
 Set the message.
 
virtual FWGUI_API void setIcon (Icons icon)=0
 Set the icon (CRITICAL, WARNING, INFO or QUESTION)
 
virtual FWGUI_API void addButton (Buttons button)=0
 Add a button (OK, YES_NO, YES, NO, CANCEL)
 
virtual FWGUI_API void setDefaultButton (Buttons button)=0
 Set the default button.
 
virtual FWGUI_API void addCustomButton (const std::string &label, std::function< void()> clickedFn)=0
 Add a custom button to this dialog.
 
virtual FWGUI_API Buttons show ()=0
 Show the message box and return the clicked button.
 
- 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 FWGUI_API const FactoryRegistryKeyType REGISTRY_KEY = "::fwGui::dialog::MessageDialog"
 

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 generic message box for IHM.

Definition at line 21 of file IMessageDialog.hpp.


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