Class: widget::Entry

Synopsis:

+  static void           init                      (ewol::WidgetManager & _widgetManager);
+                        Entry                     (std::string _newData);
+                       ~Entry                     (void);
+  void                  setValue                  (const std::string & _newData);
+  std::string           getValue                  (void);
+  void                  setMaxChar                (int32_t _nbMax);
+  int32_t               getMaxChar                (void);
+  void                  setRegExp                 (const std::string & _expression);
+  std::string           getRegExp                 (void);
+  void                  copySelectionToClipBoard  (enum ewol::clipBoard::clipboardListe _clipboardID);
+  void                  removeSelected            (void);
+  void                  setColorText              (const etk::Color<> & _color);
+  const etk::Color<> &  getColorText              (void);
+  void                  setColorTextSelected      (const etk::Color<> & _color);
+  const etk::Color<> &  getColorTextSelected      (void);
+  void                  setEmptyText              (const std::string & _text);
+  const std::string &   getEmptyText              (void);
+  void                  onRegenerateDisplay       (void);
+  bool                  onEventInput              (const ewol::EventInput & _event);
+  bool                  onEventEntry              (const ewol::EventEntry & _event);
+  void                  onReceiveMessage          (const ewol::EMessage & _msg);
+  void                  onEventClipboard          (enum ewol::clipBoard::clipboardListe _clipboardID);
+  void                  calculateMinMaxSize       (void);
#  void                  setInternalValue          (const std::string & _newData);
#  void                  markToUpdateTextPosition  (void);
#  void                  updateTextPosition        (void);
#  void                  updateCursorPosition      (const vec2 & _pos,
                                                    bool _Selection);
#  void                  onDraw                    (void);
#  void                  onGetFocus                (void);
#  void                  onLostFocus               (void);
#  void                  changeStatusIn            (int32_t _newStatusId);
#  void                  periodicCall              (const ewol::EventTime & _event);
#  bool                  onSetConfig               (const ewol::EConfig & _conf);
#  bool                  onGetConfig               (const char * _config,
                                                    std::string & _result);

Object Hierarchy:

ewol::EObject
    +--> ewol::Widget
        +--> widget::Entry

Description:

/** * @ingroup ewolWidgetGroup * @brief Entry box display : * * ~~~~~~~~~~~~~~~~~~~~~~ * ---------------------------------------------- * | Editable Text | * ---------------------------------------------- * ~~~~~~~~~~~~~~~~~~~~~~ */

Detail:

widget::init ()

static void init(ewol::WidgetManager & _widgetManager);

---

widget::Entry ()

Entry(std::string _newData);

Contuctor

Parameter [input]: _newData The USting that might be set in the Entry box (no event generation!!)

---

widget::~Entry ()

~Entry(void);

Destuctor

---

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(void);

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(void);

Limit the number of Unicode character in the entry

Return: Number of max character set in the List.

---

setRegExp ()

void setRegExp(const std::string & _expression);

Limit the input entry at a regular expression... (by default it is "*")

Parameter: _expression New regular expression

---

getRegExp ()

std::string getRegExp(void);

get the regualar expression limitation

Parameter: The regExp string

---

copySelectionToClipBoard ()

void copySelectionToClipBoard(enum ewol::clipBoard::clipboardListe _clipboardID);

Copy the selected data on the specify clipboard

Parameter [input]: _clipboardID Selected clipboard

---

removeSelected ()

void removeSelected(void);

remove the selected area
Notes: This request a regeneration of the display

---

setColorText ()

void setColorText(const etk::Color<> & _color);

set text color.

Parameter: _color Color that is selected.

---

getColorText ()

const etk::Color<> & getColorText(void);

get the color for the text.

Return: The color requested.

---

setColorTextSelected ()

void setColorTextSelected(const etk::Color<> & _color);

set text backgroung color when selected.

Parameter: _color Color that is selected.

---

getColorTextSelected ()

const etk::Color<> & getColorTextSelected(void);

get the selected color for the text in selection mode.

Return: The color requested.

---

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(void);

get The text displayed when nothing is in the entry.

Return: Text display when nothing

---

onRegenerateDisplay ()

void onRegenerateDisplay(void);

---

onEventInput ()

bool onEventInput(const ewol::EventInput & _event);

---

onEventEntry ()

bool onEventEntry(const ewol::EventEntry & _event);

---

onReceiveMessage ()

void onReceiveMessage(const ewol::EMessage & _msg);

---

onEventClipboard ()

void onEventClipboard(enum ewol::clipBoard::clipboardListe _clipboardID);

---

calculateMinMaxSize ()

void calculateMinMaxSize(void);

---

setInternalValue ()

void setInternalValue(const std::string & _newData);

internal check the value with RegExp checking

Parameter [input]: _newData The new string to display

---

markToUpdateTextPosition ()

void markToUpdateTextPosition(void);

informe the system thet the text change and the start position change

---

updateTextPosition ()

void updateTextPosition(void);

update the display position start == > depending of the position of the Cursor and the size of the Data inside

---

updateCursorPosition ()

void updateCursorPosition(const vec2 & _pos,
                          bool _Selection);

change the cursor position with the curent position requested on the display
Notes: The display is automaticly requested when change apear.

Parameter [input]: _pos Absolute position of the event

---

onDraw ()

void onDraw(void);

---

onGetFocus ()

void onGetFocus(void);

---

onLostFocus ()

void onLostFocus(void);

---

changeStatusIn ()

void changeStatusIn(int32_t _newStatusId);

---

periodicCall ()

void periodicCall(const ewol::EventTime & _event);

---

onSetConfig ()

bool onSetConfig(const ewol::EConfig & _conf);

---

onGetConfig ()

bool onGetConfig(const char * _config,
                 std::string & _result);

---