| Anjuta Developers Reference Manual |
|---|
AnjutaPluginDescription — Plugins meta data description
struct AnjutaPluginDescription; void (*AnjutaPluginDescriptionSectionFunc) (AnjutaPluginDescription *df, const gchar *name, gpointer user_data); void (*AnjutaPluginDescriptionLineFunc) (AnjutaPluginDescription *df, const gchar *key, const gchar *locale, const gchar *value, gpointer data); enum AnjutaPluginDescriptionParseError; #define ANJUTA_PLUGIN_DESCRIPTION_PARSE_ERROR GQuark anjuta_plugin_description_parse_error_quark (void); AnjutaPluginDescription* anjuta_plugin_description_new (const gchar *filename, GError **error); AnjutaPluginDescription* anjuta_plugin_description_new_from_string (gchar *data, GError **error); gchar* anjuta_plugin_description_to_string (AnjutaPluginDescription *pd); void anjuta_plugin_description_free (AnjutaPluginDescription *pd); void anjuta_plugin_description_foreach_section (AnjutaPluginDescription *pd, AnjutaPluginDescriptionSectionFunc func, gpointer user_data); void anjuta_plugin_description_foreach_key (AnjutaPluginDescription *dp, const gchar *section, gboolean include_localized, AnjutaPluginDescriptionLineFunc func, gpointer user_data); gboolean anjuta_plugin_description_get_raw (AnjutaPluginDescription *dp, const gchar *section, const gchar *keyname, const gchar *locale, gchar **val); gboolean anjuta_plugin_description_get_integer (AnjutaPluginDescription *dp, const gchar *section, const gchar *keyname, gint *val); gboolean anjuta_plugin_description_get_string (AnjutaPluginDescription *dp, const gchar *section, const gchar *keyname, gchar **val); gboolean anjuta_plugin_description_get_locale_string (AnjutaPluginDescription *dp, const gchar *section, const gchar *keyname, gchar **val);
void (*AnjutaPluginDescriptionSectionFunc)
(AnjutaPluginDescription *df,
const gchar *name,
gpointer user_data);
| df : | |
| name : | |
| user_data : |
void (*AnjutaPluginDescriptionLineFunc)
(AnjutaPluginDescription *df,
const gchar *key,
const gchar *locale,
const gchar *value,
gpointer data);
| df : | |
| key : | |
| locale : | |
| value : | |
| data : |
typedef enum
{
ANJUTA_PLUGIN_DESCRIPTION_PARSE_ERROR_INVALID_SYNTAX,
ANJUTA_PLUGIN_DESCRIPTION_PARSE_ERROR_INVALID_ESCAPES,
ANJUTA_PLUGIN_DESCRIPTION_PARSE_ERROR_INVALID_CHARS
} AnjutaPluginDescriptionParseError;
GQuark anjuta_plugin_description_parse_error_quark (void);
| Returns : |
AnjutaPluginDescription* anjuta_plugin_description_new (const gchar *filename, GError **error);
| filename : | |
| error : | |
| Returns : |
AnjutaPluginDescription* anjuta_plugin_description_new_from_string (gchar *data, GError **error);
Parses the given plugin description data (usally read from the plugin description file and creates an instance of AnjutaPluginDescription. The format of the content string is similar to .ini format.
| data : | The data to parse. The format of the data is .ini style. |
| error : | |
| Returns : | a new AnjutaPluginDescription object |
gchar* anjuta_plugin_description_to_string (AnjutaPluginDescription *pd);
Converts the description detains into string format, usually for saving it in a file.
| pd : | |
| Returns : | The string representation of the description. The returned values must be freed after use. |
void anjuta_plugin_description_free (AnjutaPluginDescription *pd);
Frees the AnjutaPluginDescription instance.
| pd : |
void anjuta_plugin_description_foreach_section
(AnjutaPluginDescription *pd,
AnjutaPluginDescriptionSectionFunc func,
gpointer user_data);Calls func for each of the sections in the description.
| pd : | |
| func : | Callback function. |
| user_data : | User data to pass to func. |
void anjuta_plugin_description_foreach_key
(AnjutaPluginDescription *dp,
const gchar *section,
gboolean include_localized,
AnjutaPluginDescriptionLineFunc func,
gpointer user_data);Calls func for each of the keys in the given section. include_localized, if set to TRUE will make it call func for the localized keys also, otherwise only one call is made for the key in current locale.
| dp : | |
| section : | |
| include_localized : | Whether each localized key should be called separately. |
| func : | The callback function. |
| user_data : | User data to pass to func. |
gboolean anjuta_plugin_description_get_raw (AnjutaPluginDescription *dp, const gchar *section, const gchar *keyname, const gchar *locale, gchar **val);
Retrieves the value of a key (in the given section) for the given locale. The value returned in val must be freed after use.
| dp : | |
| section : | |
| keyname : | Name of the key. |
| locale : | The locale for which the value is to be retrieved. |
| val : | Pointer to the variable to store the string value. |
| Returns : | TRUE if sucessful, otherwise FALSE. |
gboolean anjuta_plugin_description_get_integer (AnjutaPluginDescription *dp, const gchar *section, const gchar *keyname, gint *val);
Returns the value of key as integer in the given section in current locale.
| dp : | |
| section : | Section name. |
| keyname : | Key name. |
| val : | Pointer to value to store retured value. |
| Returns : | TRUE if sucessful, otherwise FALSE. |
gboolean anjuta_plugin_description_get_string (AnjutaPluginDescription *dp, const gchar *section, const gchar *keyname, gchar **val);
Returns the value of key in the given section.
| dp : | |
| section : | Section name. |
| keyname : | Key name. |
| val : | Pointer to value to store retured value. |
| Returns : | TRUE if sucessful, otherwise FALSE. |
gboolean anjuta_plugin_description_get_locale_string (AnjutaPluginDescription *dp, const gchar *section, const gchar *keyname, gchar **val);
Returns the value of key in the given section in current locale.
| dp : | |
| section : | Section name. |
| keyname : | Key name. |
| val : | Pointer to value to store retured value. |
| Returns : | TRUE if sucessful, otherwise FALSE. |
| << AnjutaPlugin | Plugins >> |