Typedefs | Functions | Variables
Generic Value Optional management

Typedefs

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

Functions

static Eina_Valueeina_value_optional_empty_new (void)
 Creates an empty optional. More...
 
EINA_API Eina_Valueeina_value_optional_new (const Eina_Value_Type *subtype, const void *value)
 Creates an optional eina value with the passed value. More...
 
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. More...
 
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. More...
 
EINA_API Eina_Bool eina_value_optional_pget (Eina_Value *value, void *subvalue)
 Gets the value from an optional. More...
 
EINA_API Eina_Bool eina_value_optional_reset (Eina_Value *value)
 Resets eina optional to empty. More...
 
static const Eina_Value_Typeeina_value_optional_type_get (Eina_Value *value)
 Gets type from value that is stored on Eina Value Optional. More...
 

Variables

EINA_API const Eina_Value_TypeEINA_VALUE_TYPE_OPTIONAL
 manages optional type. More...
 
EINA_API const Eina_Value_TypeEINA_VALUE_TYPE_FILE
 manages Eina_File type. More...
 
EINA_API const Eina_Value_TypeEINA_VALUE_TYPE_RECTANGLE
 manages Eina_Rectangle type. More...
 
EINA_API const Eina_Value_TypeEINA_VALUE_TYPE_OPTIONAL = NULL
 manages optional type. More...
 
EINA_API const Eina_Value_TypeEINA_VALUE_TYPE_FILE = NULL
 manages Eina_File type. More...
 
EINA_API const Eina_Value_TypeEINA_VALUE_TYPE_RECTANGLE = NULL
 manages Eina_Rectangle type. More...
 

Detailed Description

Typedef Documentation

◆ Eina_Value_Struct

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

◆ eina_value_optional_empty_new()

static Eina_Value * eina_value_optional_empty_new ( void  )
inlinestatic

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_value_optional_new()

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
[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
1.17

◆ eina_value_optional_empty_is()

static Eina_Bool eina_value_optional_empty_is ( const Eina_Value value,
Eina_Bool is_empty 
)
inlinestatic

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
1.17

◆ eina_value_optional_pset()

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
[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
1.17

◆ eina_value_optional_pget()

EINA_API Eina_Bool eina_value_optional_pget ( Eina_Value value,
void *  subvalue 
)

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
1.17

◆ eina_value_optional_reset()

EINA_API Eina_Bool eina_value_optional_reset ( Eina_Value value)

Resets eina optional to empty.

Parameters
[in,out]valueEina Value Optional
Returns
EINA_TRUE on success, EINA_FALSE otherwise.
Since
1.17

◆ eina_value_optional_type_get()

static const Eina_Value_Type * eina_value_optional_type_get ( Eina_Value value)
inlinestatic

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

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

Variable Documentation

◆ EINA_VALUE_TYPE_OPTIONAL [1/2]

EINA_API const Eina_Value_Type* EINA_VALUE_TYPE_OPTIONAL
extern

manages optional type.

Since
1.17

◆ EINA_VALUE_TYPE_FILE [1/2]

EINA_API const Eina_Value_Type* EINA_VALUE_TYPE_FILE
extern

manages Eina_File type.

Since
1.21

◆ EINA_VALUE_TYPE_RECTANGLE [1/2]

EINA_API const Eina_Value_Type* EINA_VALUE_TYPE_RECTANGLE
extern

manages Eina_Rectangle type.

Since
1.21

◆ EINA_VALUE_TYPE_OPTIONAL [2/2]

EINA_VALUE_TYPE_OPTIONAL = NULL

manages optional type.

Since
1.17

◆ EINA_VALUE_TYPE_FILE [2/2]

EINA_VALUE_TYPE_FILE = NULL

manages Eina_File type.

Since
1.21

◆ EINA_VALUE_TYPE_RECTANGLE [2/2]

EINA_VALUE_TYPE_RECTANGLE = NULL

manages Eina_Rectangle type.

Since
1.21