gwenhywfar 4.0.3

plugindescr.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  $RCSfile$
00003                              -------------------
00004     cvs         : $Id$
00005     begin       : Fri Sep 12 2003
00006     copyright   : (C) 2003 by Martin Preuss
00007     email       : martin@libchipcard.de
00008 
00009  ***************************************************************************
00010  *                                                                         *
00011  *   This library is free software; you can redistribute it and/or         *
00012  *   modify it under the terms of the GNU Lesser General Public            *
00013  *   License as published by the Free Software Foundation; either          *
00014  *   version 2.1 of the License, or (at your option) any later version.    *
00015  *                                                                         *
00016  *   This library is distributed in the hope that it will be useful,       *
00017  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00018  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00019  *   Lesser General Public License for more details.                       *
00020  *                                                                         *
00021  *   You should have received a copy of the GNU Lesser General Public      *
00022  *   License along with this library; if not, write to the Free Software   *
00023  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
00024  *   MA  02111-1307  USA                                                   *
00025  *                                                                         *
00026  ***************************************************************************/
00027 
00028 
00029 #ifndef GWENHYWFAR_PLUGINDESCR_H
00030 #define GWENHYWFAR_PLUGINDESCR_H
00031 
00032 #include <gwenhywfar/gwenhywfarapi.h>
00033 #include <gwenhywfar/misc.h>
00034 #include <gwenhywfar/misc2.h>
00035 #include <gwenhywfar/xml.h>
00036 
00037 #ifdef __cplusplus
00038 extern "C" {
00039 #endif
00040 
00041 typedef struct GWEN_PLUGIN_DESCRIPTION GWEN_PLUGIN_DESCRIPTION;
00042 
00043 GWEN_LIST_FUNCTION_LIB_DEFS(GWEN_PLUGIN_DESCRIPTION, GWEN_PluginDescription, GWENHYWFAR_API)
00044 GWEN_LIST2_FUNCTION_LIB_DEFS(GWEN_PLUGIN_DESCRIPTION, GWEN_PluginDescription, GWENHYWFAR_API)
00045 /* Do not terminate these lines with semicolon because they are
00046    macros, not functions, and ISO C89 does not allow a semicolon
00047    there. */
00048 
00049 GWENHYWFAR_API
00050 void GWEN_PluginDescription_List2_freeAll(GWEN_PLUGIN_DESCRIPTION_LIST2 *pdl);
00051 
00052 
00053 GWENHYWFAR_API
00054 GWEN_PLUGIN_DESCRIPTION_LIST2 *GWEN_LoadPluginDescrs(const char *path);
00055 
00056 
00065 GWENHYWFAR_API
00066 int GWEN_LoadPluginDescrsByType(const char *path,
00067                                 const char *type,
00068                                 GWEN_PLUGIN_DESCRIPTION_LIST2 *pdl);
00069 
00070 
00071 GWENHYWFAR_API
00072 void GWEN_PluginDescription_free(GWEN_PLUGIN_DESCRIPTION *pd);
00073 
00074 
00075 GWENHYWFAR_API
00076 GWEN_PLUGIN_DESCRIPTION*
00077 GWEN_PluginDescription_dup(const GWEN_PLUGIN_DESCRIPTION *pd);
00078 
00079 GWENHYWFAR_API
00080 void GWEN_PluginDescription_Attach(GWEN_PLUGIN_DESCRIPTION *pd);
00081 
00082 
00091 GWENHYWFAR_API
00092 GWEN_XMLNODE*
00093   GWEN_PluginDescription_GetXmlNode(const GWEN_PLUGIN_DESCRIPTION *pd);
00094 
00095 GWENHYWFAR_API
00096 const char *GWEN_PluginDescription_GetPath(const GWEN_PLUGIN_DESCRIPTION *pd);
00097 
00098 GWENHYWFAR_API
00099 void GWEN_PluginDescription_SetPath(GWEN_PLUGIN_DESCRIPTION *pd,
00100                                     const char *s);
00101 
00102 GWENHYWFAR_API
00103 const char *GWEN_PluginDescription_GetName(const GWEN_PLUGIN_DESCRIPTION *pd);
00104 
00105 GWENHYWFAR_API
00106 const char *GWEN_PluginDescription_GetType(const GWEN_PLUGIN_DESCRIPTION *pd);
00107 
00108 GWENHYWFAR_API
00109 const char*
00110   GWEN_PluginDescription_GetShortDescr(const GWEN_PLUGIN_DESCRIPTION *pd);
00111 
00112 GWENHYWFAR_API
00113 const char*
00114   GWEN_PluginDescription_GetAuthor(const GWEN_PLUGIN_DESCRIPTION *pd);
00115 
00116 GWENHYWFAR_API
00117 const char*
00118   GWEN_PluginDescription_GetVersion(const GWEN_PLUGIN_DESCRIPTION *pd);
00119 
00120 GWENHYWFAR_API
00121 const char*
00122   GWEN_PluginDescription_GetLongDescr(const GWEN_PLUGIN_DESCRIPTION *pd);
00123 
00124 GWENHYWFAR_API
00125 const char*
00126   GWEN_PluginDescription_GetFileName(const GWEN_PLUGIN_DESCRIPTION *pd);
00127 
00128 GWENHYWFAR_API
00129 void GWEN_PluginDescription_SetFileName(GWEN_PLUGIN_DESCRIPTION *pd,
00130                                         const char *s);
00131 
00132 
00133 
00152 GWENHYWFAR_API
00153 int
00154 GWEN_PluginDescription_GetLongDescrByFormat(const GWEN_PLUGIN_DESCRIPTION *pd,
00155                                             const char *s,
00156                                             GWEN_BUFFER *buf);
00157 
00158 GWENHYWFAR_API
00159   int GWEN_PluginDescription_IsActive(const GWEN_PLUGIN_DESCRIPTION *pd);
00160 
00161 GWENHYWFAR_API
00162   void GWEN_PluginDescription_SetIsActive(GWEN_PLUGIN_DESCRIPTION *pd, int i);
00163 
00164 
00165 #ifdef __cplusplus
00166 }
00167 #endif
00168 
00169 
00170 #endif /* GWENHYWFAR_PLUGINDESCR_H */