pluginpref.h File Reference

Plugin Preferences API. More...

#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 _GaimPluginPrefFrame GaimPluginPrefFrame
typedef _GaimPluginPref GaimPluginPref

Enumerations

enum  GaimPluginPrefType { GAIM_PLUGIN_PREF_NONE, GAIM_PLUGIN_PREF_CHOICE, GAIM_PLUGIN_PREF_INFO }

Functions

Plugin Preference API
GaimPluginPrefFrame * gaim_plugin_pref_frame_new ()
 Create a new plugin preference frame.
void gaim_plugin_pref_frame_destroy (GaimPluginPrefFrame *frame)
 Destroy a plugin preference frame.
void gaim_plugin_pref_frame_add (GaimPluginPrefFrame *frame, GaimPluginPref *pref)
 Adds a plugin preference to a plugin preference frame.
GList * gaim_plugin_pref_frame_get_prefs (GaimPluginPrefFrame *frame)
 Get the plugin preferences from a plugin preference frame.
GaimPluginPref * gaim_plugin_pref_new ()
 Create a new plugin preference.
GaimPluginPref * gaim_plugin_pref_new_with_name (char *name)
 Create a new plugin preference with name.
GaimPluginPref * gaim_plugin_pref_new_with_label (char *label)
 Create a new plugin preference with label.
GaimPluginPref * gaim_plugin_pref_new_with_name_and_label (char *name, char *label)
 Create a new plugin preference with name and label.
void gaim_plugin_pref_destroy (GaimPluginPref *pref)
 Destroy a plugin preference.
void gaim_plugin_pref_set_name (GaimPluginPref *pref, char *name)
 Set a plugin pref name.
char * gaim_plugin_pref_get_name (GaimPluginPref *pref)
 Get a plugin pref name.
void gaim_plugin_pref_set_label (GaimPluginPref *pref, char *label)
 Set a plugin pref label.
char * gaim_plugin_pref_get_label (GaimPluginPref *pref)
 Get a plugin pref label.
void gaim_plugin_pref_set_bounds (GaimPluginPref *pref, int min, int max)
 Set the bounds for an integer pref.
void gaim_plugin_pref_get_bounds (GaimPluginPref *pref, int *min, int *max)
 Get the bounds for an integer pref.
void gaim_plugin_pref_set_type (GaimPluginPref *pref, GaimPluginPrefType type)
 Set the type of a plugin pref.
GaimPluginPrefType gaim_plugin_pref_get_type (GaimPluginPref *pref)
 Get the type of a plugin pref.
void gaim_plugin_pref_add_choice (GaimPluginPref *pref, char *label, gpointer choice)
 Set the choices for a choices plugin pref.
GList * gaim_plugin_pref_get_choices (GaimPluginPref *pref)
 Get the choices for a choices plugin pref.
void gaim_plugin_pref_set_max_length (GaimPluginPref *pref, unsigned int max_length)
 Set the max length for a string plugin pref.
unsigned int gaim_plugin_pref_get_max_length (GaimPluginPref *pref)
 Get the max length for a string plugin pref.
void gaim_plugin_pref_set_masked (GaimPluginPref *pref, gboolean mask)
 Sets the masking of a string plugin pref.
gboolean gaim_plugin_pref_get_masked (GaimPluginPref *pref)
 Gets the masking of a string plugin pref.


Detailed Description

Plugin Preferences API.

gaim

Gaim 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


Enumeration Type Documentation

enum GaimPluginPrefType

Enumerator:
GAIM_PLUGIN_PREF_INFO  no-value label


Function Documentation

void gaim_plugin_pref_add_choice ( GaimPluginPref *  pref,
char *  label,
gpointer  choice 
)

Set the choices for a choices plugin pref.

Parameters:
pref The plugin pref
label The label for the choice
choice A gpointer of the choice

void gaim_plugin_pref_destroy ( GaimPluginPref *  pref  ) 

Destroy a plugin preference.

Parameters:
pref The preference to destroy

void gaim_plugin_pref_frame_add ( GaimPluginPrefFrame *  frame,
GaimPluginPref *  pref 
)

Adds a plugin preference to a plugin preference frame.

Parameters:
frame The plugin frame to add the preference to
pref The preference to add to the frame

void gaim_plugin_pref_frame_destroy ( GaimPluginPrefFrame *  frame  ) 

Destroy a plugin preference frame.

Parameters:
frame The plugin frame to destroy

GList* gaim_plugin_pref_frame_get_prefs ( GaimPluginPrefFrame *  frame  ) 

Get the plugin preferences from a plugin preference frame.

Parameters:
frame The plugin frame to get the plugin preferences from
Returns:
a GList of plugin preferences

GaimPluginPrefFrame* gaim_plugin_pref_frame_new (  ) 

Create a new plugin preference frame.

Returns:
a new GaimPluginPrefFrame

void gaim_plugin_pref_get_bounds ( GaimPluginPref *  pref,
int *  min,
int *  max 
)

Get the bounds for an integer pref.

Parameters:
pref The plugin pref
min The min value
max The max value

GList* gaim_plugin_pref_get_choices ( GaimPluginPref *  pref  ) 

Get the choices for a choices plugin pref.

Parameters:
pref The plugin pref
Returns:
GList of the choices

char* gaim_plugin_pref_get_label ( GaimPluginPref *  pref  ) 

Get a plugin pref label.

Parameters:
pref The plugin pref
Returns:
The label for the plugin pref

gboolean gaim_plugin_pref_get_masked ( GaimPluginPref *  pref  ) 

Gets the masking of a string plugin pref.

Parameters:
pref The plugin pref
Returns:
The masking

unsigned int gaim_plugin_pref_get_max_length ( GaimPluginPref *  pref  ) 

Get the max length for a string plugin pref.

Parameters:
pref The plugin pref
Returns:
the max length

char* gaim_plugin_pref_get_name ( GaimPluginPref *  pref  ) 

Get a plugin pref name.

Parameters:
pref The plugin pref
Returns:
The name of the pref

GaimPluginPrefType gaim_plugin_pref_get_type ( GaimPluginPref *  pref  ) 

Get the type of a plugin pref.

Parameters:
pref The plugin pref
Returns:
The type

GaimPluginPref* gaim_plugin_pref_new (  ) 

Create a new plugin preference.

Returns:
a new GaimPluginPref

GaimPluginPref* gaim_plugin_pref_new_with_label ( char *  label  ) 

Create a new plugin preference with label.

Parameters:
label The label to be displayed
Returns:
a new GaimPluginPref

GaimPluginPref* gaim_plugin_pref_new_with_name ( char *  name  ) 

Create a new plugin preference with name.

Parameters:
name The name of the pref
Returns:
a new GaimPluginPref

GaimPluginPref* gaim_plugin_pref_new_with_name_and_label ( char *  name,
char *  label 
)

Create a new plugin preference with name and label.

Parameters:
name The name of the pref
label The label to be displayed
Returns:
a new GaimPluginPref

void gaim_plugin_pref_set_bounds ( GaimPluginPref *  pref,
int  min,
int  max 
)

Set the bounds for an integer pref.

Parameters:
pref The plugin pref
min The min value
max The max value

void gaim_plugin_pref_set_label ( GaimPluginPref *  pref,
char *  label 
)

Set a plugin pref label.

Parameters:
pref The plugin pref
label The label for the plugin pref

void gaim_plugin_pref_set_masked ( GaimPluginPref *  pref,
gboolean  mask 
)

Sets the masking of a string plugin pref.

Parameters:
pref The plugin pref
mask The value to set

void gaim_plugin_pref_set_max_length ( GaimPluginPref *  pref,
unsigned int  max_length 
)

Set the max length for a string plugin pref.

Parameters:
pref The plugin pref
max_length The max length of the string

void gaim_plugin_pref_set_name ( GaimPluginPref *  pref,
char *  name 
)

Set a plugin pref name.

Parameters:
pref The plugin pref
name The name of the pref

void gaim_plugin_pref_set_type ( GaimPluginPref *  pref,
GaimPluginPrefType  type 
)

Set the type of a plugin pref.

Parameters:
pref The plugin pref
type The type


Generated on Sun Feb 18 07:36:29 2007 for gaim by  doxygen 1.5.1