class: ewol::widget::PopUp
Constructor and Destructor:
+ PopUp (const std::string & _shaperName);
+ virtual ~PopUp (void );
Synopsis:
+ void init (ewol::widget::Manager & _widgetManager);
+ const char* const configShaper;
+ const char* const configRemoveOnExternClick;
+ const char* const configAnimation;
+ const char* const configLockExpand;
+ void setShaperName (const std::string & _shaperName);
# bvec2 m_lockExpand;
+ void lockExpand (const bvec2 & _lockExpand);
+ void setRemoveOnExternClick (bool _state);
+ bool getRemoveOnExternClick (void ) const;
# virtual void onDraw (void );
# virtual bool onSetConfig (const ewol::object::Config & _conf);
# virtual bool onGetConfig (const char* _config,
std::string & _result) const;
+ virtual void periodicCall (const ewol::event::Time & _event);
+ virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+ virtual void onRegenerateDisplay (void );
+ virtual void calculateSize (const vec2 & _available);
+ virtual bool onEventInput (const ewol::event::Input & _event);
+ virtual ewol::Widget* getWidgetAtPos (const vec2 & pos);
# virtual bool onStartAnnimation (enum ewol::Widget::annimationMode _mode);
# virtual void onStopAnnimation (void );
Object Hierarchy:
+ewol::Object
+--> +ewol::Widget
+--> +ewol::widget::Container
+--> ewol::widget::PopUp
+--> ewol::widget::Parameter
+--> ewol::widget::FileChooser
+--> ewol::widget::StdPopUp
Detail:
init
+ void init (ewol::widget::Manager & _widgetManager);
configShaper
+ const char* const configShaper;
configRemoveOnExternClick
+ const char* const configRemoveOnExternClick;
configAnimation
+ const char* const configAnimation;
configLockExpand
+ const char* const configLockExpand;
PopUp
+ PopUp (const std::string & _shaperName);
Constructor
Parameter [input]: _shaperName Shaper file properties
~PopUp
+ virtual ~PopUp (void );
Destructor
setShaperName
+ void setShaperName (const std::string & _shaperName);
set the shaper name (use the contructer one this permit to not noad unused shaper)
Parameter [input]: _shaperName The new shaper filename
m_lockExpand
# bvec2 m_lockExpand;
Lock the expend of the sub widget to this one == > this permit to limit bigger subWidget
lockExpand
+ void lockExpand (const bvec2 & _lockExpand);
Limit the expend properties to the current widget (no contamination)
Parameter [input]: _lockExpend Lock mode of the expend properties
setRemoveOnExternClick
+ void setRemoveOnExternClick (bool _state);
Request the Auto-remove when the event input is set outside the widget
Parameter [input]: _state New status
getRemoveOnExternClick
+ bool getRemoveOnExternClick (void ) const;
get the status of the request the Auto-remove when the event input is set outside the widget.
Return: the status of the removing
onDraw
# virtual void onDraw (void );
Common widget drawing function (called by the drawing thread [Android, X11, ...])
onSetConfig
# virtual bool onSetConfig (const ewol::object::Config & _conf);
Configuration requested to the curent Object
Parameter [input]: _conf Configuration handle.
Return: true if the parametere has been used
onGetConfig
# virtual bool onGetConfig (const char* _config,
std::string & _result) const;
Receive a configuration message from an other element system or from the curent Object
Parameter [input]: _config Configuration name.
Parameter [output]: _result Result of the request.
Return: true if the config is set
periodicCall
+ virtual void periodicCall (const ewol::event::Time & _event);
periodic call of this widget
Parameter: _event Current time property
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 (void );
Event generated when a redraw is needed
calculateSize
+ virtual void calculateSize (const vec2 & _available);
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
onEventInput
+ virtual bool onEventInput (const ewol::event::Input & _event);
Event on an input of this Widget (finger, mouse, stilet)
Parameter [input]: _event Event properties
Return: true the event is used<br/>false the event is not used
getWidgetAtPos
+ virtual 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: NULL No widget found<br/>pointer on the widget found
onStartAnnimation
# virtual bool onStartAnnimation (enum ewol::Widget::annimationMode _mode);
Event when start the annimation.
Parameter [input]: _mode Configuring mode.
Return: true need to add periodic call.
onStopAnnimation
# virtual void onStopAnnimation (void );
Event when Stop the annimation.
+ewol::Object
+--> +ewol::Widget
+--> +ewol::widget::Container
+--> ewol::widget::PopUp
+--> ewol::widget::Parameter
+--> ewol::widget::FileChooser
+--> ewol::widget::StdPopUp
Detail:
init
+ void init (ewol::widget::Manager & _widgetManager);
configShaper
+ const char* const configShaper;
configRemoveOnExternClick
+ const char* const configRemoveOnExternClick;
configAnimation
+ const char* const configAnimation;
configLockExpand
+ const char* const configLockExpand;
PopUp
+ PopUp (const std::string & _shaperName);Constructor
| Parameter [input]: | _shaperName | Shaper file properties |
~PopUp
+ virtual ~PopUp (void );Destructor
setShaperName
+ void setShaperName (const std::string & _shaperName);set the shaper name (use the contructer one this permit to not noad unused shaper)
| Parameter [input]: | _shaperName | The new shaper filename |
m_lockExpand
# bvec2 m_lockExpand;Lock the expend of the sub widget to this one == > this permit to limit bigger subWidget
lockExpand
+ void lockExpand (const bvec2 & _lockExpand);Limit the expend properties to the current widget (no contamination)
| Parameter [input]: | _lockExpend | Lock mode of the expend properties |
setRemoveOnExternClick
+ void setRemoveOnExternClick (bool _state);Request the Auto-remove when the event input is set outside the widget
| Parameter [input]: | _state | New status |
getRemoveOnExternClick
+ bool getRemoveOnExternClick (void ) const;get the status of the request the Auto-remove when the event input is set outside the widget.
| Return: | the status of the removing |
onDraw
# virtual void onDraw (void );Common widget drawing function (called by the drawing thread [Android, X11, ...])
onSetConfig
# virtual bool onSetConfig (const ewol::object::Config & _conf);Configuration requested to the curent Object
| Parameter [input]: | _conf | Configuration handle. |
| Return: | true if the parametere has been used |
onGetConfig
# virtual bool onGetConfig (const char* _config,Receive a configuration message from an other element system or from the curent Object
std::string & _result) const;
| Parameter [input]: | _config | Configuration name. | Parameter [output]: | _result | Result of the request. |
| Return: | true if the config is set |
periodicCall
+ virtual void periodicCall (const ewol::event::Time & _event);periodic call of this widget
| Parameter: | _event | Current time property |
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 (void );Event generated when a redraw is needed
calculateSize
+ virtual void calculateSize (const vec2 & _available);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 |
onEventInput
+ virtual bool onEventInput (const ewol::event::Input & _event);Event on an input of this Widget (finger, mouse, stilet)
| Parameter [input]: | _event | Event properties |
| Return: | true the event is used<br/>false the event is not used |
getWidgetAtPos
+ virtual 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: | NULL No widget found<br/>pointer on the widget found |
onStartAnnimation
# virtual bool onStartAnnimation (enum ewol::Widget::annimationMode _mode);Event when start the annimation.
| Parameter [input]: | _mode | Configuring mode. |
| Return: | true need to add periodic call. |
onStopAnnimation
# virtual void onStopAnnimation (void );Event when Stop the annimation.