gwenhywfar  4.17.0
param.h
Go to the documentation of this file.
1 /**********************************************************
2  * This file has been automatically created by "typemaker2"
3  * from the file "param.xml".
4  * Please do not edit this file, all changes will be lost.
5  * Better edit the mentioned source file instead.
6  **********************************************************/
7 
8 #ifndef PARAM_H
9 #define PARAM_H
10 
11 
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15 
16 /* define GWEN_PARAM_RTFLAGS */
17 
18 
19 /* define GWEN_PARAM_FLAGS */
20 
21 
22 /* needed system headers */
23 #include <gwenhywfar/types.h>
24 #include <gwenhywfar/list1.h>
25 #include <gwenhywfar/list2.h>
26 #include <gwenhywfar/tree.h>
27 #include <gwenhywfar/db.h>
28 #include <gwenhywfar/xml.h>
29 
30 /* pre-headers */
32 #include <gwenhywfar/stringlist2.h>
33 
34 typedef struct GWEN_PARAM GWEN_PARAM;
38 
39 
40 typedef enum {
47 
48 
49 typedef enum {
54 
55 
56 /* post-headers */
57 #include <gwenhywfar/param_fns.h>
58 
59 
60 GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_DataType_fromString(const char *p_s);
61 
62 GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_Type_fromString(const char *p_s);
63 
64 GWENHYWFAR_API const char *GWEN_Param_DataType_toString(GWEN_PARAM_DATATYPE p_i);
65 
66 GWENHYWFAR_API const char *GWEN_Param_Type_toString(GWEN_PARAM_TYPE p_i);
67 
70 
73 
75 
77 
79 
83 GWENHYWFAR_API const char *GWEN_Param_GetName(const GWEN_PARAM *p_struct);
84 
88 GWENHYWFAR_API uint32_t GWEN_Param_GetFlags(const GWEN_PARAM *p_struct);
89 
93 GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_GetType(const GWEN_PARAM *p_struct);
94 
98 GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_GetDataType(const GWEN_PARAM *p_struct);
99 
103 GWENHYWFAR_API const char *GWEN_Param_GetShortDescription(const GWEN_PARAM *p_struct);
104 
108 GWENHYWFAR_API const char *GWEN_Param_GetLongDescription(const GWEN_PARAM *p_struct);
109 
113 GWENHYWFAR_API const char *GWEN_Param_GetCurrentValue(const GWEN_PARAM *p_struct);
114 
118 GWENHYWFAR_API const char *GWEN_Param_GetDefaultValue(const GWEN_PARAM *p_struct);
119 
124 
128 GWENHYWFAR_API uint32_t GWEN_Param_GetRuntimeFlags(const GWEN_PARAM *p_struct);
129 
133 GWENHYWFAR_API void GWEN_Param_SetName(GWEN_PARAM *p_struct, const char *p_src);
134 
138 GWENHYWFAR_API void GWEN_Param_SetFlags(GWEN_PARAM *p_struct, uint32_t p_src);
139 
143 GWENHYWFAR_API void GWEN_Param_AddFlags(GWEN_PARAM *p_struct, uint32_t p_src);
144 
148 GWENHYWFAR_API void GWEN_Param_SubFlags(GWEN_PARAM *p_struct, uint32_t p_src);
149 
153 GWENHYWFAR_API void GWEN_Param_SetType(GWEN_PARAM *p_struct, GWEN_PARAM_TYPE p_src);
154 
158 GWENHYWFAR_API void GWEN_Param_SetDataType(GWEN_PARAM *p_struct, GWEN_PARAM_DATATYPE p_src);
159 
163 GWENHYWFAR_API void GWEN_Param_SetShortDescription(GWEN_PARAM *p_struct, const char *p_src);
164 
168 GWENHYWFAR_API void GWEN_Param_SetLongDescription(GWEN_PARAM *p_struct, const char *p_src);
169 
173 GWENHYWFAR_API void GWEN_Param_SetCurrentValue(GWEN_PARAM *p_struct, const char *p_src);
174 
178 GWENHYWFAR_API void GWEN_Param_SetDefaultValue(GWEN_PARAM *p_struct, const char *p_src);
179 
184 
188 GWENHYWFAR_API void GWEN_Param_SetRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src);
189 
193 GWENHYWFAR_API void GWEN_Param_AddRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src);
194 
198 GWENHYWFAR_API void GWEN_Param_SubRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src);
199 
200 /* list1 functions */
202 
204 
205 GWENHYWFAR_API int GWEN_Param_WriteDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db);
206 
208 
209 GWENHYWFAR_API int GWEN_Param_toDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db);
210 
212 
213 GWENHYWFAR_API void GWEN_Param_WriteXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db);
214 
215 GWENHYWFAR_API void GWEN_Param_toXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db);
216 
218 
219 GWENHYWFAR_API GWEN_PARAM *GWEN_Param_List_GetByName(const GWEN_PARAM_LIST *p_list, const char *p_cmp);
220 
221 GWENHYWFAR_API GWEN_PARAM *GWEN_Param_Tree_GetByName(const GWEN_PARAM_TREE *p_tree, const char *p_cmp);
222 
223 #ifdef __cplusplus
224 }
225 #endif
226 
227 #endif
228 
GWENHYWFAR_API void GWEN_Param_AddFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_DataType_fromString(const char *p_s)
GWENHYWFAR_API const char * GWEN_Param_Type_toString(GWEN_PARAM_TYPE p_i)
GWENHYWFAR_API void GWEN_Param_ReadXml(GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db)
GWENHYWFAR_API void GWEN_Param_Attach(GWEN_PARAM *p_struct)
GWENHYWFAR_API const char * GWEN_Param_GetShortDescription(const GWEN_PARAM *p_struct)
GWENHYWFAR_API const char * GWEN_Param_GetLongDescription(const GWEN_PARAM *p_struct)
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_List_GetByName(const GWEN_PARAM_LIST *p_list, const char *p_cmp)
struct GWEN_DB_NODE GWEN_DB_NODE
Definition: db.h:228
GWENHYWFAR_API void GWEN_Param_SetDataType(GWEN_PARAM *p_struct, GWEN_PARAM_DATATYPE p_src)
GWENHYWFAR_API GWEN_STRINGLIST2 * GWEN_Param_GetChoices(const GWEN_PARAM *p_struct)
GWENHYWFAR_API void GWEN_Param_WriteXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db)
GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_GetDataType(const GWEN_PARAM *p_struct)
struct GWEN_PARAM GWEN_PARAM
Definition: param.h:34
GWENHYWFAR_API const char * GWEN_Param_DataType_toString(GWEN_PARAM_DATATYPE p_i)
GWENHYWFAR_API void GWEN_Param_SetDefaultValue(GWEN_PARAM *p_struct, const char *p_src)
GWEN_PARAM_TYPE
Definition: param.h:49
GWENHYWFAR_API uint32_t GWEN_Param_GetFlags(const GWEN_PARAM *p_struct)
GWENHYWFAR_API void GWEN_Param_SetChoices(GWEN_PARAM *p_struct, GWEN_STRINGLIST2 *p_src)
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_fromDb(GWEN_DB_NODE *p_db)
GWENHYWFAR_API const char * GWEN_Param_GetCurrentValue(const GWEN_PARAM *p_struct)
GWENHYWFAR_API void GWEN_Param_SetShortDescription(GWEN_PARAM *p_struct, const char *p_src)
GWENHYWFAR_API void GWEN_Param_free(GWEN_PARAM *p_struct)
#define GWEN_TREE_FUNCTION_LIB_DEFS(t, pr, decl)
Definition: tree.h:375
GWENHYWFAR_API void GWEN_Param_SetName(GWEN_PARAM *p_struct, const char *p_src)
#define GWEN_LIST2_FUNCTION_LIB_DEFS(t, pr, decl)
Definition: list2.h:56
GWENHYWFAR_API void GWEN_Param_SetCurrentValue(GWEN_PARAM *p_struct, const char *p_src)
GWENHYWFAR_API void GWEN_Param_SetFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWENHYWFAR_API int GWEN_Param_WriteDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db)
GWENHYWFAR_API GWEN_PARAM_LIST * GWEN_Param_List_dup(const GWEN_PARAM_LIST *p_src)
GWENHYWFAR_API void GWEN_Param_SubFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWENHYWFAR_API void GWEN_Param_toXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db)
GWENHYWFAR_API int GWEN_Param_toDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db)
GWENHYWFAR_API void GWEN_Param_ReadDb(GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db)
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_Tree_GetByName(const GWEN_PARAM_TREE *p_tree, const char *p_cmp)
#define GWENHYWFAR_API
Definition: gwenhywfarapi.h:67
GWENHYWFAR_API void GWEN_Param_AddRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src)
#define GWEN_LIST_FUNCTION_LIB_DEFS(t, pr, decl)
Definition: list1.h:349
GWEN_PARAM_DATATYPE
Definition: param.h:40
struct GWEN_STRINGLIST2 GWEN_STRINGLIST2
Definition: stringlist2.h:43
This file contains some macros concerning lists.
GWENHYWFAR_API void GWEN_Param_SetLongDescription(GWEN_PARAM *p_struct, const char *p_src)
GWENHYWFAR_API const char * GWEN_Param_GetName(const GWEN_PARAM *p_struct)
GWENHYWFAR_API void GWEN_Param_SetRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_Type_fromString(const char *p_s)
GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_GetType(const GWEN_PARAM *p_struct)
GWENHYWFAR_API const char * GWEN_Param_GetDefaultValue(const GWEN_PARAM *p_struct)
GWENHYWFAR_API uint32_t GWEN_Param_GetRuntimeFlags(const GWEN_PARAM *p_struct)
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_fromXml(GWEN_XMLNODE *p_db)
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_dup(const GWEN_PARAM *p_struct)
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_new(void)
GWENHYWFAR_API void GWEN_Param_SubRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src)
struct GWEN__XMLNODE GWEN_XMLNODE
Definition: xml.h:148
GWENHYWFAR_API void GWEN_Param_SetType(GWEN_PARAM *p_struct, GWEN_PARAM_TYPE p_src)
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_copy(GWEN_PARAM *p_struct, const GWEN_PARAM *p_src)