class: ewol::widget::CheckBox
Description:
Constructor and Destructor:
# CheckBox ();
+ virtual ~CheckBox ();
Synopsis:
+ ewol::object::Signal<void> signalPressed;
+ ewol::object::Signal<void> signalDown;
+ ewol::object::Signal<void> signalUp;
+ ewol::object::Signal<void> signalEnter;
+ ewol::object::Signal<bool> signalValue;
# void init (const std::string & _shaperName);
+ DECLARE_WIDGET_FACTORY (CheckBox ,
"CheckBox" );
+ void setShaperName (const std::string & _shaperName);
# ewol::object::Param<bool> m_value;
+ void setValue (bool _val);
+ bool getValue () const;
# void changeStatusIn (int32_t _newStatusId);
# void CheckStatus ();
# virtual void onDraw ();
# virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);
+ virtual void calculateMinMaxSize ();
+ virtual void calculateSize (const vec2 & _availlable);
+ virtual void onRegenerateDisplay ();
+ virtual bool onEventInput (const ewol::event::Input & _event);
+ virtual bool onEventEntry (const ewol::event::Entry & _event);
+ virtual void periodicCall (const ewol::event::Time & _event);
Object Hierarchy:
+std::enable_shared_from_this<Object>
+ewol::object::ParameterList
+ewol::object::SignalList
+--> +ewol::Object
+--> +ewol::Widget
+--> +ewol::widget::Container2
+--> ewol::widget::CheckBox
Detail:
signalPressed
+ ewol::object::Signal<void> signalPressed;
signalDown
+ ewol::object::Signal<void> signalDown;
signalUp
+ ewol::object::Signal<void> signalUp;
signalEnter
+ ewol::object::Signal<void> signalEnter;
signalValue
+ ewol::object::Signal<bool> signalValue;
CheckBox
# CheckBox ();
Main checkbox constructor
Parameter [input]: _shaperName Shaper file properties
init
# void init (const std::string & _shaperName);
DECLARE_WIDGET_FACTORY
+ DECLARE_WIDGET_FACTORY (CheckBox ,
"CheckBox" );
~CheckBox
+ virtual ~CheckBox ();
main 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_value
# ewol::object::Param<bool> m_value;
Current state of the checkbox.
setValue
+ void setValue (bool _val);
set the current value of the checkbox (check or not)
Parameter [input]: _val New value of the button
getValue
+ bool getValue () const;
get the current button value.
Return: True : The checkbox is active.<br/>false : The checkbox is disable.
changeStatusIn
# void changeStatusIn (int32_t _newStatusId);
internal system to change the property of the current status
Parameter [input]: _newStatusId new state
CheckStatus
# void CheckStatus ();
update the status with the internal satte of the button ...
onDraw
# virtual void onDraw ();
Common widget drawing function (called by the drawing thread [Android, X11, ...])
onParameterChangeValue
# virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);
calculateMinMaxSize
+ virtual void calculateMinMaxSize ();
calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
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
onRegenerateDisplay
+ virtual void onRegenerateDisplay ();
Event generated when a redraw is needed
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
onEventEntry
+ virtual bool onEventEntry (const ewol::event::Entry & _event);
Entry event.
represent the physical event :
- Keyboard (key event and move event)
- Accelerometer
- Joystick
Parameter [input]: _event Event properties
Return: true if the event has been used<br/>false if the event has not been used
periodicCall
+ virtual void periodicCall (const ewol::event::Time & _event);
periodic call of this widget
Parameter: _event Current time property
+std::enable_shared_from_this<Object>
+ewol::object::ParameterList
+ewol::object::SignalList
+--> +ewol::Object
+--> +ewol::Widget
+--> +ewol::widget::Container2
+--> ewol::widget::CheckBox
Detail:
signalPressed
+ ewol::object::Signal<void> signalPressed;
signalDown
+ ewol::object::Signal<void> signalDown;
signalUp
+ ewol::object::Signal<void> signalUp;
signalEnter
+ ewol::object::Signal<void> signalEnter;
signalValue
+ ewol::object::Signal<bool> signalValue;
CheckBox
# CheckBox ();Main checkbox constructor
| Parameter [input]: | _shaperName | Shaper file properties |
init
# void init (const std::string & _shaperName);
DECLARE_WIDGET_FACTORY
+ DECLARE_WIDGET_FACTORY (CheckBox ,
"CheckBox" );
~CheckBox
+ virtual ~CheckBox ();main 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_value
# ewol::object::Param<bool> m_value;Current state of the checkbox.
setValue
+ void setValue (bool _val);set the current value of the checkbox (check or not)
| Parameter [input]: | _val | New value of the button |
getValue
+ bool getValue () const;get the current button value.
| Return: | True : The checkbox is active.<br/>false : The checkbox is disable. |
changeStatusIn
# void changeStatusIn (int32_t _newStatusId);internal system to change the property of the current status
| Parameter [input]: | _newStatusId | new state |
CheckStatus
# void CheckStatus ();update the status with the internal satte of the button ...
onDraw
# virtual void onDraw ();Common widget drawing function (called by the drawing thread [Android, X11, ...])
onParameterChangeValue
# virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);
calculateMinMaxSize
+ virtual void calculateMinMaxSize ();calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
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 |
onRegenerateDisplay
+ virtual void onRegenerateDisplay ();Event generated when a redraw is needed
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 |
onEventEntry
+ virtual bool onEventEntry (const ewol::event::Entry & _event);Entry event. represent the physical event : - Keyboard (key event and move event) - Accelerometer - Joystick
| Parameter [input]: | _event | Event properties |
| Return: | true if the event has been used<br/>false if the event has not been used |
periodicCall
+ virtual void periodicCall (const ewol::event::Time & _event);periodic call of this widget
| Parameter: | _event | Current time property |