accountopt.h

Go to the documentation of this file.
00001 
00006 /* purple
00007  *
00008  * Purple is the legal property of its developers, whose names are too numerous
00009  * to list here.  Please refer to the COPYRIGHT file distributed with this
00010  * source distribution.
00011  *
00012  * This program is free software; you can redistribute it and/or modify
00013  * it under the terms of the GNU General Public License as published by
00014  * the Free Software Foundation; either version 2 of the License, or
00015  * (at your option) any later version.
00016  *
00017  * This program is distributed in the hope that it will be useful,
00018  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00020  * GNU General Public License for more details.
00021  *
00022  * You should have received a copy of the GNU General Public License
00023  * along with this program; if not, write to the Free Software
00024  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
00025  */
00026 #ifndef _PURPLE_ACCOUNTOPT_H_
00027 #define _PURPLE_ACCOUNTOPT_H_
00028 
00029 #include "prefs.h"
00030 
00037 typedef struct
00038 {
00039     PurplePrefType type;      
00041     char *text;             
00042     char *pref_name;        
00044     union
00045     {
00046         gboolean boolean;   
00047         int integer;        
00048         char *string;       
00049         GList *list;        
00051     } default_value;
00052 
00053     gboolean masked;        
00057 } PurpleAccountOption;
00058 
00065 typedef struct
00066 {
00067     char *text;             
00068     char *default_value;    
00069     char  field_sep;        
00070     gboolean reverse;       
00074 } PurpleAccountUserSplit;
00075 
00076 #ifdef __cplusplus
00077 extern "C" {
00078 #endif
00079 
00080 /**************************************************************************/
00082 /**************************************************************************/
00097 PurpleAccountOption *purple_account_option_new(PurplePrefType type,
00098     const char *text, const char *pref_name);
00099 
00109 PurpleAccountOption *purple_account_option_bool_new(const char *text,
00110     const char *pref_name, gboolean default_value);
00111 
00121 PurpleAccountOption *purple_account_option_int_new(const char *text,
00122     const char *pref_name, int default_value);
00123 
00133 PurpleAccountOption *purple_account_option_string_new(const char *text,
00134     const char *pref_name, const char *default_value);
00135 
00153 PurpleAccountOption *purple_account_option_list_new(const char *text,
00154     const char *pref_name, GList *list);
00155 
00161 void purple_account_option_destroy(PurpleAccountOption *option);
00162 
00169 void purple_account_option_set_default_bool(PurpleAccountOption *option,
00170                                           gboolean value);
00171 
00178 void purple_account_option_set_default_int(PurpleAccountOption *option,
00179                                          int value);
00180 
00187 void purple_account_option_set_default_string(PurpleAccountOption *option,
00188                                             const char *value);
00189 
00198 void
00199 purple_account_option_set_masked(PurpleAccountOption *option, gboolean masked);
00200 
00213 void purple_account_option_set_list(PurpleAccountOption *option, GList *values);
00214 
00222 void purple_account_option_add_list_item(PurpleAccountOption *option,
00223                                        const char *key, const char *value);
00224 
00232 PurplePrefType purple_account_option_get_type(const PurpleAccountOption *option);
00233 
00241 const char *purple_account_option_get_text(const PurpleAccountOption *option);
00242 
00252 const char *purple_account_option_get_setting(const PurpleAccountOption *option);
00253 
00261 gboolean purple_account_option_get_default_bool(const PurpleAccountOption *option);
00262 
00270 int purple_account_option_get_default_int(const PurpleAccountOption *option);
00271 
00279 const char *purple_account_option_get_default_string(
00280     const PurpleAccountOption *option);
00281 
00289 const char *purple_account_option_get_default_list_value(
00290     const PurpleAccountOption *option);
00291 
00301 gboolean
00302 purple_account_option_get_masked(const PurpleAccountOption *option);
00303 
00314 GList *purple_account_option_get_list(const PurpleAccountOption *option);
00315 
00319 /**************************************************************************/
00321 /**************************************************************************/
00333 PurpleAccountUserSplit *purple_account_user_split_new(const char *text,
00334                                                   const char *default_value,
00335                                                   char sep);
00336 
00342 void purple_account_user_split_destroy(PurpleAccountUserSplit *split);
00343 
00351 const char *purple_account_user_split_get_text(const PurpleAccountUserSplit *split);
00352 
00360 const char *purple_account_user_split_get_default_value(
00361         const PurpleAccountUserSplit *split);
00362 
00370 char purple_account_user_split_get_separator(const PurpleAccountUserSplit *split);
00371 
00379 gboolean purple_account_user_split_get_reverse(const PurpleAccountUserSplit *split);
00380 
00387 void purple_account_user_split_set_reverse(PurpleAccountUserSplit *split, gboolean reverse);
00388 
00391 #ifdef __cplusplus
00392 }
00393 #endif
00394 
00395 #endif /* _PURPLE_ACCOUNTOPT_H_ */