pluginpref.h

Go to the documentation of this file.

 
/* 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., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 *
 */
#ifndef _PURPLE_PLUGINPREF_H_
#define _PURPLE_PLUGINPREF_H_
 
typedef struct _PurplePluginPrefFrame       PurplePluginPrefFrame;
typedef struct _PurplePluginPref            PurplePluginPref;
 
typedef enum
{
    PURPLE_STRING_FORMAT_TYPE_NONE      = 0,          
    PURPLE_STRING_FORMAT_TYPE_MULTILINE = 1 << 0,     
    PURPLE_STRING_FORMAT_TYPE_HTML      = 1 << 1      
} PurpleStringFormatType;
 
typedef enum {
    PURPLE_PLUGIN_PREF_NONE,
    PURPLE_PLUGIN_PREF_CHOICE,
    PURPLE_PLUGIN_PREF_INFO,              
    PURPLE_PLUGIN_PREF_STRING_FORMAT      
} PurplePluginPrefType;
 
#include <glib.h>
#include "prefs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************************/
/**************************************************************************/
PurplePluginPrefFrame *purple_plugin_pref_frame_new(void);
 
void purple_plugin_pref_frame_destroy(PurplePluginPrefFrame *frame);
 
void purple_plugin_pref_frame_add(PurplePluginPrefFrame *frame, PurplePluginPref *pref);
 
GList *purple_plugin_pref_frame_get_prefs(PurplePluginPrefFrame *frame);
 
PurplePluginPref *purple_plugin_pref_new(void);
 
PurplePluginPref *purple_plugin_pref_new_with_name(const char *name);
 
PurplePluginPref *purple_plugin_pref_new_with_label(const char *label);
 
PurplePluginPref *purple_plugin_pref_new_with_name_and_label(const char *name, const char *label);
 
void purple_plugin_pref_destroy(PurplePluginPref *pref);
 
void purple_plugin_pref_set_name(PurplePluginPref *pref, const char *name);
 
const char *purple_plugin_pref_get_name(PurplePluginPref *pref);
 
void purple_plugin_pref_set_label(PurplePluginPref *pref, const char *label);
 
const char *purple_plugin_pref_get_label(PurplePluginPref *pref);
 
void purple_plugin_pref_set_bounds(PurplePluginPref *pref, int min, int max);
 
void purple_plugin_pref_get_bounds(PurplePluginPref *pref, int *min, int *max);
 
void purple_plugin_pref_set_type(PurplePluginPref *pref, PurplePluginPrefType type);
 
PurplePluginPrefType purple_plugin_pref_get_type(PurplePluginPref *pref);
 
void purple_plugin_pref_add_choice(PurplePluginPref *pref, const char *label, gpointer choice);
 
GList *purple_plugin_pref_get_choices(PurplePluginPref *pref);
 
void purple_plugin_pref_set_max_length(PurplePluginPref *pref, unsigned int max_length);
 
unsigned int purple_plugin_pref_get_max_length(PurplePluginPref *pref);
 
void purple_plugin_pref_set_masked(PurplePluginPref *pref, gboolean mask);
 
gboolean purple_plugin_pref_get_masked(PurplePluginPref *pref);
 
void purple_plugin_pref_set_format_type(PurplePluginPref *pref, PurpleStringFormatType format);
 
PurpleStringFormatType purple_plugin_pref_get_format_type(PurplePluginPref *pref);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_PLUGINPREF_H_ */