class: ewol::widget::Entry
Constructor and Destructor:
+ Entry ();
+ virtual ~Entry ();
Synopsis:
+ ewol::object::Signal<void> signalClick;
+ ewol::object::Signal<std::string> signalEnter;
+ ewol::object::Signal<std::string> signalModify;
+ void init (const std::string & _newData);
+ DECLARE_WIDGET_FACTORY (Entry ,
"Entry" );
# void setInternalValue (const std::string & _newData);
+ void setValue (const std::string & _newData);
+ std::string getValue () const;
+ void setMaxChar (int32_t _nbMax);
+ int32_t getMaxChar () const;
+ void setRegex (const std::string & _expression);
+ std::string getRegex () const;
# virtual void markToUpdateTextPosition ();
# virtual void updateTextPosition ();
# virtual void updateCursorPosition (const vec2 & _pos,
bool _Selection);
+ virtual void copySelectionToClipBoard (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+ virtual void removeSelected ();
+ void setEmptyText (const std::string & _text);
+ const std::string & getEmptyText () const;
+ virtual void onRegenerateDisplay ();
+ virtual bool onEventInput (const ewol::event::Input & _event);
+ virtual bool onEventEntry (const ewol::event::Entry & _event);
+ virtual void onEventClipboard (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+ virtual void calculateMinMaxSize ();
# virtual void onDraw ();
# virtual void onGetFocus ();
# virtual void onLostFocus ();
# virtual void changeStatusIn (int32_t _newStatusId);
# virtual void periodicCall (const ewol::event::Time & _event);
# virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);
Object Hierarchy:
+std::enable_shared_from_this<Object>
+ewol::object::ParameterList
+ewol::object::SignalList
+--> +ewol::Object
+--> +ewol::Widget
+--> ewol::widget::Entry
Detail:
signalClick
+ ewol::object::Signal<void> signalClick;
bang on click the entry box
signalEnter
+ ewol::object::Signal<std::string> signalEnter;
Enter key is pressed
signalModify
+ ewol::object::Signal<std::string> signalModify;
data change
Entry
+ Entry ();
Contuctor
Parameter [input]: _newData The USting that might be set in the Entry box (no event generation!!)
init
+ void init (const std::string & _newData);
DECLARE_WIDGET_FACTORY
+ DECLARE_WIDGET_FACTORY (Entry ,
"Entry" );
~Entry
+ virtual ~Entry ();
Destuctor
setInternalValue
# void setInternalValue (const std::string & _newData);
internal check the value with RegExp checking
Parameter [input]: _newData The new string to display
setValue
+ void setValue (const std::string & _newData);
set a new value on the entry.
Parameter [input]: _newData the new string to display.
getValue
+ std::string getValue () const;
get the current value in the entry
Return: The current display value
setMaxChar
+ void setMaxChar (int32_t _nbMax);
Limit the number of Unicode character in the entry
Parameter [input]: _nbMax Number of max character set in the List (0x7FFFFFFF for no limit)
getMaxChar
+ int32_t getMaxChar () const;
Limit the number of Unicode character in the entry
Return: Number of max character set in the List.
setRegex
+ void setRegex (const std::string & _expression);
Limit the input entry at a regular expression... (by default it is "")
Parameter: _expression New regular expression
getRegex
+ std::string getRegex () const;
get the regualar expression limitation
Parameter: The regExp string
markToUpdateTextPosition
# virtual void markToUpdateTextPosition ();
informe the system thet the text change and the start position change
updateTextPosition
# virtual void updateTextPosition ();
update the display position start == > depending of the position of the Cursor and the size of the Data inside
updateCursorPosition
# virtual void updateCursorPosition (const vec2 & _pos,
bool _Selection);
change the cursor position with the curent position requested on the display
Note: The display is automaticly requested when change apear.
Parameter [input]: _pos Absolute position of the event
copySelectionToClipBoard
+ virtual void copySelectionToClipBoard (enum ewol::context::clipBoard::clipboardListe _clipboardID);
Copy the selected data on the specify clipboard
Parameter [input]: _clipboardID Selected clipboard
removeSelected
+ virtual void removeSelected ();
remove the selected area
Note: This request a regeneration of the display
setEmptyText
+ void setEmptyText (const std::string & _text);
set The text displayed when nothing is in the entry.
Parameter: _text Text to display when the entry box is empty (this text can be decorated).
getEmptyText
+ const std::string & getEmptyText () const;
get The text displayed when nothing is in the entry.
Return: Text display when nothing
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
onEventClipboard
+ virtual void onEventClipboard (enum ewol::context::clipBoard::clipboardListe _clipboardID);
Event on a past event == > this event is asynchronous due to all system does not support direct getting datas
Note: : need to have focus ...
Parameter [input]: mode Mode of data requested
calculateMinMaxSize
+ virtual void calculateMinMaxSize ();
calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
onDraw
# virtual void onDraw ();
Common widget drawing function (called by the drawing thread [Android, X11, ...])
onGetFocus
# virtual void onGetFocus ();
Event of the focus has been grep by the current widget
onLostFocus
# virtual void onLostFocus ();
Event of the focus has been lost by the current widget
changeStatusIn
# virtual void changeStatusIn (int32_t _newStatusId);
periodicCall
# virtual void periodicCall (const ewol::event::Time & _event);
periodic call of this widget
Parameter: _event Current time property
onParameterChangeValue
# virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);
+std::enable_shared_from_this<Object>
+ewol::object::ParameterList
+ewol::object::SignalList
+--> +ewol::Object
+--> +ewol::Widget
+--> ewol::widget::Entry
Detail:
signalClick
+ ewol::object::Signal<void> signalClick;bang on click the entry box
signalEnter
+ ewol::object::Signal<std::string> signalEnter;Enter key is pressed
signalModify
+ ewol::object::Signal<std::string> signalModify;data change
Entry
+ Entry ();Contuctor
| Parameter [input]: | _newData | The USting that might be set in the Entry box (no event generation!!) |
init
+ void init (const std::string & _newData);
DECLARE_WIDGET_FACTORY
+ DECLARE_WIDGET_FACTORY (Entry ,
"Entry" );
~Entry
+ virtual ~Entry ();Destuctor
setInternalValue
# void setInternalValue (const std::string & _newData);internal check the value with RegExp checking
| Parameter [input]: | _newData | The new string to display |
setValue
+ void setValue (const std::string & _newData);set a new value on the entry.
| Parameter [input]: | _newData | the new string to display. |
getValue
+ std::string getValue () const;get the current value in the entry
| Return: | The current display value |
setMaxChar
+ void setMaxChar (int32_t _nbMax);Limit the number of Unicode character in the entry
| Parameter [input]: | _nbMax | Number of max character set in the List (0x7FFFFFFF for no limit) |
getMaxChar
+ int32_t getMaxChar () const;Limit the number of Unicode character in the entry
| Return: | Number of max character set in the List. |
setRegex
+ void setRegex (const std::string & _expression);Limit the input entry at a regular expression... (by default it is "")
| Parameter: | _expression | New regular expression |
getRegex
+ std::string getRegex () const;get the regualar expression limitation
| Parameter: | The | regExp string |
markToUpdateTextPosition
# virtual void markToUpdateTextPosition ();informe the system thet the text change and the start position change
updateTextPosition
# virtual void updateTextPosition ();update the display position start == > depending of the position of the Cursor and the size of the Data inside
updateCursorPosition
# virtual void updateCursorPosition (const vec2 & _pos,change the cursor position with the curent position requested on the display
bool _Selection);
Note: The display is automaticly requested when change apear.
| Parameter [input]: | _pos | Absolute position of the event |
copySelectionToClipBoard
+ virtual void copySelectionToClipBoard (enum ewol::context::clipBoard::clipboardListe _clipboardID);Copy the selected data on the specify clipboard
| Parameter [input]: | _clipboardID | Selected clipboard |
removeSelected
+ virtual void removeSelected ();remove the selected area
Note: This request a regeneration of the display
setEmptyText
+ void setEmptyText (const std::string & _text);set The text displayed when nothing is in the entry.
| Parameter: | _text | Text to display when the entry box is empty (this text can be decorated). |
getEmptyText
+ const std::string & getEmptyText () const;get The text displayed when nothing is in the entry.
| Return: | Text display when nothing |
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 |
onEventClipboard
+ virtual void onEventClipboard (enum ewol::context::clipBoard::clipboardListe _clipboardID);Event on a past event == > this event is asynchronous due to all system does not support direct getting datas
Note: : need to have focus ...
| Parameter [input]: | mode | Mode of data requested |
calculateMinMaxSize
+ virtual void calculateMinMaxSize ();calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
onDraw
# virtual void onDraw ();Common widget drawing function (called by the drawing thread [Android, X11, ...])
onGetFocus
# virtual void onGetFocus ();Event of the focus has been grep by the current widget
onLostFocus
# virtual void onLostFocus ();Event of the focus has been lost by the current widget
changeStatusIn
# virtual void changeStatusIn (int32_t _newStatusId);
periodicCall
# virtual void periodicCall (const ewol::event::Time & _event);periodic call of this widget
| Parameter: | _event | Current time property |
onParameterChangeValue
# virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);