class: ewol::widget::Windows
Description:
Windows basic interfaceenum:
Constructor and Destructor:
# Windows ();
+ virtual ~Windows ();
Synopsis:
# std::shared_ptr<ewol::resource::ColorFile> m_colorProperty;
# int32_t m_colorBg;
# void init ();
+ void sysDraw ();
+ void sysOnShow ();
+ void sysOnHide ();
+ void sysOnKill ();
+ virtual void onShow ();
+ virtual void onHide ();
+ virtual bool onKill ();
+ virtual void onReduce ();
+ virtual void onStateBackground ();
+ virtual void onStateForeground ();
+ virtual void onStateSuspend ();
+ virtual void onStateResume ();
+ virtual void on ();
+ void setDecorationDisable ();
+ void setDecorationEnable ();
+ void setSubWidget (std::shared_ptr<ewol::Widget> _widget);
+ void popUpWidgetPush (std::shared_ptr<ewol::Widget> _widget);
+ void popUpWidgetPop ();
+ size_t popUpCount ();
+ const etk::Color<float> & getBackgroundColor ();
+ void setBackgroundColor (const etk::Color<float> & _color);
# virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+ virtual void onRegenerateDisplay ();
+ virtual void calculateSize (const vec2 & _availlable);
+ virtual std::shared_ptr<ewol::Widget> getWidgetAtPos (const vec2 & _pos);
+ virtual void requestDestroyFromChild (const std::shared_ptr<Object> & _child);
+ virtual std::shared_ptr<ewol::Object> getSubObjectNamed (const std::string & _objectName);
+ void setTitle (const std::string & _title);
+ virtual void createPopUpMessage (enum popUpMessageType _type,
const std::string & _message);
+ void displayInfoMessage (const std::string & _message);
+ void displayWarningMessage (const std::string & _message);
+ void displayErrorMessage (const std::string & _message);
+ void displayCriticalMessage (const std::string & _message);
+ virtual bool onEventHardwareInput (const ewol::key::keyboardSystem & _event,
bool _down);
Object Hierarchy:
+std::enable_shared_from_this<Object>
+ewol::object::ParameterList
+ewol::object::SignalList
+--> +ewol::Object
+--> +ewol::Widget
+--> ewol::widget::Windows
Detail:
m_colorProperty
# std::shared_ptr<ewol::resource::ColorFile> m_colorProperty;
theme color property
m_colorBg
# int32_t m_colorBg;
Default background color of the windows
Windows
# Windows ();
init
# void init ();
~Windows
+ virtual ~Windows ();
sysDraw
+ void sysDraw ();
sysOnShow
+ void sysOnShow ();
sysOnHide
+ void sysOnHide ();
sysOnKill
+ void sysOnKill ();
onShow
+ virtual void onShow ();
onHide
+ virtual void onHide ();
onKill
+ virtual bool onKill ();
onReduce
+ virtual void onReduce ();
onStateBackground
+ virtual void onStateBackground ();
onStateForeground
+ virtual void onStateForeground ();
onStateSuspend
+ virtual void onStateSuspend ();
onStateResume
+ virtual void onStateResume ();
on
+ virtual void on ();
setDecorationDisable
+ void setDecorationDisable ();
setDecorationEnable
+ void setDecorationEnable ();
setSubWidget
+ void setSubWidget (std::shared_ptr<ewol::Widget> _widget);
popUpWidgetPush
+ void popUpWidgetPush (std::shared_ptr<ewol::Widget> _widget);
popUpWidgetPop
+ void popUpWidgetPop ();
popUpCount
+ size_t popUpCount ();
getBackgroundColor
+ const etk::Color<float> & getBackgroundColor ();
get the background color.
Return: A reference on the color
setBackgroundColor
+ void setBackgroundColor (const etk::Color<float> & _color);
set the background color.
systemDraw
# virtual void systemDraw (const ewol::DrawProperty & _displayProp);
{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...])
This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
Parameter [input]: _displayProp properties of the current display
onRegenerateDisplay
+ virtual void onRegenerateDisplay ();
Event generated when a redraw is needed
calculateSize
+ virtual void calculateSize (const vec2 & _availlable);
Parent set the possible diplay size of the current widget whith his own possibilities
By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
Parameter [input]: _available Available x&y pixel size
getWidgetAtPos
+ virtual std::shared_ptr<ewol::Widget> getWidgetAtPos (const vec2 & _pos);
get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
Parameter [input]: _pos gAbsolute position of the requested widget knowledge
Return: nullptr No widget found<br/>pointer on the widget found
requestDestroyFromChild
+ virtual void requestDestroyFromChild (const std::shared_ptr<Object> & _child);
getSubObjectNamed
+ virtual std::shared_ptr<ewol::Object> getSubObjectNamed (const std::string & _objectName);
Retrive an object with his name (in the global list)
Parameter [input]: _name Name of the object
Return: the requested object or nullptr
setTitle
+ void setTitle (const std::string & _title);
createPopUpMessage
+ virtual void createPopUpMessage (enum popUpMessageType _type,
const std::string & _message);
Create a simple pop-up message on the screen for application error.
Parameter [input]: _type Type of the error.
Parameter [input]: _message message to display (decorated text)
displayInfoMessage
+ void displayInfoMessage (const std::string & _message);
Create a simple information message
Parameter [input]: _message message to display (decorated text)
displayWarningMessage
+ void displayWarningMessage (const std::string & _message);
Create a simple warning message
Parameter [input]: _message message to display (decorated text)
displayErrorMessage
+ void displayErrorMessage (const std::string & _message);
Create a simple error message
Parameter [input]: _message message to display (decorated text)
displayCriticalMessage
+ void displayCriticalMessage (const std::string & _message);
Create a simple critical message
Parameter [input]: _message message to display (decorated text)
onEventHardwareInput
+ virtual bool onEventHardwareInput (const ewol::key::keyboardSystem & _event,
bool _down);
+std::enable_shared_from_this<Object>
+ewol::object::ParameterList
+ewol::object::SignalList
+--> +ewol::Object
+--> +ewol::Widget
+--> ewol::widget::Windows
Detail:
m_colorProperty
# std::shared_ptr<ewol::resource::ColorFile> m_colorProperty;theme color property
m_colorBg
# int32_t m_colorBg;Default background color of the windows
Windows
# Windows ();
init
# void init ();
~Windows
+ virtual ~Windows ();
sysDraw
+ void sysDraw ();
sysOnShow
+ void sysOnShow ();
sysOnHide
+ void sysOnHide ();
sysOnKill
+ void sysOnKill ();
onShow
+ virtual void onShow ();
onHide
+ virtual void onHide ();
onKill
+ virtual bool onKill ();
onReduce
+ virtual void onReduce ();
onStateBackground
+ virtual void onStateBackground ();
onStateForeground
+ virtual void onStateForeground ();
onStateSuspend
+ virtual void onStateSuspend ();
onStateResume
+ virtual void onStateResume ();
on
+ virtual void on ();
setDecorationDisable
+ void setDecorationDisable ();
setDecorationEnable
+ void setDecorationEnable ();
setSubWidget
+ void setSubWidget (std::shared_ptr<ewol::Widget> _widget);
popUpWidgetPush
+ void popUpWidgetPush (std::shared_ptr<ewol::Widget> _widget);
popUpWidgetPop
+ void popUpWidgetPop ();
popUpCount
+ size_t popUpCount ();
getBackgroundColor
+ const etk::Color<float> & getBackgroundColor ();get the background color.
| Return: | A reference on the color |
setBackgroundColor
+ void setBackgroundColor (const etk::Color<float> & _color);set the background color.
systemDraw
# virtual void systemDraw (const ewol::DrawProperty & _displayProp);{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
| Parameter [input]: | _displayProp | properties of the current display |
onRegenerateDisplay
+ virtual void onRegenerateDisplay ();Event generated when a redraw is needed
calculateSize
+ virtual void calculateSize (const vec2 & _availlable);Parent set the possible diplay size of the current widget whith his own possibilities By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
| Parameter [input]: | _available | Available x&y pixel size |
getWidgetAtPos
+ virtual std::shared_ptr<ewol::Widget> getWidgetAtPos (const vec2 & _pos);get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
| Parameter [input]: | _pos | gAbsolute position of the requested widget knowledge |
| Return: | nullptr No widget found<br/>pointer on the widget found |
requestDestroyFromChild
+ virtual void requestDestroyFromChild (const std::shared_ptr<Object> & _child);
getSubObjectNamed
+ virtual std::shared_ptr<ewol::Object> getSubObjectNamed (const std::string & _objectName);Retrive an object with his name (in the global list)
| Parameter [input]: | _name | Name of the object |
| Return: | the requested object or nullptr |
setTitle
+ void setTitle (const std::string & _title);
createPopUpMessage
+ virtual void createPopUpMessage (enum popUpMessageType _type,Create a simple pop-up message on the screen for application error.
const std::string & _message);
| Parameter [input]: | _type | Type of the error. | Parameter [input]: | _message | message to display (decorated text) |
displayInfoMessage
+ void displayInfoMessage (const std::string & _message);Create a simple information message
| Parameter [input]: | _message | message to display (decorated text) |
displayWarningMessage
+ void displayWarningMessage (const std::string & _message);Create a simple warning message
| Parameter [input]: | _message | message to display (decorated text) |
displayErrorMessage
+ void displayErrorMessage (const std::string & _message);Create a simple error message
| Parameter [input]: | _message | message to display (decorated text) |
displayCriticalMessage
+ void displayCriticalMessage (const std::string & _message);Create a simple critical message
| Parameter [input]: | _message | message to display (decorated text) |
onEventHardwareInput
+ virtual bool onEventHardwareInput (const ewol::key::keyboardSystem & _event,
bool _down);