gwenhywfar  4.6.0beta
Typedefs | Functions
plugindescr.h File Reference
#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/misc.h>
#include <gwenhywfar/misc2.h>
#include <gwenhywfar/xml.h>

Go to the source code of this file.

Typedefs

typedef struct
GWEN_PLUGIN_DESCRIPTION 
GWEN_PLUGIN_DESCRIPTION
 

Functions

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 void GWEN_PluginDescription_Attach (GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API
GWEN_PLUGIN_DESCRIPTION
GWEN_PluginDescription_dup (const GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API void GWEN_PluginDescription_free (GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API const char * GWEN_PluginDescription_GetAuthor (const GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API const char * GWEN_PluginDescription_GetFileName (const GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API const char * GWEN_PluginDescription_GetLongDescr (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 const char * GWEN_PluginDescription_GetName (const GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API const char * GWEN_PluginDescription_GetPath (const GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API const char * GWEN_PluginDescription_GetShortDescr (const GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API const char * GWEN_PluginDescription_GetType (const GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API const char * GWEN_PluginDescription_GetVersion (const GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API GWEN_XMLNODEGWEN_PluginDescription_GetXmlNode (const GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API int GWEN_PluginDescription_IsActive (const GWEN_PLUGIN_DESCRIPTION *pd)
 
GWENHYWFAR_API void GWEN_PluginDescription_List2_freeAll (GWEN_PLUGIN_DESCRIPTION_LIST2 *pdl)
 
GWENHYWFAR_API void GWEN_PluginDescription_SetFileName (GWEN_PLUGIN_DESCRIPTION *pd, const char *s)
 
GWENHYWFAR_API void GWEN_PluginDescription_SetIsActive (GWEN_PLUGIN_DESCRIPTION *pd, int i)
 
GWENHYWFAR_API void GWEN_PluginDescription_SetPath (GWEN_PLUGIN_DESCRIPTION *pd, const char *s)
 

Typedef Documentation

Definition at line 41 of file plugindescr.h.

Function Documentation

GWENHYWFAR_API GWEN_PLUGIN_DESCRIPTION_LIST2* GWEN_LoadPluginDescrs ( const char *  path)

Definition at line 396 of file plugindescr.c.

References GWEN_LoadPluginDescrsByType().

GWENHYWFAR_API int GWEN_LoadPluginDescrsByType ( const char *  path,
const char *  type,
GWEN_PLUGIN_DESCRIPTION_LIST2 *  pdl 
)
GWENHYWFAR_API void GWEN_PluginDescription_Attach ( GWEN_PLUGIN_DESCRIPTION pd)

Definition at line 132 of file plugindescr.c.

GWENHYWFAR_API GWEN_PLUGIN_DESCRIPTION* GWEN_PluginDescription_dup ( const GWEN_PLUGIN_DESCRIPTION pd)
GWENHYWFAR_API void GWEN_PluginDescription_free ( GWEN_PLUGIN_DESCRIPTION pd)
GWENHYWFAR_API const char* GWEN_PluginDescription_GetAuthor ( const GWEN_PLUGIN_DESCRIPTION pd)

Definition at line 238 of file plugindescr.c.

GWENHYWFAR_API const char* GWEN_PluginDescription_GetFileName ( const GWEN_PLUGIN_DESCRIPTION pd)

Definition at line 371 of file plugindescr.c.

GWENHYWFAR_API const char* GWEN_PluginDescription_GetLongDescr ( const GWEN_PLUGIN_DESCRIPTION pd)

Definition at line 254 of file plugindescr.c.

References GWEN_I18N_Translate().

GWENHYWFAR_API DEPRECATED int GWEN_PluginDescription_GetLongDescrByFormat ( const GWEN_PLUGIN_DESCRIPTION pd,
const char *  s,
GWEN_BUFFER buf 
)

Seeks for a long description with the given format and the currently selected locale and appends it to the data in the given buffer.

The DESCR tag of the plugin description is expected to contain sub tags named TEXT with the property "FORMAT" describing the format and "LANG" containing the language of the element.

Currently supported format is "html".

Returns
0 if ok, !=0 on error
Parameters
pdplugin description
sname of the format (e.g. html)
bufbuffer to append the description to

Definition at line 330 of file plugindescr.c.

References DBG_INFO, DBG_NOTICE, GWEN_I18N_GetCurrentLocaleList(), GWEN_LOGDOMAIN, GWEN_PluginDescription__GetLocalizedLongDescrByFormat(), GWEN_PluginDescription__GetLongDescrByFormat(), GWEN_StringList_FirstEntry(), GWEN_StringListEntry_Data(), and GWEN_StringListEntry_Next().

GWENHYWFAR_API const char* GWEN_PluginDescription_GetName ( const GWEN_PLUGIN_DESCRIPTION pd)
GWENHYWFAR_API const char* GWEN_PluginDescription_GetPath ( const GWEN_PLUGIN_DESCRIPTION pd)

Definition at line 198 of file plugindescr.c.

GWENHYWFAR_API const char* GWEN_PluginDescription_GetShortDescr ( const GWEN_PLUGIN_DESCRIPTION pd)

Definition at line 230 of file plugindescr.c.

References GWEN_I18N_Translate().

GWENHYWFAR_API const char* GWEN_PluginDescription_GetType ( const GWEN_PLUGIN_DESCRIPTION pd)

Definition at line 222 of file plugindescr.c.

GWENHYWFAR_API const char* GWEN_PluginDescription_GetVersion ( const GWEN_PLUGIN_DESCRIPTION pd)

Definition at line 246 of file plugindescr.c.

GWENHYWFAR_API GWEN_XMLNODE* GWEN_PluginDescription_GetXmlNode ( const GWEN_PLUGIN_DESCRIPTION pd)

Returns the XML node this description consists of (the "plugin" node). It may contain additional information used by programs. This function does not relinquish ownership of the returned pointer, so you MUST NOT free it. As soon as the description itself is destroyed this XML node will be, too. So you have to call GWEN_XMLNode_dup() if you want the XML node to survive the description.

Definition at line 389 of file plugindescr.c.

Referenced by GWEN_Crypt_Token_PluginManager_CheckToken(), and GWEN_Crypt_Token_PluginManager_GetPluginDescrs().

GWENHYWFAR_API int GWEN_PluginDescription_IsActive ( const GWEN_PLUGIN_DESCRIPTION pd)

Definition at line 411 of file plugindescr.c.

GWENHYWFAR_API void GWEN_PluginDescription_List2_freeAll ( GWEN_PLUGIN_DESCRIPTION_LIST2 *  pdl)
GWENHYWFAR_API void GWEN_PluginDescription_SetFileName ( GWEN_PLUGIN_DESCRIPTION pd,
const char *  s 
)

Definition at line 378 of file plugindescr.c.

Referenced by GWEN_LoadPluginDescrsByType().

GWENHYWFAR_API void GWEN_PluginDescription_SetIsActive ( GWEN_PLUGIN_DESCRIPTION pd,
int  i 
)

Definition at line 418 of file plugindescr.c.

GWENHYWFAR_API void GWEN_PluginDescription_SetPath ( GWEN_PLUGIN_DESCRIPTION pd,
const char *  s 
)

Definition at line 205 of file plugindescr.c.

Referenced by GWEN_LoadPluginDescrsByType().