accountopt.h
Go to the documentation of this file.
1 
6 /* purple
7  *
8  * Purple is the legal property of its developers, whose names are too numerous
9  * to list here. Please refer to the COPYRIGHT file distributed with this
10  * source distribution.
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
25  */
26 #ifndef _PURPLE_ACCOUNTOPT_H_
27 #define _PURPLE_ACCOUNTOPT_H_
28 
29 #include "prefs.h"
30 
37 typedef struct
38 {
41  char *text;
42  char *pref_name;
44  union
45  {
46  gboolean boolean;
47  int integer;
48  char *string;
49  GList *list;
51  } default_value;
52 
53  gboolean masked;
58 
65 typedef struct
66 {
67  char *text;
68  char *default_value;
69  char field_sep;
70  gboolean reverse;
75 
76 #ifdef __cplusplus
77 extern "C" {
78 #endif
79 
80 /**************************************************************************/
82 /**************************************************************************/
98  const char *text, const char *pref_name);
99 
110  const char *pref_name, gboolean default_value);
111 
122  const char *pref_name, int default_value);
123 
134  const char *pref_name, const char *default_value);
135 
154  const char *pref_name, GList *list);
155 
162 
170  gboolean value);
171 
179  int value);
180 
188  const char *value);
189 
198 void
199 purple_account_option_set_masked(PurpleAccountOption *option, gboolean masked);
200 
213 void purple_account_option_set_list(PurpleAccountOption *option, GList *values);
214 
223  const char *key, const char *value);
224 
233 
241 const char *purple_account_option_get_text(const PurpleAccountOption *option);
242 
252 const char *purple_account_option_get_setting(const PurpleAccountOption *option);
253 
262 
271 
280  const PurpleAccountOption *option);
281 
290  const PurpleAccountOption *option);
291 
301 gboolean
303 
315 
319 /**************************************************************************/
321 /**************************************************************************/
334  const char *default_value,
335  char sep);
336 
343 
352 
361  const PurpleAccountUserSplit *split);
362 
371 
380 
388 
391 #ifdef __cplusplus
392 }
393 #endif
394 
395 #endif /* _PURPLE_ACCOUNTOPT_H_ */
void purple_account_option_set_default_bool(PurpleAccountOption *option, gboolean value)
Sets the default boolean value for an account option.
int purple_account_option_get_default_int(const PurpleAccountOption *option)
Returns the default integer value for an account option.
char purple_account_user_split_get_separator(const PurpleAccountUserSplit *split)
Returns the field separator for an account split.
enum _PurplePrefType PurplePrefType
Preference data types.
GList * list
The default list value.
Definition: accountopt.h:49
PurpleAccountOption * purple_account_option_string_new(const char *text, const char *pref_name, const char *default_value)
Creates a new string account option.
A username split.
Definition: accountopt.h:65
const char * purple_account_user_split_get_text(const PurpleAccountUserSplit *split)
Returns the text for an account username split.
char * default_value
The default value.
Definition: accountopt.h:68
void purple_account_option_set_list(PurpleAccountOption *option, GList *values)
Sets the list values for an account option.
int integer
The default integer value.
Definition: accountopt.h:47
PurpleAccountOption * purple_account_option_list_new(const char *text, const char *pref_name, GList *list)
Creates a new list account option.
PurpleAccountOption * purple_account_option_bool_new(const char *text, const char *pref_name, gboolean default_value)
Creates a new boolean account option.
Prefs API.
void purple_account_option_set_masked(PurpleAccountOption *option, gboolean masked)
Sets the masking for an account option.
gboolean purple_account_option_get_default_bool(const PurpleAccountOption *option)
Returns the default boolean value for an account option.
An option for an account.
Definition: accountopt.h:37
gboolean reverse
TRUE if the separator should be found starting a the end of the string, FALSE otherwise.
Definition: accountopt.h:70
PurplePrefType type
The type of value.
Definition: accountopt.h:39
void purple_account_user_split_destroy(PurpleAccountUserSplit *split)
Destroys an account username split.
const char * purple_account_option_get_setting(const PurpleAccountOption *option)
Returns the name of an account option.
char * pref_name
The name of the associated preference.
Definition: accountopt.h:42
GList * purple_account_option_get_list(const PurpleAccountOption *option)
Returns the list values for an account option.
char field_sep
The field separator.
Definition: accountopt.h:69
char * text
The text that will appear to the user.
Definition: accountopt.h:67
void purple_account_option_destroy(PurpleAccountOption *option)
Destroys an account option.
gboolean boolean
The default boolean value.
Definition: accountopt.h:46
gboolean masked
Whether the value entered should be obscured from view (for passwords and similar options) ...
Definition: accountopt.h:53
gboolean purple_account_option_get_masked(const PurpleAccountOption *option)
Returns whether an option's value should be masked from view, like a password.
PurpleAccountOption * purple_account_option_int_new(const char *text, const char *pref_name, int default_value)
Creates a new integer account option.
void purple_account_option_set_default_string(PurpleAccountOption *option, const char *value)
Sets the default string value for an account option.
gboolean purple_account_user_split_get_reverse(const PurpleAccountUserSplit *split)
Returns the 'reverse' value for an account split.
const char * purple_account_option_get_default_list_value(const PurpleAccountOption *option)
Returns the default string value for a list account option.
const char * purple_account_user_split_get_default_value(const PurpleAccountUserSplit *split)
Returns the default string value for an account split.
void purple_account_option_set_default_int(PurpleAccountOption *option, int value)
Sets the default integer value for an account option.
void purple_account_user_split_set_reverse(PurpleAccountUserSplit *split, gboolean reverse)
Sets the 'reverse' value for an account split.
const char * purple_account_option_get_text(const PurpleAccountOption *option)
Returns the text for an account option.
const char * purple_account_option_get_default_string(const PurpleAccountOption *option)
Returns the default string value for an account option.
PurpleAccountOption * purple_account_option_new(PurplePrefType type, const char *text, const char *pref_name)
Creates a new account option.
char * text
The text that will appear to the user.
Definition: accountopt.h:41
char * string
The default string value.
Definition: accountopt.h:48
void purple_account_option_add_list_item(PurpleAccountOption *option, const char *key, const char *value)
Adds an item to a list account option.
PurplePrefType purple_account_option_get_type(const PurpleAccountOption *option)
Returns the specified account option's type.
PurpleAccountUserSplit * purple_account_user_split_new(const char *text, const char *default_value, char sep)
Creates a new account username split.