Oyranos Color Management System API - Version 0.9.6
Public Member Functions | Data Fields
oyList_s Struct Reference

a pointer list More...

#include <oyList_s.h>

Inheritance diagram for oyList_s:
Inheritance graph
Collaboration diagram for oyList_s:
Collaboration graph

Public Member Functions

OYAPI oyList_s *OYEXPORT oyList_New (oyObject_s object)
 allocate a new List object More...
 
 oyList_Copy
 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)
 Custom List destructor. More...
 
int oyList_Init__Members (oyList_s_ *list)
 Custom List constructor. More...
 
int oyList_Copy__Members (oyList_s_ *dst, oyList_s_ *src)
 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...
 
 oyStruct_RegisterStaticMessageFunc
 register a function for verbosity More...
 
 oyStruct_GetInfo
 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 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

a pointer list

Member Function Documentation

OYAPI int OYEXPORT oyList_Clear ( oyList_s list)

clear the elements in a List list

Function oyList_Clear

Parameters
[in,out]listthe list
Returns
0 - success; otherwise - error
Version
Oyranos: 0.3.0
Since
2011/02/01 (Oyranos: 0.3.0)
Date
2011/02/01

References oyOBJECT_LIST_S, and oyStructList_s::oyStructList_Clear().

oyList_Copy

Copy or Reference a List object.

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

Parameters
[in]listList struct object
objectNULL - means reference, the optional object triggers a real copy

Referenced by oyList_Copy__Members(), and oyList_New().

int oyList_Copy__Members ( oyList_s_ *  dst,
oyList_s_ *  src 
)
OYAPI int OYEXPORT oyList_Count ( oyList_s list)

count the elements in a List list

Function oyList_Count

Parameters
[in,out]listthe list
Returns
element count
Version
Oyranos: 0.1.10
Since
2010/07/05 (Oyranos: 0.1.10)
Date
2010/07/05

References oyOBJECT_LIST_S, and oyStructList_s::oyStructList_Count().

OYAPI oyLis_s *OYEXPORT oyList_Get ( oyList_s list,
int  pos 
)

get a element of a List list

Function oyList_Get

Parameters
[in,out]listthe list
posposition
Version
Oyranos: 0.1.10
Since
2010/07/05 (Oyranos: 0.1.10)
Date
2010/07/05

References oyOBJECT_LIS_S, oyOBJECT_LIST_S, and oyStructList_s::oyStructList_GetRefType().

int oyList_Init__Members ( oyList_s_ *  list)

Custom List constructor.

Function oyList_Init__Members

Referenced by oyList_Copy__Members(), and oyNamedColors_s::oyNamedColors_Copy__Members().

OYAPI int OYEXPORT oyList_MoveIn ( oyList_s list,
oyLis_s **  obj,
int  pos 
)

add an element to a List list

Function oyList_MoveIn

Parameters
[in]listlist
[in,out]objlist element
posposition
Version
Oyranos: 0.1.10
Since
2010/07/05 (Oyranos: 0.1.10)
Date
2010/07/05

References oyOBJECT_LIS_S, oyOBJECT_LIST_S, oyStructList_s::oyStructList_Create(), and oyStructList_s::oyStructList_MoveIn().

OYAPI oyList_s *OYEXPORT oyList_New ( oyObject_s  object)

allocate a new List object

Function oyList_New

References oyList_Copy(), oyOBJECT_LIST_S, and oyOBJECT_OBJECT_S.

Referenced by oyList_Copy__Members().

OYAPI int OYEXPORT oyList_Release ( oyList_s **  list)

release and possibly deallocate a oyList_s object

Function oyList_Release

Parameters
[in,out]listList struct object

References oyOBJECT_LIST_S.

Referenced by oyList_Copy__Members().

void oyList_Release__Members ( oyList_s_ *  list)

Custom List destructor.

Function oyList_Release__Members

Referenced by oyList_Copy__Members(), and oyNamedColors_s::oyNamedColors_Copy__Members().

OYAPI int OYEXPORT oyList_ReleaseAt ( oyList_s list,
int  pos 
)

release a element from a List list

Function oyList_ReleaseAt

Parameters
[in,out]listthe list
posposition
Version
Oyranos: 0.1.10
Since
2010/07/05 (Oyranos: 0.1.10)
Date
2010/07/05

References oyOBJECT_LIST_S, oyStructList_s::oyStructList_GetParentObjType(), and oyStructList_s::oyStructList_ReleaseAt().

OYAPI int OYEXPORT oyList_Sort ( oyList_s list,
int32_t *  rank_list 
)

sort a list according to a rank_list

Function oyList_Sort

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

References oyOBJECT_LIST_S, and oyStructList_s::oyStructList_Sort().

Field Documentation

oyStruct_Copy_f oyList_s::copy

Copy function.

oyObject_s oyList_s::oy_

Oyranos internal object.

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

oyStruct_Release_f oyList_s::release

Release function.

const oyOBJECT_e oyList_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.