MASK (non-inheritable)

Defines a mask that will filter interactive text input.

Value

string

Set to NULL to remove the mask.

Notes

The value is checked at every change while the user types, and when VALUEMASKED is set. The whole value must match the mask; a value that is the beginning of a matching value is also accepted, any other value is refused. MASKFAIL_CB is called when a change is refused.

If you set the VALUE attribute, any text can be used. To set a value that is validated by the current MASK, use VALUEMASKED.

Pre-Defined Masks

Auxiliary Attributes

MASKCASEI (non-inheritable)

If YES, will turn the filter case-insensitive. Default: NO.

MASKNOEMPTY (non-inheritable)

If YES, the value cannot be NULL or empty. Default: NO (can be empty or NULL).

MASKDECIMALSYMBOL (non-inheritable)

The decimal symbol used by MASKFLOAT and MASKREAL. Can be "." or ",". Must be set before MASKFLOAT or MASKREAL. When not set, MASKFLOAT uses the global attribute DEFAULTDECIMALSYMBOL and MASKREAL uses ".".

MASKINT (non-inheritable) (write-only)

Defines an integer mask with limits. Format: "%d:%d" ("min:max"). It replaces the current mask, and MASK then returns the pattern of the pre-defined mask that was installed.

MASKFLOAT (non-inheritable) (write-only)

Defines a floating point mask with limits. Format: "%g:%g" ("min:max"). It replaces the current mask, and MASK then returns the pattern of the pre-defined mask that was installed.

MASKREAL (non-inheritable) (write-only)

Defines a floating point mask without limits. Can be "SIGNED" or "UNSIGNED". It replaces the current mask, and MASK then returns the pattern of the pre-defined mask that was installed.

Auxiliary Callbacks

MASKFAIL_CB: Action generated when the new text fails at the mask check. Not called by IupMatrix.

int function(Ihandle *ih, char *new_value);

ih: identifier of the element that activated the event.
new_value: Represents the new text value.

Pattern Specification

• The whole value is matched, from its first character to its last.
• "Function" codes (such as /l, /D, /w) cannot be used inside a class ([...]).
• If the character following a / does not mean a special case (such as /w or /n), it is matched without the / - that means that /q will match only q, and not /q. If you want to match /q, use //q.
• The caret (^) inside a class means negation.
• The boundary function (/b) anchors the pattern to a word boundary - it does not match anything. A word boundary is a point between a /w and a /W character.
• Concatenation has precedence over the alternation (|) operator - that is, fa|fe|fi will match fa OR fe OR fi.

Allowed pattern characters

Examples

Affects

IupText, IupMultiline, IupList and IupMatrix