Generic Value Optional management

Functions
static Eina_Value *	eina_value_optional_empty_new (void)
	Creates an empty optional. This is the same as eina_value_new(EINA_VALUE_TYPE_OPTIONAL).
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_Bool	eina_value_optional_pset (Eina_Value *value, Eina_Value_Type const *subtype, const void *subvalue)
	Sets the optional with a value.
Eina_Bool	eina_value_optional_pget (Eina_Value *value, void *subvalue)
	Gets the value from an optional.
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.
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]

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

Parameters:

[in]	value	Eina Value Optional
[out]	is_empty	EINA_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

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]	subtype	Eina_Value_Type of parameter value
[in]	value	The value to be used to construct optional eina value

Returns:

EINA_TRUE on success, EINA_FALSE otherwise.

Since (EFL) :

1.17

Eina_Bool eina_value_optional_pget	(	Eina_Value *	value,
		void *	subvalue
	)

Gets the value from an optional.

Parameters:

[in]	value	Eina Value Optional to get value from
[out]	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 (EFL) :

1.17

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]	value	Eina Value Optional to be set with subvalue
[in]	subtype	Type of subvalue
[in]	subvalue	Value to be set in optional

Returns:

EINA_TRUE on success, EINA_FALSE otherwise.

Since (EFL) :

1.17

Eina_Bool eina_value_optional_reset

(

Eina_Value *

value

)

Resets eina optional to empty.

Parameters:

[in,out]

value

Eina Value Optional

Returns:

EINA_TRUE on success, EINA_FALSE otherwise.

Since (EFL) :

1.17

static const Eina_Value_Type* eina_value_optional_type_get

(

Eina_Value *

value

)

[static]

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

Parameters:

[in]

value

Eina Value Optional

Returns:

The optional sub-type.

Since (EFL) :

1.17

---

Variable Documentation

EINA_VALUE_TYPE_FILE

manages Eina_File type.

Since (EFL) :

1.21

EINA_VALUE_TYPE_OPTIONAL

manages optional type.

Since (EFL) :

1.17

EINA_VALUE_TYPE_RECTANGLE

manages Eina_Rectangle type.

Since (EFL) :

1.21