![]() |
Oyranos Color Management System API |
a pointer list More...
#include <oyList_s.h>
Public Member Functions | |
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) |
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... | |
![]() | |
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... | |
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... | |
![]() | |
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... | |
a pointer list
OYAPI int OYEXPORT oyList_Clear | ( | oyList_s * | list | ) |
clear the elements in a List list
Function oyList_Clear
[in,out] | list | the list |
References oyOBJECT_LIST_S, and oyStructList_s::oyStructList_Clear().
OYAPI oyList_s *OYEXPORT oyList_Copy | ( | oyList_s * | list, |
oyObject_s | object | ||
) |
copy or reference a List object
Function oyList_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | list | List struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_LIST_S.
int oyList_Copy__Members | ( | oyList_s_ * | dst, |
oyList_s_ * | src | ||
) |
Custom List copy constructor.
Function oyList_Copy__Members
OYAPI int OYEXPORT oyList_Count | ( | oyList_s * | list | ) |
count the elements in a List list
Function oyList_Count
[in,out] | list | the list |
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
[in,out] | list | the list |
pos | position |
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
OYAPI int OYEXPORT oyList_MoveIn | ( | oyList_s * | list, |
oyLis_s ** | obj, | ||
int | pos | ||
) |
add an element to a List list
Function oyList_MoveIn
[in] | list | list |
[in,out] | obj | list element |
pos | position |
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 | ) |
OYAPI int OYEXPORT oyList_Release | ( | oyList_s ** | list | ) |
release and possibly deallocate a oyList_s object
Function oyList_Release
[in,out] | list | List struct object |
References oyOBJECT_LIST_S.
void oyList_Release__Members | ( | oyList_s_ * | list | ) |
Custom List destructor.
Function oyList_Release__Members
OYAPI int OYEXPORT oyList_ReleaseAt | ( | oyList_s * | list, |
int | pos | ||
) |
release a element from a List list
Function oyList_ReleaseAt
[in,out] | list | the list |
pos | position |
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
References oyOBJECT_LIST_S, and oyStructList_s::oyStructList_Sort().
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.