Class: widget::Composer

Synopsis:

+        Composer                   (void);
+        Composer                   (enum composerMode _mode,
                                     const std::string & _data);
+       ~Composer                   (void);
+  bool  loadFromFile               (const std::string & _fileName);
+  bool  loadFromString             (const std::string & _composerXmlString);
+  void  registerOnEventNameWidget  (const std::string & _subWidgetName,
                                     const char * _eventId,
                                     const char * _eventIdgenerated,
                                     const std::string & _overloadData);
+  void  registerOnEventNameWidget  (ewol::EObject * _destinationObject,
                                     const std::string & _subWidgetName,
                                     const char * _eventId,
                                     const char * _eventIdgenerated,
                                     const std::string & _overloadData);

Object Hierarchy:

ewol::EObject
    +--> ewol::Widget
        +--> widget::Container
            +--> widget::Composer

Description:

/** * @ingroup ewolWidgetGroup * @brief the composer widget is a widget that create a link on a string.file to parse the data and generate some widget tree */

Detail:

widget::Composer ()

Composer(void);

Constructor

---

widget::Composer ()

Composer(enum composerMode _mode,
         const std::string & _data);

Constructor

Parameter [input]: _mode mode of parsing the string
Parameter [input]: _data file/directString data to generate compositing of the widget..

---

widget::~Composer ()

~Composer(void);

Destructor

---

loadFromFile ()

bool loadFromFile(const std::string & _fileName);

load a composition with a file

Parameter [input]: _fileName Name of the file
Return: true == > all done OK
Return: false == > some error occured

---

loadFromString ()

bool loadFromString(const std::string & _composerXmlString);

load a composition with a file

Parameter [input]: _composerXmlString xml to parse directly
Return: true == > all done OK
Return: false == > some error occured

---

registerOnEventNameWidget ()

void registerOnEventNameWidget(const std::string & _subWidgetName,
                               const char * _eventId,
                               const char * _eventIdgenerated,
                               const std::string & _overloadData);

Register an Event an named widget.
Notes: : To used when herited from this object.

Parameter [input]: _subWidgetName Name of the subWidget.
Parameter [input]: _eventId Event generate inside the object.
Parameter [input]: _eventIdgenerated event generated when call the distant EObject.onReceiveMessage(...)
Parameter [input]: _overloadData When the user prever to receive a data specificly for this event ...

---

registerOnEventNameWidget ()

void registerOnEventNameWidget(ewol::EObject * _destinationObject,
                               const std::string & _subWidgetName,
                               const char * _eventId,
                               const char * _eventIdgenerated,
                               const std::string & _overloadData);

Register an Event an named widget.
Notes: : To used when NOT herited from this object.

Parameter [input]: _destinationObject pointer on the object that might be call when an event is generated
Parameter [input]: _subWidgetName Name of the subWidget.
Parameter [input]: _eventId Event generate inside the object.
Parameter [input]: _eventIdgenerated event generated when call the distant EObject.onReceiveMessage(...)
Parameter [input]: _overloadData When the user prever to receive a data specificly for this event ...

---