Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

accountopt.h File Reference

Account Options API. More...

#include "prefs.h"

Include dependency graph for accountopt.h:

Include dependency graph

Go to the source code of this file.

Data Structures

struct  GaimAccountOption
 An option for an account. More...
struct  GaimAccountUserSplit
 A username split. More...

Account Option API

GaimAccountOptiongaim_account_option_new (GaimPrefType type, const char *text, const char *pref_name)
 Creates a new account option.
GaimAccountOptiongaim_account_option_bool_new (const char *text, const char *pref_name, gboolean default_value)
 Creates a new boolean account option.
GaimAccountOptiongaim_account_option_int_new (const char *text, const char *pref_name, int default_value)
 Creates a new integer account option.
GaimAccountOptiongaim_account_option_string_new (const char *text, const char *pref_name, const char *default_value)
 Creates a new string account option.
GaimAccountOptiongaim_account_option_list_new (const char *text, const char *pref_name, GList *list)
 Creates a new list account option.
void gaim_account_option_destroy (GaimAccountOption *option)
 Destroys an account option.
void gaim_account_option_set_default_bool (GaimAccountOption *option, gboolean value)
 Sets the default boolean value for an account option.
void gaim_account_option_set_default_int (GaimAccountOption *option, int value)
 Sets the default integer value for an account option.
void gaim_account_option_set_default_string (GaimAccountOption *option, const char *value)
 Sets the default string value for an account option.
void gaim_account_option_set_masked (GaimAccountOption *option, gboolean masked)
 Sets the masking for an account option.
void gaim_account_option_set_list (GaimAccountOption *option, GList *values)
 Sets the list values for an account option.
void gaim_account_option_add_list_item (GaimAccountOption *option, const char *key, const char *value)
 Adds an item to a list account option.
GaimPrefType gaim_account_option_get_type (const GaimAccountOption *option)
 Returns the specified account option's type.
const char * gaim_account_option_get_text (const GaimAccountOption *option)
 Returns the text for an account option.
const char * gaim_account_option_get_setting (const GaimAccountOption *option)
 Returns the account setting for an account option.
gboolean gaim_account_option_get_default_bool (const GaimAccountOption *option)
 Returns the default boolean value for an account option.
int gaim_account_option_get_default_int (const GaimAccountOption *option)
 Returns the default integer value for an account option.
const char * gaim_account_option_get_default_string (const GaimAccountOption *option)
 Returns the default string value for an account option.
gboolean gaim_account_option_get_masked (const GaimAccountOption *option)
 Returns the masking for an account option.
const GList * gaim_account_option_get_list (const GaimAccountOption *option)
 Returns the list values for an account option.

Account User Split API

GaimAccountUserSplitgaim_account_user_split_new (const char *text, const char *default_value, char sep)
 Creates a new account username split.
void gaim_account_user_split_destroy (GaimAccountUserSplit *split)
 Destroys an account username split.
const char * gaim_account_user_split_get_text (const GaimAccountUserSplit *split)
 Returns the text for an account username split.
const char * gaim_account_user_split_get_default_value (const GaimAccountUserSplit *split)
 Returns the default string value for an account split.
char gaim_account_user_split_get_separator (const GaimAccountUserSplit *split)
 Returns the field separator for an account split.


Detailed Description

Account Options API.

gaim

Gaim 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


Function Documentation

void gaim_account_option_add_list_item GaimAccountOption option,
const char *  key,
const char *  value
 

Adds an item to a list account option.

Parameters:
option The account option.
key The key.
value The value.

GaimAccountOption* gaim_account_option_bool_new const char *  text,
const char *  pref_name,
gboolean  default_value
 

Creates a new boolean account option.

Parameters:
text The text of the option.
pref_name The account preference name for the option.
default_value The default value.
Returns:
The account option.

void gaim_account_option_destroy GaimAccountOption option  ) 
 

Destroys an account option.

Parameters:
option The option to destroy.

gboolean gaim_account_option_get_default_bool const GaimAccountOption option  ) 
 

Returns the default boolean value for an account option.

Parameters:
option The account option.
Returns:
The default boolean value.

int gaim_account_option_get_default_int const GaimAccountOption option  ) 
 

Returns the default integer value for an account option.

Parameters:
option The account option.
Returns:
The default integer value.

const char* gaim_account_option_get_default_string const GaimAccountOption option  ) 
 

Returns the default string value for an account option.

Parameters:
option The account option.
Returns:
The default string value.

const GList* gaim_account_option_get_list const GaimAccountOption option  ) 
 

Returns the list values for an account option.

Parameters:
option The account option.
Returns:
The list values.

gboolean gaim_account_option_get_masked const GaimAccountOption option  ) 
 

Returns the masking for an account option.

Parameters:
option The account option.
Returns:
The masking.

const char* gaim_account_option_get_setting const GaimAccountOption option  ) 
 

Returns the account setting for an account option.

Parameters:
option The accont option.
Returns:
The account setting.

const char* gaim_account_option_get_text const GaimAccountOption option  ) 
 

Returns the text for an account option.

Parameters:
option The accont option.
Returns:
The account option's text.

GaimPrefType gaim_account_option_get_type const GaimAccountOption option  ) 
 

Returns the specified account option's type.

Parameters:
option The account option.
Returns:
The account option's type.

GaimAccountOption* gaim_account_option_int_new const char *  text,
const char *  pref_name,
int  default_value
 

Creates a new integer account option.

Parameters:
text The text of the option.
pref_name The account preference name for the option.
default_value The default value.
Returns:
The account option.

GaimAccountOption* gaim_account_option_list_new const char *  text,
const char *  pref_name,
GList *  list
 

Creates a new list account option.

The list passed will be owned by the account option, and the strings inside will be freed automatically.

The list is in key, value pairs. The key is the ID stored and used internally, and the value is the label displayed.

Parameters:
text The text of the option.
pref_name The account preference name for the option.
list The key, value list.
Returns:
The account option.

GaimAccountOption* gaim_account_option_new GaimPrefType  type,
const char *  text,
const char *  pref_name
 

Creates a new account option.

Parameters:
type The type of option.
text The text of the option.
pref_name The account preference name for the option.
Returns:
The account option.

void gaim_account_option_set_default_bool GaimAccountOption option,
gboolean  value
 

Sets the default boolean value for an account option.

Parameters:
option The account option.
value The default boolean value.

void gaim_account_option_set_default_int GaimAccountOption option,
int  value
 

Sets the default integer value for an account option.

Parameters:
option The account option.
value The default integer value.

void gaim_account_option_set_default_string GaimAccountOption option,
const char *  value
 

Sets the default string value for an account option.

Parameters:
option The account option.
value The default string value.

void gaim_account_option_set_list GaimAccountOption option,
GList *  values
 

Sets the list values for an account option.

The list passed will be owned by the account option, and the strings inside will be freed automatically.

The list is in key, value pairs. The key is the ID stored and used internally, and the value is the label displayed.

Parameters:
option The account option.
values The default list value.

void gaim_account_option_set_masked GaimAccountOption option,
gboolean  masked
 

Sets the masking for an account option.

Parameters:
option The account option.
masked The masking.

GaimAccountOption* gaim_account_option_string_new const char *  text,
const char *  pref_name,
const char *  default_value
 

Creates a new string account option.

Parameters:
text The text of the option.
pref_name The account preference name for the option.
default_value The default value.
Returns:
The account option.

void gaim_account_user_split_destroy GaimAccountUserSplit split  ) 
 

Destroys an account username split.

Parameters:
split The split to destroy.

const char* gaim_account_user_split_get_default_value const GaimAccountUserSplit split  ) 
 

Returns the default string value for an account split.

Parameters:
split The account username split.
Returns:
The default string.

char gaim_account_user_split_get_separator const GaimAccountUserSplit split  ) 
 

Returns the field separator for an account split.

Parameters:
split The account username split.
Returns:
The field separator.

const char* gaim_account_user_split_get_text const GaimAccountUserSplit split  ) 
 

Returns the text for an account username split.

Parameters:
split The account username split.
Returns:
The account username split's text.

GaimAccountUserSplit* gaim_account_user_split_new const char *  text,
const char *  default_value,
char  sep
 

Creates a new account username split.

Parameters:
text The text of the option.
default_value The default value.
sep The field separator.
Returns:
The new user split.


Generated on Sun Jun 5 18:07:38 2005 for gaim by  doxygen 1.3.9.1