Helper(3)

NAME
Helper - Helper

 - The validation helper feature.

SYNOPSIS

  Data Structures
struct _Elm_Validate_Content

  Typedefs
typedef struct _Elm_Validate_Content Elm_Validate_Content
Data for the elm_validator_regexp_helper()
typedef struct _Elm_Validator_Regexp Elm_Validator_Regexp
The Regexp validator data.

  Enumerations
enum Elm_Regexp_Status { ELM_REG_NOERROR = 0, ELM_REG_NOMATCH, ELM_REG_BADPAT }
Enumeration that defines the regex error codes.

  Functions
Elm_Validator_Regexp * elm_validator_regexp_new (const char *pattern, const char *signal)
Create a new regex validator.
void elm_validator_regexp_free (Elm_Validator_Regexp *validator)
Delete the existing regex validator.
Elm_Regexp_Status elm_validator_regexp_status_get (Elm_Validator_Regexp *validator)
Get the validation status.
void elm_validator_regexp_helper (void *data, const Efl_Event *event)
The regex validator.

Detailed Description

The validation helper feature.

Enumeration Type Documentation

  enum Elm_Regexp_Status

Enumeration that defines the regex error codes.

Since
    1.14

Enumerator

ELM_REG_NOERROR
    Regex maches to the Entrys text.

ELM_REG_NOMATCH
    Failed to match.

ELM_REG_BADPAT
    Invalid regular expression.

Function Documentation

  Elm_Validator_Regexp* elm_validator_regexp_new (const char * pattern, const char * signal)

Create a new regex validator. General designed for validate inputed entry text.

Parameters
    pattern The regex pattern
    signal The part of signal name, which will be emitted to style

Returns
    The regex validator

See also
    elm_validator_regexp_free()

    elm_validator_regexp_status_get()

    elm_validator_regexp_helper()

Since
    1.14

References eina_stringshare_add(), ELM_REG_BADPAT, and ELM_REG_NOERROR.

  void elm_validator_regexp_free (Elm_Validator_Regexp * validator)

Delete the existing regex validator.

Parameters
    validator The given validator

See also
    elm_validator_regexp_new()

Since
    1.14

References eina_stringshare_del().

  Elm_Regexp_Status elm_validator_regexp_status_get (Elm_Validator_Regexp * validator)

Get the validation status.

Parameters
    validator The given validator

Note
    All return value see here: http://www.gnu.org/software/libc/manual/html_node/Regular-Expressions.html

Since
    1.14

  void elm_validator_regexp_helper (void * data, const Efl_Event * event)

The regex validator. Used as callback to validate event.

Example:

extern Evas_Object *parent;
Evas_Object *entry;
Elm_Validator_Regexp *re;
//add validator
entry = elm_entry_add(parent);
re = elm_validator_regexp_new("^[0-9]*$", NULL);
efl_event_callback_add(entry, ELM_ENTRY_EVENT_VALIDATE, elm_validator_regexp_helper, re);
//delete validator
efl_event_callback_del(entry, ELM_ENTRY_EVENT_VALIDATE, elm_validator_regexp_helper, re);

See also
    elm_validator_regexp_new()

Since
    1.14

References ELM_REG_NOERROR, and ELM_REG_NOMATCH.

Author

Generated automatically by Doxygen for EFL from the source code.