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 
00151 PurpleAccountOption *purple_account_option_list_new(const char *text,
00152     const char *pref_name, GList *list);
00153 
00159 void purple_account_option_destroy(PurpleAccountOption *option);
00160 
00167 void purple_account_option_set_default_bool(PurpleAccountOption *option,
00168                                           gboolean value);
00169 
00176 void purple_account_option_set_default_int(PurpleAccountOption *option,
00177                                          int value);
00178 
00185 void purple_account_option_set_default_string(PurpleAccountOption *option,
00186                                             const char *value);
00187 
00196 void
00197 purple_account_option_set_masked(PurpleAccountOption *option, gboolean masked);
00198 
00211 void purple_account_option_set_list(PurpleAccountOption *option, GList *values);
00212 
00220 void purple_account_option_add_list_item(PurpleAccountOption *option,
00221                                        const char *key, const char *value);
00222 
00230 PurplePrefType purple_account_option_get_type(const PurpleAccountOption *option);
00231 
00239 const char *purple_account_option_get_text(const PurpleAccountOption *option);
00240 
00250 const char *purple_account_option_get_setting(const PurpleAccountOption *option);
00251 
00259 gboolean purple_account_option_get_default_bool(const PurpleAccountOption *option);
00260 
00268 int purple_account_option_get_default_int(const PurpleAccountOption *option);
00269 
00277 const char *purple_account_option_get_default_string(
00278     const PurpleAccountOption *option);
00279 
00287 const char *purple_account_option_get_default_list_value(
00288     const PurpleAccountOption *option);
00289 
00299 gboolean
00300 purple_account_option_get_masked(const PurpleAccountOption *option);
00301 
00309 GList *purple_account_option_get_list(const PurpleAccountOption *option);
00310 
00314 /**************************************************************************/
00316 /**************************************************************************/
00328 PurpleAccountUserSplit *purple_account_user_split_new(const char *text,
00329                                                   const char *default_value,
00330                                                   char sep);
00331 
00337 void purple_account_user_split_destroy(PurpleAccountUserSplit *split);
00338 
00346 const char *purple_account_user_split_get_text(const PurpleAccountUserSplit *split);
00347 
00355 const char *purple_account_user_split_get_default_value(
00356         const PurpleAccountUserSplit *split);
00357 
00365 char purple_account_user_split_get_separator(const PurpleAccountUserSplit *split);
00366 
00374 gboolean purple_account_user_split_get_reverse(const PurpleAccountUserSplit *split);
00375 
00382 void purple_account_user_split_set_reverse(PurpleAccountUserSplit *split, gboolean reverse);
00383 
00386 #ifdef __cplusplus
00387 }
00388 #endif
00389 
00390 #endif /* _PURPLE_ACCOUNTOPT_H_ */