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 GWEN_PARAM_PARAM_H 9 #define GWEN_PARAM_PARAM_H 10 11 12 #ifdef __cplusplus 13 extern "C" { 14 #endif 15 16 /** @page P_GWEN_PARAM Structure GWEN_PARAM 17 <p>This page describes the properties of GWEN_PARAM.</p> 18 19 20 21 <h1>GWEN_PARAM</h1> 22 23 24 25 @anchor GWEN_PARAM_name 26 <h2>name</h2> 27 28 <p>Set this property with @ref GWEN_Param_SetName(), get it with @ref GWEN_Param_GetName().</p> 29 30 31 @anchor GWEN_PARAM_flags 32 <h2>flags</h2> 33 34 <p>Set this property with @ref GWEN_Param_SetFlags(), get it with @ref GWEN_Param_GetFlags().</p> 35 36 37 @anchor GWEN_PARAM_type 38 <h2>type</h2> 39 40 <p>Set this property with @ref GWEN_Param_SetType(), get it with @ref GWEN_Param_GetType().</p> 41 42 43 @anchor GWEN_PARAM_dataType 44 <h2>dataType</h2> 45 46 <p>Set this property with @ref GWEN_Param_SetDataType(), get it with @ref GWEN_Param_GetDataType().</p> 47 48 49 @anchor GWEN_PARAM_shortDescription 50 <h2>shortDescription</h2> 51 52 <p>Set this property with @ref GWEN_Param_SetShortDescription(), get it with @ref GWEN_Param_GetShortDescription().</p> 53 54 55 @anchor GWEN_PARAM_longDescription 56 <h2>longDescription</h2> 57 58 <p>Set this property with @ref GWEN_Param_SetLongDescription(), get it with @ref GWEN_Param_GetLongDescription().</p> 59 60 61 @anchor GWEN_PARAM_currentValue 62 <h2>currentValue</h2> 63 64 <p>Set this property with @ref GWEN_Param_SetCurrentValue(), get it with @ref GWEN_Param_GetCurrentValue().</p> 65 66 67 @anchor GWEN_PARAM_defaultValue 68 <h2>defaultValue</h2> 69 70 <p>Set this property with @ref GWEN_Param_SetDefaultValue(), get it with @ref GWEN_Param_GetDefaultValue().</p> 71 72 73 @anchor GWEN_PARAM_choices 74 <h2>choices</h2> 75 76 <p>Set this property with @ref GWEN_Param_SetChoices(), get it with @ref GWEN_Param_GetChoices().</p> 77 78 79 @anchor GWEN_PARAM_internalIntValue 80 <h2>internalIntValue</h2> 81 82 <p>Set this property with @ref GWEN_Param_SetInternalIntValue(), get it with @ref GWEN_Param_GetInternalIntValue().</p> 83 84 85 @anchor GWEN_PARAM_internalFloatValue 86 <h2>internalFloatValue</h2> 87 88 <p>Set this property with @ref GWEN_Param_SetInternalFloatValue(), get it with @ref GWEN_Param_GetInternalFloatValue().</p> 89 90 91 @anchor GWEN_PARAM_runtimeFlags 92 <h2>runtimeFlags</h2> 93 94 <p>Set this property with @ref GWEN_Param_SetRuntimeFlags(), get it with @ref GWEN_Param_GetRuntimeFlags().</p> 95 96 */ 97 98 /* define GWEN_PARAM_RTFLAGS */ 99 100 101 /* define GWEN_PARAM_FLAGS */ 102 103 104 /* needed system headers */ 105 #include <gwenhywfar/types.h> 106 #include <gwenhywfar/list1.h> 107 #include <gwenhywfar/list2.h> 108 #include <gwenhywfar/tree.h> 109 #include <gwenhywfar/db.h> 110 #include <gwenhywfar/xml.h> 111 112 /* pre-headers */ 113 #include <gwenhywfar/gwenhywfarapi.h> 114 #include <gwenhywfar/stringlist2.h> 115 116 typedef struct GWEN_PARAM GWEN_PARAM; 117 GWEN_LIST_FUNCTION_LIB_DEFS(GWEN_PARAM, GWEN_Param, GWENHYWFAR_API) 118 GWEN_LIST2_FUNCTION_LIB_DEFS(GWEN_PARAM, GWEN_Param, GWENHYWFAR_API) 119 GWEN_TREE_FUNCTION_LIB_DEFS(GWEN_PARAM, GWEN_Param, GWENHYWFAR_API) 120 121 122 123 typedef enum { 124 GWEN_Param_DataType_Unknown = -1, 125 GWEN_Param_DataType_Int, 126 GWEN_Param_DataType_Bool, 127 GWEN_Param_DataType_Float, 128 GWEN_Param_DataType_String 129 } GWEN_PARAM_DATATYPE; 130 131 132 typedef enum { 133 GWEN_Param_Type_Unknown = -1, 134 GWEN_Param_Type_Simple, 135 GWEN_Param_Type_Choice 136 } GWEN_PARAM_TYPE; 137 138 139 /* post-headers */ 140 #include <gwenhywfar/param_fns.h> 141 142 143 GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_DataType_fromString(const char *p_s); 144 145 GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_Type_fromString(const char *p_s); 146 147 GWENHYWFAR_API const char *GWEN_Param_DataType_toString(GWEN_PARAM_DATATYPE p_i); 148 149 GWENHYWFAR_API const char *GWEN_Param_Type_toString(GWEN_PARAM_TYPE p_i); 150 151 /** Constructor. */ 152 GWENHYWFAR_API GWEN_PARAM *GWEN_Param_new(void); 153 154 /** Destructor. */ 155 GWENHYWFAR_API void GWEN_Param_free(GWEN_PARAM *p_struct); 156 157 GWENHYWFAR_API void GWEN_Param_Attach(GWEN_PARAM *p_struct); 158 159 GWENHYWFAR_API GWEN_PARAM *GWEN_Param_dup(const GWEN_PARAM *p_struct); 160 161 GWENHYWFAR_API GWEN_PARAM *GWEN_Param_copy(GWEN_PARAM *p_struct, const GWEN_PARAM *p_src); 162 163 /** Getter. 164 * Use this function to get the member "name" (see @ref GWEN_PARAM_name) 165 */ 166 GWENHYWFAR_API const char *GWEN_Param_GetName(const GWEN_PARAM *p_struct); 167 168 /** Getter. 169 * Use this function to get the member "flags" (see @ref GWEN_PARAM_flags) 170 */ 171 GWENHYWFAR_API uint32_t GWEN_Param_GetFlags(const GWEN_PARAM *p_struct); 172 173 /** Getter. 174 * Use this function to get the member "type" (see @ref GWEN_PARAM_type) 175 */ 176 GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_GetType(const GWEN_PARAM *p_struct); 177 178 /** Getter. 179 * Use this function to get the member "dataType" (see @ref GWEN_PARAM_dataType) 180 */ 181 GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_GetDataType(const GWEN_PARAM *p_struct); 182 183 /** Getter. 184 * Use this function to get the member "shortDescription" (see @ref GWEN_PARAM_shortDescription) 185 */ 186 GWENHYWFAR_API const char *GWEN_Param_GetShortDescription(const GWEN_PARAM *p_struct); 187 188 /** Getter. 189 * Use this function to get the member "longDescription" (see @ref GWEN_PARAM_longDescription) 190 */ 191 GWENHYWFAR_API const char *GWEN_Param_GetLongDescription(const GWEN_PARAM *p_struct); 192 193 /** Getter. 194 * Use this function to get the member "currentValue" (see @ref GWEN_PARAM_currentValue) 195 */ 196 GWENHYWFAR_API const char *GWEN_Param_GetCurrentValue(const GWEN_PARAM *p_struct); 197 198 /** Getter. 199 * Use this function to get the member "defaultValue" (see @ref GWEN_PARAM_defaultValue) 200 */ 201 GWENHYWFAR_API const char *GWEN_Param_GetDefaultValue(const GWEN_PARAM *p_struct); 202 203 /** Getter. 204 * Use this function to get the member "choices" (see @ref GWEN_PARAM_choices) 205 */ 206 GWENHYWFAR_API GWEN_STRINGLIST2 *GWEN_Param_GetChoices(const GWEN_PARAM *p_struct); 207 208 /** Getter. 209 * Use this function to get the member "runtimeFlags" (see @ref GWEN_PARAM_runtimeFlags) 210 */ 211 GWENHYWFAR_API uint32_t GWEN_Param_GetRuntimeFlags(const GWEN_PARAM *p_struct); 212 213 /** Setter. 214 * Use this function to set the member "name" (see @ref GWEN_PARAM_name) 215 */ 216 GWENHYWFAR_API void GWEN_Param_SetName(GWEN_PARAM *p_struct, const char *p_src); 217 218 /** Setter. 219 * Use this function to set the member "flags" (see @ref GWEN_PARAM_flags) 220 */ 221 GWENHYWFAR_API void GWEN_Param_SetFlags(GWEN_PARAM *p_struct, uint32_t p_src); 222 223 /** Add flags. 224 * Use this function to add flags to the member "flags" 225 */ 226 GWENHYWFAR_API void GWEN_Param_AddFlags(GWEN_PARAM *p_struct, uint32_t p_src); 227 228 /** Sub flags. 229 * Use this function to sub flags from the member "flags" 230 */ 231 GWENHYWFAR_API void GWEN_Param_SubFlags(GWEN_PARAM *p_struct, uint32_t p_src); 232 233 /** Setter. 234 * Use this function to set the member "type" (see @ref GWEN_PARAM_type) 235 */ 236 GWENHYWFAR_API void GWEN_Param_SetType(GWEN_PARAM *p_struct, GWEN_PARAM_TYPE p_src); 237 238 /** Setter. 239 * Use this function to set the member "dataType" (see @ref GWEN_PARAM_dataType) 240 */ 241 GWENHYWFAR_API void GWEN_Param_SetDataType(GWEN_PARAM *p_struct, GWEN_PARAM_DATATYPE p_src); 242 243 /** Setter. 244 * Use this function to set the member "shortDescription" (see @ref GWEN_PARAM_shortDescription) 245 */ 246 GWENHYWFAR_API void GWEN_Param_SetShortDescription(GWEN_PARAM *p_struct, const char *p_src); 247 248 /** Setter. 249 * Use this function to set the member "longDescription" (see @ref GWEN_PARAM_longDescription) 250 */ 251 GWENHYWFAR_API void GWEN_Param_SetLongDescription(GWEN_PARAM *p_struct, const char *p_src); 252 253 /** Setter. 254 * Use this function to set the member "currentValue" (see @ref GWEN_PARAM_currentValue) 255 */ 256 GWENHYWFAR_API void GWEN_Param_SetCurrentValue(GWEN_PARAM *p_struct, const char *p_src); 257 258 /** Setter. 259 * Use this function to set the member "defaultValue" (see @ref GWEN_PARAM_defaultValue) 260 */ 261 GWENHYWFAR_API void GWEN_Param_SetDefaultValue(GWEN_PARAM *p_struct, const char *p_src); 262 263 /** Setter. 264 * Use this function to set the member "choices" (see @ref GWEN_PARAM_choices) 265 */ 266 GWENHYWFAR_API void GWEN_Param_SetChoices(GWEN_PARAM *p_struct, GWEN_STRINGLIST2 *p_src); 267 268 /** Setter. 269 * Use this function to set the member "runtimeFlags" (see @ref GWEN_PARAM_runtimeFlags) 270 */ 271 GWENHYWFAR_API void GWEN_Param_SetRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src); 272 273 /** Add flags. 274 * Use this function to add flags to the member "runtimeFlags" 275 */ 276 GWENHYWFAR_API void GWEN_Param_AddRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src); 277 278 /** Sub flags. 279 * Use this function to sub flags from the member "runtimeFlags" 280 */ 281 GWENHYWFAR_API void GWEN_Param_SubRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src); 282 283 /* list1 functions */ 284 GWENHYWFAR_API GWEN_PARAM_LIST *GWEN_Param_List_dup(const GWEN_PARAM_LIST *p_src); 285 286 GWENHYWFAR_API void GWEN_Param_ReadDb(GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db); 287 288 GWENHYWFAR_API int GWEN_Param_WriteDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db); 289 290 GWENHYWFAR_API GWEN_PARAM *GWEN_Param_fromDb(GWEN_DB_NODE *p_db); 291 292 GWENHYWFAR_API int GWEN_Param_toDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db); 293 294 GWENHYWFAR_API void GWEN_Param_ReadXml(GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db); 295 296 GWENHYWFAR_API void GWEN_Param_WriteXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db); 297 298 GWENHYWFAR_API void GWEN_Param_toXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db); 299 300 GWENHYWFAR_API GWEN_PARAM *GWEN_Param_fromXml(GWEN_XMLNODE *p_db); 301 302 GWENHYWFAR_API GWEN_PARAM *GWEN_Param_List_GetByName(const GWEN_PARAM_LIST *p_list, const char *p_cmp); 303 304 GWENHYWFAR_API GWEN_PARAM *GWEN_Param_Tree_GetByName(const GWEN_PARAM_TREE *p_tree, const char *p_cmp); 305 306 /* end-headers */ 307 308 309 #ifdef __cplusplus 310 } 311 #endif 312 313 #endif 314 315