List of Single Color objects. More...

#include <oyNamedColors_s.h>

Inheritance diagram for oyNamedColors_s:

Collaboration diagram for oyNamedColors_s:

Public Member Functions
OYAPI oyNamedColors_s *OYEXPORT	oyNamedColors_New (oyObject_s object)
	allocate a new NamedColors object More...

OYAPI oyNamedColors_s *OYEXPORT	oyNamedColors_Copy (oyNamedColors_s *namedcolors, oyObject_s object)
	Copy or Reference a NamedColors object. More...

OYAPI int OYEXPORT	oyNamedColors_Release (oyNamedColors_s **namedcolors)
	release and possibly deallocate a oyNamedColors_s object More...

OYAPI int OYEXPORT	oyNamedColors_MoveIn (oyNamedColors_s list, oyNamedColor_s *obj, int pos)
	add an element to a NamedColors list More...

OYAPI int OYEXPORT	oyNamedColors_ReleaseAt (oyNamedColors_s *list, int pos)
	release a element from a NamedColors list More...

OYAPI oyNamedColor_s *OYEXPORT	oyNamedColors_Get (oyNamedColors_s *list, int pos)
	get a element of a NamedColors list More...

OYAPI int OYEXPORT	oyNamedColors_Count (oyNamedColors_s *list)
	count the elements in a NamedColors list More...

OYAPI int OYEXPORT	oyNamedColors_Clear (oyNamedColors_s *list)
	clear the elements in a NamedColors list More...

OYAPI int OYEXPORT	oyNamedColors_Sort (oyNamedColors_s list, int32_t rank_list)
	sort a list according to a rank_list More...

void	oyNamedColors_SetPrefix (oyNamedColors_s colors, const char string)
	set name prefix More...

void	oyNamedColors_SetSuffix (oyNamedColors_s colors, const char string)
	set name suffix More...

const char *	oyNamedColors_GetPrefix (oyNamedColors_s *colors)
	get name prefix More...

const char *	oyNamedColors_GetSuffix (oyNamedColors_s *colors)
	get name suffix More...

const char *	oyNamedColors_GetColorName (oyNamedColors_s *colors, int pos)
	get full length name More...

void	oyNamedColors_Release__Members (oyNamedColors_s_ *namedcolors)
	Custom NamedColors destructor. More...

int	oyNamedColors_Init__Members (oyNamedColors_s_ *namedcolors OY_UNUSED)
	Custom NamedColors constructor. More...

int	oyNamedColors_Copy__Members (oyNamedColors_s_ dst, oyNamedColors_s_ src)
	Custom NamedColors copy constructor. More...

Public Member Functions inherited from oyList_s
OYAPI oyList_s *OYEXPORT	oyList_New (oyObject_s object)
	allocate a new List object More...

OYAPI oyList_s *OYEXPORT	oyList_Copy (oyList_s *list, oyObject_s object)
	Copy or Reference a List object. More...

OYAPI int OYEXPORT	oyList_Release (oyList_s **list)
	release and possibly deallocate a oyList_s object More...

OYAPI int OYEXPORT	oyList_MoveIn (oyList_s list, oyLis_s *obj, int pos)
	add an element to a List list More...

OYAPI int OYEXPORT	oyList_ReleaseAt (oyList_s *list, int pos)
	release a element from a List list More...

OYAPI oyLis_s *OYEXPORT	oyList_Get (oyList_s *list, int pos)
	get a element of a List list More...

OYAPI int OYEXPORT	oyList_Count (oyList_s *list)
	count the elements in a List list More...

OYAPI int OYEXPORT	oyList_Clear (oyList_s *list)
	clear the elements in a List list More...

OYAPI int OYEXPORT	oyList_Sort (oyList_s list, int32_t rank_list)
	sort a list according to a rank_list More...

void	oyList_Release__Members (oyList_s_ *list OY_UNUSED)
	Custom List destructor. More...

int	oyList_Init__Members (oyList_s_ *list OY_UNUSED)
	Custom List constructor. More...

int	oyList_Copy__Members (oyList_s_ dst OY_UNUSED, oyList_s_ src OY_UNUSED)
	Custom List copy constructor. More...

Public Member Functions inherited from oyStruct_s
const char *	oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get object infos from a module More...

const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	Get a text dump. More...

int	oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f msg, oyStruct_RegisterStaticFreeFunc_f free_func)
	register a function for verbosity More...

const char *	oyStruct_GetInfo (oyPointer context_object, oyNAME_e type, int flags)
	get a additional string from a object More...

const char *	oyStructTypeToText (oyOBJECT_e type)
	Objects type to small string. More...

Data Fields
const oyOBJECT_e	type_
	Type of object. More...

oyStruct_Copy_f	copy
	Copy function. More...

oyStruct_Release_f	release
	Release function. More...

oyObject_s	oy_
	Oyranos internal object. More...

Data Fields inherited from oyList_s
const oyOBJECT_e	type_
	Type of object. More...

oyStruct_Copy_f	copy
	Copy function. More...

oyStruct_Release_f	release
	Release function. More...

oyObject_s	oy_
	Oyranos internal object. More...

Data Fields inherited from oyStruct_s
const oyOBJECT_e	type_
	Type of object. More...

oyStruct_Copy_f	copy
	Copy function. More...

oyStruct_Release_f	release
	Release function. More...

oyObject_s	oy_
	Oyranos internal object. More...

Detailed Description

List of Single Color objects.

Version: Oyranos: 0.9.5

Since: 2007/10/00 (Oyranos: 0.1.8)

Date: 2013/08/15

Member Function Documentation

◆ oyNamedColors_Clear()

OYAPI int OYEXPORT oyNamedColors_Clear ( oyNamedColors_s * list )

clear the elements in a NamedColors list

Function oyNamedColors_Clear

Parameters

[in,out] list the list

Returns: 0 - success; otherwise - error

Version: Oyranos: 0.3.0

Since: 2011/02/01 (Oyranos: 0.3.0)

Date: 2011/02/01

◆ oyNamedColors_Copy()

OYAPI oyNamedColors_s *OYEXPORT oyNamedColors_Copy	(	oyNamedColors_s *	namedcolors,
		oyObject_s	object
	)

Copy or Reference a NamedColors object.

Function oyNamedColors_Copy

The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.

Parameters

[in]	namedcolors	NamedColors struct object
	object	NULL - means reference, the optional object triggers a real copy

◆ oyNamedColors_Copy__Members()

int oyNamedColors_Copy__Members	(	oyNamedColors_s_ *	dst,
		oyNamedColors_s_ *	src
	)

Custom NamedColors copy constructor.

Function oyNamedColors_Copy__Members

◆ oyNamedColors_Count()

OYAPI int OYEXPORT oyNamedColors_Count ( oyNamedColors_s * list )

count the elements in a NamedColors list

Function oyNamedColors_Count

Parameters

[in,out] list the list

Returns: element count

Version: Oyranos: 0.1.10

Since: 2010/07/05 (Oyranos: 0.1.10)

Date: 2010/07/05

◆ oyNamedColors_Get()

OYAPI oyNamedColor_s *OYEXPORT oyNamedColors_Get	(	oyNamedColors_s *	list,
		int	pos
	)

get a element of a NamedColors list

Function oyNamedColors_Get

Parameters

[in,out]	list	the list
	pos	position

Version: Oyranos: 0.1.10

Since: 2010/07/05 (Oyranos: 0.1.10)

Date: 2010/07/05

◆ oyNamedColors_GetColorName()

const char * oyNamedColors_GetColorName	(	oyNamedColors_s *	colors,
		int	pos
	)

get full length name

The name is constructed from suffix, name and prefix.

Parameters

[in]	colors	Oyranos colors struct pointer
[in]	pos	nth color in list

Returns: string

Version: Oyranos: 0.9.5

Date: 2013/12/12

Since: 2013/09/03 (Oyranos: 0.9.5)

◆ oyNamedColors_GetPrefix()

const char * oyNamedColors_GetPrefix ( oyNamedColors_s * colors )

get name prefix

Parameters

[in] colors Oyranos colors struct pointer

Returns: prefix string

Version: Oyranos: 0.9.5

Date: 2013/09/03

Since: 2013/09/03 (Oyranos: 0.9.5)

◆ oyNamedColors_GetSuffix()

const char * oyNamedColors_GetSuffix ( oyNamedColors_s * colors )

get name suffix

Parameters

[in] colors Oyranos colors struct pointer

Returns: suffix string

Version: Oyranos: 0.9.5

Date: 2013/09/03

Since: 2013/09/03 (Oyranos: 0.9.5)

◆ oyNamedColors_Init__Members()

int oyNamedColors_Init__Members ( oyNamedColors_s_ *namedcolors OY_UNUSED )

Custom NamedColors constructor.

Function oyNamedColors_Init__Members

◆ oyNamedColors_MoveIn()

OYAPI int OYEXPORT oyNamedColors_MoveIn	(	oyNamedColors_s *	list,
		oyNamedColor_s **	obj,
		int	pos
	)

add an element to a NamedColors list

Function oyNamedColors_MoveIn

Parameters

[in]	list	list
[in,out]	obj	list element
	pos	position

Version: Oyranos: 0.1.10

Since: 2010/07/05 (Oyranos: 0.1.10)

Date: 2010/07/05

◆ oyNamedColors_New()

OYAPI oyNamedColors_s *OYEXPORT oyNamedColors_New ( oyObject_s object )

allocate a new NamedColors object

Function oyNamedColors_New

◆ oyNamedColors_Release()

OYAPI int OYEXPORT oyNamedColors_Release ( oyNamedColors_s ** namedcolors )

release and possibly deallocate a oyNamedColors_s object

Function oyNamedColors_Release

Parameters

[in,out] namedcolors NamedColors struct object

◆ oyNamedColors_Release__Members()

void oyNamedColors_Release__Members ( oyNamedColors_s_ * namedcolors )

Custom NamedColors destructor.

Function oyNamedColors_Release__Members

◆ oyNamedColors_ReleaseAt()

OYAPI int OYEXPORT oyNamedColors_ReleaseAt	(	oyNamedColors_s *	list,
		int	pos
	)

release a element from a NamedColors list

Function oyNamedColors_ReleaseAt

Parameters

[in,out]	list	the list
	pos	position

Version: Oyranos: 0.1.10

Since: 2010/07/05 (Oyranos: 0.1.10)

Date: 2010/07/05

◆ oyNamedColors_SetPrefix()

void oyNamedColors_SetPrefix	(	oyNamedColors_s *	colors,
		const char *	string
	)

set name prefix

Parameters

[in]	colors	Oyranos colors struct pointer
[in]	string	prefix string

Version: Oyranos: 0.9.5

Date: 2013/08/25

Since: 2013/08/25 (Oyranos: 0.9.5)

◆ oyNamedColors_SetSuffix()

void oyNamedColors_SetSuffix	(	oyNamedColors_s *	colors,
		const char *	string
	)

set name suffix

Parameters

[in]	colors	Oyranos colors struct pointer
[in]	string	suffix string

Version: Oyranos: 0.9.5

Date: 2013/08/25

Since: 2013/08/25 (Oyranos: 0.9.5)

◆ oyNamedColors_Sort()

OYAPI int OYEXPORT oyNamedColors_Sort	(	oyNamedColors_s *	list,
		int32_t *	rank_list
	)

sort a list according to a rank_list

Function oyNamedColors_Sort

Version: Oyranos: 0.3.0

Since: 2011/02/01 (Oyranos: 0.3.0)

Date: 2011/02/01

Field Documentation

◆ copy

oyStruct_Copy_f oyNamedColors_s::copy

Copy function.

◆ oy_

oyObject_s oyNamedColors_s::oy_

Oyranos internal object.

Features name and hash. Do not change during object life time.

◆ release

oyStruct_Release_f oyNamedColors_s::release

Release function.

◆ type_

const oyOBJECT_e oyNamedColors_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ oyNamedColors_Clear()

◆ oyNamedColors_Copy()

◆ oyNamedColors_Copy__Members()

◆ oyNamedColors_Count()

◆ oyNamedColors_Get()

◆ oyNamedColors_GetColorName()

◆ oyNamedColors_GetPrefix()

◆ oyNamedColors_GetSuffix()

◆ oyNamedColors_Init__Members()

◆ oyNamedColors_MoveIn()

◆ oyNamedColors_New()

◆ oyNamedColors_Release()

◆ oyNamedColors_Release__Members()

◆ oyNamedColors_ReleaseAt()

◆ oyNamedColors_SetPrefix()

◆ oyNamedColors_SetSuffix()

◆ oyNamedColors_Sort()

Field Documentation

◆ copy

◆ oy_

◆ release

◆ type_