Eina_Value_Optional_Group(3)

NAME
Eina_Value_Optional_Group - Generic Value Optional management

SYNOPSIS

  Typedefs
typedef Eina_Value_Union Eina_Value_Optional
typedef struct _Eina_Value_Struct Eina_Value_Struct
Value type for EINA_VALUE_TYPE_STRUCT.

  Functions
static Eina_Value * eina_value_optional_empty_new (void)
Creates an empty optional.
EINA_API Eina_Value * eina_value_optional_new (const Eina_Value_Type *subtype, const void *value)
Creates an optional eina value with the passed value.
static Eina_Bool eina_value_optional_empty_is (const Eina_Value *value, Eina_Bool *is_empty)
Function to know if an eina optional is empty or not.
EINA_API Eina_Bool eina_value_optional_pset (Eina_Value *value, Eina_Value_Type const *subtype, const void *subvalue)
Sets the optional with a value.
EINA_API Eina_Bool eina_value_optional_pget (Eina_Value *value, void *subvalue)
Gets the value from an optional.
EINA_API Eina_Bool eina_value_optional_reset (Eina_Value *value)
Resets eina optional to empty.
static const Eina_Value_Type * eina_value_optional_type_get (Eina_Value *value)
Gets type from value that is stored on Eina Value Optional.

  Variables
EINA_API const Eina_Value_Type * EINA_VALUE_TYPE_OPTIONAL
manages optional type.
EINA_API const Eina_Value_Type * EINA_VALUE_TYPE_FILE
manages Eina_File type.
EINA_API const Eina_Value_Type * EINA_VALUE_TYPE_RECTANGLE
manages Eina_Rectangle type.
EINA_API const Eina_Value_Type * EINA_VALUE_TYPE_OPTIONAL = NULL
manages optional type.
EINA_API const Eina_Value_Type * EINA_VALUE_TYPE_FILE = NULL
manages Eina_File type.
EINA_API const Eina_Value_Type * EINA_VALUE_TYPE_RECTANGLE = NULL
manages Eina_Rectangle type.

Detailed Description

Typedef Documentation

  Eina_Value_Optional type to be used with Eina_Value_Struct

Value type for EINA_VALUE_TYPE_STRUCT.

See also
    _Eina_Value_Struct explains fields.

Since
    1.2

    1.17

Function Documentation

  static Eina_Value* eina_value_optional_empty_new (void) [inline], [static]

Creates an empty optional. This is the same as eina_value_new(EINA_VALUE_TYPE_OPTIONAL).

Returns
    returns an empty optional eina value.

Since
    1.17

  EINA_API Eina_Value* eina_value_optional_new (const Eina_Value_Type * subtype, const void * value)

Creates an optional eina value with the passed value.

Parameters
    subtype Eina_Value_Type of parameter value
    value The value to be used to construct optional eina value

Returns
    EINA_TRUE on success, EINA_FALSE otherwise.

Since
    1.17

  static Eina_Bool eina_value_optional_empty_is (const Eina_Value * value, Eina_Bool * is_empty) [inline], [static]

Function to know if an eina optional is empty or not.

Parameters
    value Eina Value Optional
    is_empty EINA_TRUE if optional is empty, EINA_FALSE otherwise.

Returns
    EINA_TRUE on success, EINA_FALSE otherwise.

Since
    1.17

  EINA_API Eina_Bool eina_value_optional_pset (Eina_Value * value, Eina_Value_Type const * subtype, const void * subvalue)

Sets the optional with a value.

Parameters
    value Eina Value Optional to be set with subvalue
    subtype Type of subvalue
    subvalue Value to be set in optional

Returns
    EINA_TRUE on success, EINA_FALSE otherwise.

Since
    1.17

  EINA_API Eina_Bool eina_value_optional_pget (Eina_Value * value, void * subvalue)

Gets the value from an optional.

Parameters
    value Eina Value Optional to get value from
    subvalue Pointer to where value is to be copied to. You must use the correct type according to eina_value_optional_type_get

Returns
    EINA_TRUE on success, EINA_FALSE otherwise.

Since
    1.17

  EINA_API Eina_Bool eina_value_optional_reset (Eina_Value * value)

Resets eina optional to empty.

Parameters
    value Eina Value Optional

Returns
    EINA_TRUE on success, EINA_FALSE otherwise.

Since
    1.17

  static const Eina_Value_Type* eina_value_optional_type_get (Eina_Value * value) [inline], [static]

Gets type from value that is stored on Eina Value Optional.

Parameters
    value Eina Value Optional

Returns
    The optional sub-type.

Since
    1.17

Variable Documentation

  EINA_API const Eina_Value_Type* EINA_VALUE_TYPE_OPTIONAL [extern]

manages optional type.

Since
    1.17

  EINA_API const Eina_Value_Type* EINA_VALUE_TYPE_FILE [extern]

manages Eina_File type.

Since
    1.21

  EINA_API const Eina_Value_Type* EINA_VALUE_TYPE_RECTANGLE [extern]

manages Eina_Rectangle type.

Since
    1.21

  EINA_VALUE_TYPE_OPTIONAL = NULL

manages optional type.

Since
    1.17

  EINA_VALUE_TYPE_FILE = NULL

manages Eina_File type.

Since
    1.21

  EINA_VALUE_TYPE_RECTANGLE = NULL

manages Eina_Rectangle type.

Since
    1.21

Author

Generated automatically by Doxygen for EFL from the source code.