#include <glib.h>
#include "prefs.h"
Include dependency graph for pluginpref.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Typedefs | |
typedef _PurplePluginPref | PurplePluginPref |
typedef _PurplePluginPrefFrame | PurplePluginPrefFrame |
Enumerations | |
enum | PurplePluginPrefType { PURPLE_PLUGIN_PREF_NONE, PURPLE_PLUGIN_PREF_CHOICE, PURPLE_PLUGIN_PREF_INFO, PURPLE_PLUGIN_PREF_STRING_FORMAT } |
enum | PurpleStringFormatType { PURPLE_STRING_FORMAT_TYPE_NONE = 0, PURPLE_STRING_FORMAT_TYPE_MULTILINE = 1 << 0, PURPLE_STRING_FORMAT_TYPE_HTML = 1 << 1 } |
String format for preferences. More... | |
Functions | |
Plugin Preference API | |
void | purple_plugin_pref_add_choice (PurplePluginPref *pref, const char *label, gpointer choice) |
Set the choices for a choices plugin pref. | |
void | purple_plugin_pref_destroy (PurplePluginPref *pref) |
Destroy a plugin preference. | |
void | purple_plugin_pref_frame_add (PurplePluginPrefFrame *frame, PurplePluginPref *pref) |
Adds a plugin preference to a plugin preference frame. | |
void | purple_plugin_pref_frame_destroy (PurplePluginPrefFrame *frame) |
Destroy a plugin preference frame. | |
GList * | purple_plugin_pref_frame_get_prefs (PurplePluginPrefFrame *frame) |
Get the plugin preferences from a plugin preference frame. | |
PurplePluginPrefFrame * | purple_plugin_pref_frame_new (void) |
Create a new plugin preference frame. | |
void | purple_plugin_pref_get_bounds (PurplePluginPref *pref, int *min, int *max) |
Get the bounds for an integer pref. | |
GList * | purple_plugin_pref_get_choices (PurplePluginPref *pref) |
Get the choices for a choices plugin pref. | |
PurpleStringFormatType | purple_plugin_pref_get_format_type (PurplePluginPref *pref) |
Gets the format type of the formattable-string plugin pref. | |
const char * | purple_plugin_pref_get_label (PurplePluginPref *pref) |
Get a plugin pref label. | |
gboolean | purple_plugin_pref_get_masked (PurplePluginPref *pref) |
Gets the masking of a string plugin pref. | |
unsigned int | purple_plugin_pref_get_max_length (PurplePluginPref *pref) |
Get the max length for a string plugin pref. | |
const char * | purple_plugin_pref_get_name (PurplePluginPref *pref) |
Get a plugin pref name. | |
PurplePluginPrefType | purple_plugin_pref_get_type (PurplePluginPref *pref) |
Get the type of a plugin pref. | |
PurplePluginPref * | purple_plugin_pref_new (void) |
Create a new plugin preference. | |
PurplePluginPref * | purple_plugin_pref_new_with_label (const char *label) |
Create a new plugin preference with label. | |
PurplePluginPref * | purple_plugin_pref_new_with_name (const char *name) |
Create a new plugin preference with name. | |
PurplePluginPref * | purple_plugin_pref_new_with_name_and_label (const char *name, const char *label) |
Create a new plugin preference with name and label. | |
void | purple_plugin_pref_set_bounds (PurplePluginPref *pref, int min, int max) |
Set the bounds for an integer pref. | |
void | purple_plugin_pref_set_format_type (PurplePluginPref *pref, PurpleStringFormatType format) |
Sets the format type for a formattable-string plugin pref. | |
void | purple_plugin_pref_set_label (PurplePluginPref *pref, const char *label) |
Set a plugin pref label. | |
void | purple_plugin_pref_set_masked (PurplePluginPref *pref, gboolean mask) |
Sets the masking of a string plugin pref. | |
void | purple_plugin_pref_set_max_length (PurplePluginPref *pref, unsigned int max_length) |
Set the max length for a string plugin pref. | |
void | purple_plugin_pref_set_name (PurplePluginPref *pref, const char *name) |
Set a plugin pref name. | |
void | purple_plugin_pref_set_type (PurplePluginPref *pref, PurplePluginPrefType type) |
Set the type of a plugin pref. |
purple
Purple is the legal property of its developers, whose names are too numerous to list here. Please refer to the COPYRIGHT file distributed with this source distribution.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Definition in file pluginpref.h.
enum PurplePluginPrefType |
PURPLE_PLUGIN_PREF_NONE | |
PURPLE_PLUGIN_PREF_CHOICE | |
PURPLE_PLUGIN_PREF_INFO | no-value label |
PURPLE_PLUGIN_PREF_STRING_FORMAT |
Definition at line 42 of file pluginpref.h.
String format for preferences.
PURPLE_STRING_FORMAT_TYPE_NONE | |
PURPLE_STRING_FORMAT_TYPE_MULTILINE | |
PURPLE_STRING_FORMAT_TYPE_HTML |
Definition at line 35 of file pluginpref.h.
void purple_plugin_pref_add_choice | ( | PurplePluginPref * | pref, | |
const char * | label, | |||
gpointer | choice | |||
) |
Set the choices for a choices plugin pref.
pref | The plugin pref | |
label | The label for the choice | |
choice | A gpointer of the choice |
void purple_plugin_pref_destroy | ( | PurplePluginPref * | pref | ) |
Destroy a plugin preference.
pref | The preference to destroy |
void purple_plugin_pref_frame_add | ( | PurplePluginPrefFrame * | frame, | |
PurplePluginPref * | pref | |||
) |
Adds a plugin preference to a plugin preference frame.
frame | The plugin frame to add the preference to | |
pref | The preference to add to the frame |
void purple_plugin_pref_frame_destroy | ( | PurplePluginPrefFrame * | frame | ) |
Destroy a plugin preference frame.
frame | The plugin frame to destroy |
GList* purple_plugin_pref_frame_get_prefs | ( | PurplePluginPrefFrame * | frame | ) |
Get the plugin preferences from a plugin preference frame.
frame | The plugin frame to get the plugin preferences from |
PurplePluginPrefFrame* purple_plugin_pref_frame_new | ( | void | ) |
Create a new plugin preference frame.
void purple_plugin_pref_get_bounds | ( | PurplePluginPref * | pref, | |
int * | min, | |||
int * | max | |||
) |
Get the bounds for an integer pref.
pref | The plugin pref | |
min | The min value | |
max | The max value |
GList* purple_plugin_pref_get_choices | ( | PurplePluginPref * | pref | ) |
Get the choices for a choices plugin pref.
pref | The plugin pref |
PurpleStringFormatType purple_plugin_pref_get_format_type | ( | PurplePluginPref * | pref | ) |
Gets the format type of the formattable-string plugin pref.
pref | The plugin pref |
const char* purple_plugin_pref_get_label | ( | PurplePluginPref * | pref | ) |
Get a plugin pref label.
pref | The plugin pref |
gboolean purple_plugin_pref_get_masked | ( | PurplePluginPref * | pref | ) |
Gets the masking of a string plugin pref.
pref | The plugin pref |
unsigned int purple_plugin_pref_get_max_length | ( | PurplePluginPref * | pref | ) |
Get the max length for a string plugin pref.
pref | The plugin pref |
const char* purple_plugin_pref_get_name | ( | PurplePluginPref * | pref | ) |
Get a plugin pref name.
pref | The plugin pref |
PurplePluginPrefType purple_plugin_pref_get_type | ( | PurplePluginPref * | pref | ) |
Get the type of a plugin pref.
pref | The plugin pref |
PurplePluginPref* purple_plugin_pref_new | ( | void | ) |
Create a new plugin preference.
PurplePluginPref* purple_plugin_pref_new_with_label | ( | const char * | label | ) |
Create a new plugin preference with label.
label | The label to be displayed |
PurplePluginPref* purple_plugin_pref_new_with_name | ( | const char * | name | ) |
Create a new plugin preference with name.
name | The name of the pref |
PurplePluginPref* purple_plugin_pref_new_with_name_and_label | ( | const char * | name, | |
const char * | label | |||
) |
Create a new plugin preference with name and label.
name | The name of the pref | |
label | The label to be displayed |
void purple_plugin_pref_set_bounds | ( | PurplePluginPref * | pref, | |
int | min, | |||
int | max | |||
) |
Set the bounds for an integer pref.
pref | The plugin pref | |
min | The min value | |
max | The max value |
void purple_plugin_pref_set_format_type | ( | PurplePluginPref * | pref, | |
PurpleStringFormatType | format | |||
) |
Sets the format type for a formattable-string plugin pref.
You need to set the pref type to PURPLE_PLUGIN_PREF_STRING_FORMAT first before setting the format.
pref | The plugin pref | |
format | The format of the string |
void purple_plugin_pref_set_label | ( | PurplePluginPref * | pref, | |
const char * | label | |||
) |
Set a plugin pref label.
pref | The plugin pref | |
label | The label for the plugin pref |
void purple_plugin_pref_set_masked | ( | PurplePluginPref * | pref, | |
gboolean | mask | |||
) |
Sets the masking of a string plugin pref.
pref | The plugin pref | |
mask | The value to set |
void purple_plugin_pref_set_max_length | ( | PurplePluginPref * | pref, | |
unsigned int | max_length | |||
) |
Set the max length for a string plugin pref.
pref | The plugin pref | |
max_length | The max length of the string |
void purple_plugin_pref_set_name | ( | PurplePluginPref * | pref, | |
const char * | name | |||
) |
Set a plugin pref name.
pref | The plugin pref | |
name | The name of the pref |
void purple_plugin_pref_set_type | ( | PurplePluginPref * | pref, | |
PurplePluginPrefType | type | |||
) |
Set the type of a plugin pref.
pref | The plugin pref | |
type | The type |