accountopt.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_ACCOUNTOPT_H_
#define _PURPLE_ACCOUNTOPT_H_
 
#include "prefs.h"
 
typedef struct
{
    PurplePrefType type;      
    char *text;             
    char *pref_name;        
    union
    {
        gboolean boolean;   
        int integer;        
        char *string;       
        GList *list;        
    } default_value;
 
    gboolean masked;        
} PurpleAccountOption;
 
typedef struct
{
    char *text;             
    char *default_value;    
    char  field_sep;        
    gboolean reverse;       
} PurpleAccountUserSplit;
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************************/
/**************************************************************************/
PurpleAccountOption *purple_account_option_new(PurplePrefType type,
    const char *text, const char *pref_name);
 
PurpleAccountOption *purple_account_option_bool_new(const char *text,
    const char *pref_name, gboolean default_value);
 
PurpleAccountOption *purple_account_option_int_new(const char *text,
    const char *pref_name, int default_value);
 
PurpleAccountOption *purple_account_option_string_new(const char *text,
    const char *pref_name, const char *default_value);
 
PurpleAccountOption *purple_account_option_list_new(const char *text,
    const char *pref_name, GList *list);
 
void purple_account_option_destroy(PurpleAccountOption *option);
 
void purple_account_option_set_default_bool(PurpleAccountOption *option,
                                          gboolean value);
 
void purple_account_option_set_default_int(PurpleAccountOption *option,
                                         int value);
 
void purple_account_option_set_default_string(PurpleAccountOption *option,
                                            const char *value);
 
void
purple_account_option_set_masked(PurpleAccountOption *option, gboolean masked);
 
void purple_account_option_set_list(PurpleAccountOption *option, GList *values);
 
void purple_account_option_add_list_item(PurpleAccountOption *option,
                                       const char *key, const char *value);
 
PurplePrefType purple_account_option_get_type(const PurpleAccountOption *option);
 
const char *purple_account_option_get_text(const PurpleAccountOption *option);
 
const char *purple_account_option_get_setting(const PurpleAccountOption *option);
 
gboolean purple_account_option_get_default_bool(const PurpleAccountOption *option);
 
int purple_account_option_get_default_int(const PurpleAccountOption *option);
 
const char *purple_account_option_get_default_string(
    const PurpleAccountOption *option);
 
const char *purple_account_option_get_default_list_value(
    const PurpleAccountOption *option);
 
gboolean
purple_account_option_get_masked(const PurpleAccountOption *option);
 
GList *purple_account_option_get_list(const PurpleAccountOption *option);
 
/**************************************************************************/
/**************************************************************************/
PurpleAccountUserSplit *purple_account_user_split_new(const char *text,
                                                  const char *default_value,
                                                  char sep);
 
void purple_account_user_split_destroy(PurpleAccountUserSplit *split);
 
const char *purple_account_user_split_get_text(const PurpleAccountUserSplit *split);
 
const char *purple_account_user_split_get_default_value(
        const PurpleAccountUserSplit *split);
 
char purple_account_user_split_get_separator(const PurpleAccountUserSplit *split);
 
gboolean purple_account_user_split_get_reverse(const PurpleAccountUserSplit *split);
 
void purple_account_user_split_set_reverse(PurpleAccountUserSplit *split, gboolean reverse);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_ACCOUNTOPT_H_ */