gwenhywfar  4.15.2beta
plugindescr.h
Go to the documentation of this file.
1 /***************************************************************************
2  $RCSfile$
3  -------------------
4  cvs : $Id$
5  begin : Fri Sep 12 2003
6  copyright : (C) 2003 by Martin Preuss
7  email : martin@libchipcard.de
8 
9  ***************************************************************************
10  * *
11  * This library is free software; you can redistribute it and/or *
12  * modify it under the terms of the GNU Lesser General Public *
13  * License as published by the Free Software Foundation; either *
14  * version 2.1 of the License, or (at your option) any later version. *
15  * *
16  * This library is distributed in the hope that it will be useful, *
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
19  * Lesser General Public License for more details. *
20  * *
21  * You should have received a copy of the GNU Lesser General Public *
22  * License along with this library; if not, write to the Free Software *
23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
24  * MA 02111-1307 USA *
25  * *
26  ***************************************************************************/
27 
28 
29 #ifndef GWENHYWFAR_PLUGINDESCR_H
30 #define GWENHYWFAR_PLUGINDESCR_H
31 
33 #include <gwenhywfar/misc.h>
34 #include <gwenhywfar/misc2.h>
35 #include <gwenhywfar/xml.h>
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
42 
45 /* Do not terminate these lines with semicolon because they are
46  macros, not functions, and ISO C89 does not allow a semicolon
47  there. */
48 
51 
52 
55 
56 
66 int GWEN_LoadPluginDescrsByType(const char *path,
67  const char *type,
69 
70 
72 void GWEN_PluginDescription_free(GWEN_PLUGIN_DESCRIPTION *pd);
73 
74 
76 GWEN_PLUGIN_DESCRIPTION*
77 GWEN_PluginDescription_dup(const GWEN_PLUGIN_DESCRIPTION *pd);
78 
80 void GWEN_PluginDescription_Attach(GWEN_PLUGIN_DESCRIPTION *pd);
81 
82 
93 GWEN_PluginDescription_GetXmlNode(const GWEN_PLUGIN_DESCRIPTION *pd);
94 
96 const char *GWEN_PluginDescription_GetPath(const GWEN_PLUGIN_DESCRIPTION *pd);
97 
99 void GWEN_PluginDescription_SetPath(GWEN_PLUGIN_DESCRIPTION *pd,
100  const char *s);
101 
103 const char *GWEN_PluginDescription_GetName(const GWEN_PLUGIN_DESCRIPTION *pd);
104 
106 const char *GWEN_PluginDescription_GetType(const GWEN_PLUGIN_DESCRIPTION *pd);
107 
109 const char*
110 GWEN_PluginDescription_GetShortDescr(const GWEN_PLUGIN_DESCRIPTION *pd);
111 
113 const char*
114 GWEN_PluginDescription_GetAuthor(const GWEN_PLUGIN_DESCRIPTION *pd);
115 
117 const char*
118 GWEN_PluginDescription_GetVersion(const GWEN_PLUGIN_DESCRIPTION *pd);
119 
121 const char*
122 GWEN_PluginDescription_GetLongDescr(const GWEN_PLUGIN_DESCRIPTION *pd);
123 
125 const char*
126 GWEN_PluginDescription_GetFileName(const GWEN_PLUGIN_DESCRIPTION *pd);
127 
129 void GWEN_PluginDescription_SetFileName(GWEN_PLUGIN_DESCRIPTION *pd,
130  const char *s);
131 
132 
133 
134 #ifndef NO_DEPRECATED_SYMBOLS
135 
154 int
155 GWEN_PluginDescription_GetLongDescrByFormat(const GWEN_PLUGIN_DESCRIPTION *pd,
156  const char *s,
157  GWEN_BUFFER *buf);
158 #endif // ifndef NO_DEPRECATED_SYMBOLS
159 
161 int GWEN_PluginDescription_IsActive(const GWEN_PLUGIN_DESCRIPTION *pd);
162 
164 void GWEN_PluginDescription_SetIsActive(GWEN_PLUGIN_DESCRIPTION *pd, int i);
165 
166 
167 #ifdef __cplusplus
168 }
169 #endif
170 
171 
172 #endif /* GWENHYWFAR_PLUGINDESCR_H */
GWENHYWFAR_API const char * GWEN_PluginDescription_GetLongDescr(const GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API const char * GWEN_PluginDescription_GetAuthor(const GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API void GWEN_PluginDescription_SetPath(GWEN_PLUGIN_DESCRIPTION *pd, const char *s)
struct GWEN_PLUGIN_DESCRIPTION GWEN_PLUGIN_DESCRIPTION
Definition: plugindescr.h:41
GWENHYWFAR_API void GWEN_PluginDescription_SetIsActive(GWEN_PLUGIN_DESCRIPTION *pd, int i)
GWENHYWFAR_API const char * GWEN_PluginDescription_GetShortDescr(const GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API DEPRECATED int GWEN_PluginDescription_GetLongDescrByFormat(const GWEN_PLUGIN_DESCRIPTION *pd, const char *s, GWEN_BUFFER *buf)
GWENHYWFAR_API int GWEN_PluginDescription_IsActive(const GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API GWEN_PLUGIN_DESCRIPTION * GWEN_PluginDescription_dup(const GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API GWEN_PLUGIN_DESCRIPTION_LIST2 * GWEN_LoadPluginDescrs(const char *path)
GWENHYWFAR_API int GWEN_LoadPluginDescrsByType(const char *path, const char *type, GWEN_PLUGIN_DESCRIPTION_LIST2 *pdl)
GWENHYWFAR_API const char * GWEN_PluginDescription_GetPath(const GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API const char * GWEN_PluginDescription_GetFileName(const GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API void GWEN_PluginDescription_free(GWEN_PLUGIN_DESCRIPTION *pd)
#define GWEN_LIST2_FUNCTION_LIB_DEFS(t, pr, decl)
Definition: list2.h:56
GWENHYWFAR_API void GWEN_PluginDescription_Attach(GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API const char * GWEN_PluginDescription_GetName(const GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API void GWEN_PluginDescription_SetFileName(GWEN_PLUGIN_DESCRIPTION *pd, const char *s)
struct GWEN_PLUGIN_DESCRIPTION_LIST2 GWEN_PLUGIN_DESCRIPTION_LIST2
Definition: listdoc.h:6631
struct GWEN_BUFFER GWEN_BUFFER
A dynamically resizeable text buffer.
Definition: buffer.h:41
#define GWENHYWFAR_API
Definition: gwenhywfarapi.h:67
#define GWEN_LIST_FUNCTION_LIB_DEFS(t, pr, decl)
Definition: list1.h:349
GWENHYWFAR_API const char * GWEN_PluginDescription_GetVersion(const GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API const char * GWEN_PluginDescription_GetType(const GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_PluginDescription_GetXmlNode(const GWEN_PLUGIN_DESCRIPTION *pd)
GWENHYWFAR_API void GWEN_PluginDescription_List2_freeAll(GWEN_PLUGIN_DESCRIPTION_LIST2 *pdl)
#define DEPRECATED
struct GWEN__XMLNODE GWEN_XMLNODE
Definition: xml.h:148