# plugindescr.h

Go to the documentation of this file.

    00001 /***************************************************************************
    00002  $RCSfile: plugindescr.h,v $
    00003                              -------------------
    00004     cvs         : $Id: plugindescr.h,v 1.12 2004/12/05 01:07:59 aquamaniac Exp $
    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
    00083 GWENHYWFAR_API
    00084 GWEN_XMLNODE*
    00085   GWEN_PluginDescription_GetXmlNode(const GWEN_PLUGIN_DESCRIPTION *pd);
    00086
    00087
    00088 GWENHYWFAR_API
    00089 const char *GWEN_PluginDescription_GetName(const GWEN_PLUGIN_DESCRIPTION *pd);
    00090
    00091 GWENHYWFAR_API
    00092 const char *GWEN_PluginDescription_GetType(const GWEN_PLUGIN_DESCRIPTION *pd);
    00093
    00094 GWENHYWFAR_API
    00095 const char*
    00096   GWEN_PluginDescription_GetShortDescr(const GWEN_PLUGIN_DESCRIPTION *pd);
    00097
    00098 GWENHYWFAR_API
    00099 const char*
    00100   GWEN_PluginDescription_GetAuthor(const GWEN_PLUGIN_DESCRIPTION *pd);
    00101
    00102 GWENHYWFAR_API
    00103 const char*
    00104   GWEN_PluginDescription_GetVersion(const GWEN_PLUGIN_DESCRIPTION *pd);
    00105
    00106 GWENHYWFAR_API
    00107 const char*
    00108   GWEN_PluginDescription_GetLongDescr(const GWEN_PLUGIN_DESCRIPTION *pd);
    00109
    00110 GWENHYWFAR_API
    00111 const char*
    00112   GWEN_PluginDescription_GetFileName(const GWEN_PLUGIN_DESCRIPTION *pd);
    00113
    00114 GWENHYWFAR_API
    00115 void GWEN_PluginDescription_SetFileName(GWEN_PLUGIN_DESCRIPTION *pd,
    00116                                         const char *s);
    00117
    00118
    00119
    00137 GWENHYWFAR_API
    00138 int
    00139 GWEN_PluginDescription_GetLongDescrByFormat(const GWEN_PLUGIN_DESCRIPTION *pd,
    00140                                             const char *s,
    00141                                             GWEN_BUFFER *buf);
    00142
    00143 GWENHYWFAR_API
    00144   int GWEN_PluginDescription_IsActive(const GWEN_PLUGIN_DESCRIPTION *pd);
    00145
    00146 GWENHYWFAR_API
    00147   void GWEN_PluginDescription_SetIsActive(GWEN_PLUGIN_DESCRIPTION *pd, int i);
    00148
    00149
    00150 #ifdef __cplusplus
    00151 }
    00152 #endif
    00153
    00154
    00155 #endif /* GWENHYWFAR_PLUGINDESCR_H */