Tizen Native API  5.5
Generic Value Optional management

Functions

static Eina_Valueeina_value_optional_empty_new (void)
 Creates an empty optional. This is the same as eina_value_new(EINA_VALUE_TYPE_OPTIONAL).
static Eina_Bool eina_value_optional_empty_is (const Eina_Value *value, Eina_Bool *is_empty)
 Creates an optional eina value with the passed value.
static const Eina_Value_Typeeina_value_optional_type_get (Eina_Value *value)
 Sets the optional with a value.

Typedefs

typedef struct _Eina_Value_Struct Eina_Value_Struct

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 (EFL) :
1.2
Since (EFL) :
1.17

Function Documentation

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

Creates an optional eina value with the passed value.

Parameters:
[in]subtypeEina_Value_Type of parameter value
[in]valueThe value to be used to construct optional eina value
Returns:
EINA_TRUE on success, EINA_FALSE otherwise.
Since (EFL) :
1.17 Function to know if an eina optional is empty or not
Parameters:
[in]valueEina Value Optional
[out]is_emptyEINA_TRUE if optional is empty, EINA_FALSE otherwise.
Returns:
EINA_TRUE on success, EINA_FALSE otherwise.
Since (EFL) :
1.17
static Eina_Value* eina_value_optional_empty_new ( void  ) [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 (EFL) :
1.17
static const Eina_Value_Type* eina_value_optional_type_get ( Eina_Value value) [static]

Sets the optional with a value.

Parameters:
[in,out]valueEina Value Optional to be set with subvalue
[in]subtypeType of subvalue
[in]subvalueValue to be set in optional
Returns:
EINA_TRUE on success, EINA_FALSE otherwise.
Since (EFL) :
1.17 Gets the value from an optional
Parameters:
[in]valueEina Value Optional to get value from
[out]subvaluePointer 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 (EFL) :
1.17 Resets eina optional to empty
Parameters:
[in,out]valueEina Value Optional
Returns:
EINA_TRUE on success, EINA_FALSE otherwise.
Since (EFL) :
1.17

Gets type from value that is stored on Eina Value Optional

Parameters:
[in]valueEina Value Optional
Returns:
The optional sub-type.
Since (EFL) :
1.17

Variable Documentation

manages Eina_File type.

Since (EFL) :
1.21

manages optional type.

Since (EFL) :
1.17

manages Eina_Rectangle type.

Since (EFL) :
1.21