1 /* This file is auto-generated from "url.xml" by the typemaker 2 tool of Gwenhywfar. 3 Do not edit this file -- all changes will be lost! */ 4 #ifndef URL_H 5 #define URL_H 6 7 /** @page P_GWEN_URL_PUBLIC GWEN_Url (public) 8 This page describes the properties of GWEN_URL 9 @anchor GWEN_URL_Protocol 10 <h3>Protocol</h3> 11 <p> 12 </p> 13 <p> 14 Set this property with @ref GWEN_Url_SetProtocol, 15 get it with @ref GWEN_Url_GetProtocol 16 </p> 17 18 @anchor GWEN_URL_Server 19 <h3>Server</h3> 20 <p> 21 </p> 22 <p> 23 Set this property with @ref GWEN_Url_SetServer, 24 get it with @ref GWEN_Url_GetServer 25 </p> 26 27 @anchor GWEN_URL_Port 28 <h3>Port</h3> 29 <p> 30 </p> 31 <p> 32 Set this property with @ref GWEN_Url_SetPort, 33 get it with @ref GWEN_Url_GetPort 34 </p> 35 36 @anchor GWEN_URL_Path 37 <h3>Path</h3> 38 <p> 39 </p> 40 <p> 41 Set this property with @ref GWEN_Url_SetPath, 42 get it with @ref GWEN_Url_GetPath 43 </p> 44 45 @anchor GWEN_URL_UserName 46 <h3>UserName</h3> 47 <p> 48 </p> 49 <p> 50 Set this property with @ref GWEN_Url_SetUserName, 51 get it with @ref GWEN_Url_GetUserName 52 </p> 53 54 @anchor GWEN_URL_Password 55 <h3>Password</h3> 56 <p> 57 </p> 58 <p> 59 Set this property with @ref GWEN_Url_SetPassword, 60 get it with @ref GWEN_Url_GetPassword 61 </p> 62 63 @anchor GWEN_URL_Vars 64 <h3>Vars</h3> 65 <p> 66 </p> 67 <p> 68 Set this property with @ref GWEN_Url_SetVars, 69 get it with @ref GWEN_Url_GetVars 70 </p> 71 72 */ 73 #ifdef __cplusplus 74 extern "C" { 75 #endif 76 77 typedef struct GWEN_URL GWEN_URL; 78 79 #ifdef __cplusplus 80 } /* __cplusplus */ 81 #endif 82 83 #include <gwenhywfar/db.h> 84 #include <gwenhywfar/misc.h> 85 #include <gwenhywfar/list2.h> 86 /* headers */ 87 #include <gwenhywfar/types.h> 88 #include <gwenhywfar/urlfns.h> 89 90 #ifdef __cplusplus 91 extern "C" { 92 #endif 93 94 95 GWEN_LIST_FUNCTION_LIB_DEFS(GWEN_URL, GWEN_Url, GWENHYWFAR_API) 96 GWENHYWFAR_API GWEN_URL_LIST *GWEN_Url_List_dup(const GWEN_URL_LIST *stl); 97 98 GWEN_LIST2_FUNCTION_LIB_DEFS(GWEN_URL, GWEN_Url, GWENHYWFAR_API) 99 100 /** Destroys all objects stored in the given LIST2 and the list itself 101 */ 102 GWENHYWFAR_API void GWEN_Url_List2_freeAll(GWEN_URL_LIST2 *stl); 103 104 /** Creates a new object. 105 */ 106 GWENHYWFAR_API GWEN_URL *GWEN_Url_new(void); 107 /** Creates an object from the data in the given GWEN_DB_NODE 108 */ 109 GWENHYWFAR_API GWEN_URL *GWEN_Url_fromDb(GWEN_DB_NODE *db); 110 /** Creates and returns a deep copy of thegiven object. 111 */ 112 GWENHYWFAR_API GWEN_URL *GWEN_Url_dup(const GWEN_URL *st); 113 /** Destroys the given object. 114 */ 115 GWENHYWFAR_API void GWEN_Url_free(GWEN_URL *st); 116 /** Increments the usage counter of the given object, so an additional free() is needed to destroy the object. 117 */ 118 GWENHYWFAR_API void GWEN_Url_Attach(GWEN_URL *st); 119 /** Reads data from a GWEN_DB. 120 */ 121 GWENHYWFAR_API int GWEN_Url_ReadDb(GWEN_URL *st, GWEN_DB_NODE *db); 122 /** Stores an object in the given GWEN_DB_NODE 123 */ 124 GWENHYWFAR_API int GWEN_Url_toDb(const GWEN_URL *st, GWEN_DB_NODE *db); 125 /** Returns 0 if this object has not been modified, !=0 otherwise 126 */ 127 GWENHYWFAR_API int GWEN_Url_IsModified(const GWEN_URL *st); 128 /** Sets the modified state of the given object 129 */ 130 GWENHYWFAR_API void GWEN_Url_SetModified(GWEN_URL *st, int i); 131 132 /** 133 * Returns the property @ref GWEN_URL_Protocol 134 */ 135 GWENHYWFAR_API const char *GWEN_Url_GetProtocol(const GWEN_URL *el); 136 /** 137 * Set the property @ref GWEN_URL_Protocol 138 */ 139 GWENHYWFAR_API void GWEN_Url_SetProtocol(GWEN_URL *el, const char *d); 140 141 /** 142 * Returns the property @ref GWEN_URL_Server 143 */ 144 GWENHYWFAR_API const char *GWEN_Url_GetServer(const GWEN_URL *el); 145 /** 146 * Set the property @ref GWEN_URL_Server 147 */ 148 GWENHYWFAR_API void GWEN_Url_SetServer(GWEN_URL *el, const char *d); 149 150 /** 151 * Returns the property @ref GWEN_URL_Port 152 */ 153 GWENHYWFAR_API int GWEN_Url_GetPort(const GWEN_URL *el); 154 /** 155 * Set the property @ref GWEN_URL_Port 156 */ 157 GWENHYWFAR_API void GWEN_Url_SetPort(GWEN_URL *el, int d); 158 159 /** 160 * Returns the property @ref GWEN_URL_Path 161 */ 162 GWENHYWFAR_API const char *GWEN_Url_GetPath(const GWEN_URL *el); 163 /** 164 * Set the property @ref GWEN_URL_Path 165 */ 166 GWENHYWFAR_API void GWEN_Url_SetPath(GWEN_URL *el, const char *d); 167 168 /** 169 * Returns the property @ref GWEN_URL_UserName 170 */ 171 GWENHYWFAR_API const char *GWEN_Url_GetUserName(const GWEN_URL *el); 172 /** 173 * Set the property @ref GWEN_URL_UserName 174 */ 175 GWENHYWFAR_API void GWEN_Url_SetUserName(GWEN_URL *el, const char *d); 176 177 /** 178 * Returns the property @ref GWEN_URL_Password 179 */ 180 GWENHYWFAR_API const char *GWEN_Url_GetPassword(const GWEN_URL *el); 181 /** 182 * Set the property @ref GWEN_URL_Password 183 */ 184 GWENHYWFAR_API void GWEN_Url_SetPassword(GWEN_URL *el, const char *d); 185 186 /** 187 * Returns the property @ref GWEN_URL_Vars 188 */ 189 GWENHYWFAR_API GWEN_DB_NODE *GWEN_Url_GetVars(const GWEN_URL *el); 190 /** 191 * Set the property @ref GWEN_URL_Vars 192 */ 193 GWENHYWFAR_API void GWEN_Url_SetVars(GWEN_URL *el, GWEN_DB_NODE *d); 194 195 196 197 #ifdef __cplusplus 198 } /* __cplusplus */ 199 #endif 200 201 202 #endif /* URL_H */ 203