KolabSettingsHandler

KolabSettingsHandler — aggregate Evolution settings data

Stability Level

Unstable, unless otherwise indicated

Synopsis

enum                KolabSettingsHandlerBoolFieldID;
enum                KolabSettingsHandlerCharFieldID;
struct              KolabSettingsHandlerClass;
enum                KolabSettingsHandlerIntFieldID;
enum                KolabSettingsHandlerUintFieldID;
gboolean            kolab_settings_handler_bringup      (KolabSettingsHandler *self,
                                                         GError **err);
gboolean            kolab_settings_handler_configure    (KolabSettingsHandler *self,
                                                         KolabFolderContextID context,
                                                         GError **err);
gboolean            kolab_settings_handler_get_bool_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerBoolFieldID field_id,
                                                         GError **err);
CamelKolabIMAPXSettings * kolab_settings_handler_get_camel_settings
                                                        (KolabSettingsHandler *self);
const gchar *       kolab_settings_handler_get_char_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerCharFieldID field_id,
                                                         GError **err);
EBackend *          kolab_settings_handler_get_e_backend
                                                        (KolabSettingsHandler *self);
gint                kolab_settings_handler_get_int_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerIntFieldID field_id,
                                                         GError **err);
guint               kolab_settings_handler_get_uint_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerUintFieldID field_id,
                                                         GError **err);
KolabSettingsHandler * kolab_settings_handler_new       (CamelKolabIMAPXSettings *camel_settings,
                                                         EBackend *e_backend);
gboolean            kolab_settings_handler_set_bool_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerBoolFieldID field_id,
                                                         gboolean value,
                                                         GError **err);
gboolean            kolab_settings_handler_set_char_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerCharFieldID field_id,
                                                         gchar *value,
                                                         GError **err);
gboolean            kolab_settings_handler_set_int_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerIntFieldID field_id,
                                                         gint value,
                                                         GError **err);
gboolean            kolab_settings_handler_set_uint_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerUintFieldID field_id,
                                                         guint value,
                                                         GError **err);
gboolean            kolab_settings_handler_shutdown     (KolabSettingsHandler *self,
                                                         GError **err);

Description

This class is handles all Kolab (account) settings for the Kolab backends. This means (mostly) reading the settings information created by the Evolution frontend and encapsulating operations concerning ESource classes. One instance of this class will live in each backend process and is passed to KolabMailAccess (and by KolabMailAccess, on to all of it's subordinate objects).

Details

enum KolabSettingsHandlerBoolFieldID

typedef enum {
	KOLAB_SETTINGS_HANDLER_BOOL_FIELD_NONE = 0, /* FIXME replace */
	KOLAB_SETTINGS_HANDLER_BOOL_LAST_FIELD
} KolabSettingsHandlerBoolFieldID;

enum KolabSettingsHandlerCharFieldID

typedef enum {
	KOLAB_SETTINGS_HANDLER_CHAR_FIELD_CAMEL_DATA_DIR = 0,
	KOLAB_SETTINGS_HANDLER_CHAR_FIELD_CAMEL_CACHE_DIR,
	KOLAB_SETTINGS_HANDLER_CHAR_FIELD_CAMEL_CONFIG_DIR,
	KOLAB_SETTINGS_HANDLER_CHAR_FIELD_CAMEL_ACCOUNT_DIR,
	KOLAB_SETTINGS_HANDLER_CHAR_FIELD_USER_HOME_DIR,
	KOLAB_SETTINGS_HANDLER_CHAR_FIELD_ESOURCE_UID,
	KOLAB_SETTINGS_HANDLER_CHAR_FIELD_KOLAB_USER_PASSWORD,
	KOLAB_SETTINGS_HANDLER_CHAR_LAST_FIELD
} KolabSettingsHandlerCharFieldID;

struct KolabSettingsHandlerClass

struct KolabSettingsHandlerClass {
	GObjectClass parent_class;
};

enum KolabSettingsHandlerIntFieldID

typedef enum {
	KOLAB_SETTINGS_HANDLER_INT_FIELD_KOLAB_SERVER_IMAP_PORT = 0,
	KOLAB_SETTINGS_HANDLER_INT_FIELD_KOLAB_SERVER_IMAPS_PORT,
	KOLAB_SETTINGS_HANDLER_INT_FIELD_KOLAB_SERVER_HTTP_PORT,
	KOLAB_SETTINGS_HANDLER_INT_FIELD_KOLAB_SERVER_HTTPS_PORT,
	KOLAB_SETTINGS_HANDLER_INT_FIELD_KOLAB_SERVER_LDAP_PORT,
	KOLAB_SETTINGS_HANDLER_INT_FIELD_KOLAB_SERVER_LDAPS_PORT,
	KOLAB_SETTINGS_HANDLER_INT_LAST_FIELD
} KolabSettingsHandlerIntFieldID;

enum KolabSettingsHandlerUintFieldID

typedef enum {
	KOLAB_SETTINGS_HANDLER_UINT_FIELD_FOLDER_CONTEXT = 0,
	KOLAB_SETTINGS_HANDLER_UINT_FIELD_FOLDER_SYNCSTRATEGY,
	KOLAB_SETTINGS_HANDLER_UINT_LAST_FIELD
} KolabSettingsHandlerUintFieldID;

kolab_settings_handler_bringup ()

gboolean            kolab_settings_handler_bringup      (KolabSettingsHandler *self,
                                                         GError **err);

Gets the KolabSettingsHandler object into operational mode. This may involve file I/O. Must be called once after kolab_settings_handler_configure() and before any other operation.

self :

a KolabSettingsHandler instance

err :

a GError object (or NULL)

Returns :

TRUE on success, FALSE otherwise (with err set)

kolab_settings_handler_configure ()

gboolean            kolab_settings_handler_configure    (KolabSettingsHandler *self,
                                                         KolabFolderContextID context,
                                                         GError **err);

Configures the object for operation. Must be called once after object instantiation and before any other operation.

self :

a KolabSettingsHandler instance

context :

the folder context (i.e. backend type) the settings handler will be used in (for now, either KOLAB_FOLDER_CONTEXT_CALENDAR or KOLAB_FOLDER_CONTEXT_CONTACT)

err :

a GError object (or NULL)

Returns :

TRUE on success, FALSE otherwise (with err set)

kolab_settings_handler_get_bool_field ()

gboolean            kolab_settings_handler_get_bool_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerBoolFieldID field_id,
                                                         GError **err);

Gets the value of the bool field selected by field_id. Check err for errors since FALSE may be a valid return value for the bool field.

self :

a KolabSettingsHandler instance

field_id :

the bool field id to get a value from

err :

a GError object (or NULL)

Returns :

the referenced boolean value on success, FALSE otherwise (with err set)

kolab_settings_handler_get_camel_settings ()

CamelKolabIMAPXSettings * kolab_settings_handler_get_camel_settings
                                                        (KolabSettingsHandler *self);

kolab_settings_handler_get_char_field ()

const gchar *       kolab_settings_handler_get_char_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerCharFieldID field_id,
                                                         GError **err);

Gets the value of the char field selected by field_id.

self :

a KolabSettingsHandler instance

field_id :

the char field id to get a value from

err :

a GError object (or NULL)

Returns :

the referenced string on success, NULL otherwise (with err set)

kolab_settings_handler_get_e_backend ()

EBackend *          kolab_settings_handler_get_e_backend
                                                        (KolabSettingsHandler *self);

kolab_settings_handler_get_int_field ()

gint                kolab_settings_handler_get_int_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerIntFieldID field_id,
                                                         GError **err);

Gets the value of the int field selected by field_id. Check err for errors since 0 may be a valid return value for the int field.

self :

a KolabSettingsHandler instance

field_id :

the int field id to get a value from

err :

a GError object (or NULL)

Returns :

the referenced integer on success, 0 otherwise (with err set)

kolab_settings_handler_get_uint_field ()

guint               kolab_settings_handler_get_uint_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerUintFieldID field_id,
                                                         GError **err);

Gets the value of the uint field selected by field_id. Check err for errors since 0 may be a valid return value for the uint field.

self :

a KolabSettingsHandler instance

field_id :

the uint field id to get a value from

err :

a GError object (or NULL)

Returns :

the referenced unsigned integer on success, 0 otherwise (with err set)

kolab_settings_handler_new ()

KolabSettingsHandler * kolab_settings_handler_new       (CamelKolabIMAPXSettings *camel_settings,
                                                         EBackend *e_backend);

kolab_settings_handler_set_bool_field ()

gboolean            kolab_settings_handler_set_bool_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerBoolFieldID field_id,
                                                         gboolean value,
                                                         GError **err);

Sets value as the value for the bool field selected by field_id. If an error occurs, the internal value of the bool field selected by field_id is not changed.

self :

a KolabSettingsHandler instance

field_id :

the bool field id to set a value for

value :

value to set for the given field

err :

a GError object (or NULL)

Returns :

TRUE on success, FALSE otherwise (with err set)

kolab_settings_handler_set_char_field ()

gboolean            kolab_settings_handler_set_char_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerCharFieldID field_id,
                                                         gchar *value,
                                                         GError **err);

Sets value as the value for the char field selected by field_id. If an error occurs and the internal value of the char field selected by field_id is not changed, no ownership is taken of value. If the function returns successfully, the KolabSettingsHandler instance will have taken ownership of value, so make sure it is not free'd later on.

self :

a KolabSettingsHandler instance

field_id :

the char field id to set a value for

value :

the string to set as a value for the given field

err :

a GError object (or NULL)

Returns :

TRUE on success, FALSE otherwise (with err set)

kolab_settings_handler_set_int_field ()

gboolean            kolab_settings_handler_set_int_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerIntFieldID field_id,
                                                         gint value,
                                                         GError **err);

Sets value as the value for the int field selected by field_id. If an error occurs, the internal value of the int field selected by field_id is not changed.

self :

a KolabSettingsHandler instance

field_id :

the int field id to set a value for

value :

value to set for the given field

err :

a GError object (or NULL)

Returns :

TRUE on success, FALSE otherwise (with err set)

kolab_settings_handler_set_uint_field ()

gboolean            kolab_settings_handler_set_uint_field
                                                        (KolabSettingsHandler *self,
                                                         KolabSettingsHandlerUintFieldID field_id,
                                                         guint value,
                                                         GError **err);

Sets value as the value for the uint field selected by field_id. If an error occurs, the internal value of the uint field selected by field_id is not changed.

self :

a KolabSettingsHandler instance

field_id :

the uint field id to set a value for

value :

value to set for the given field

err :

a GError object (or NULL)

Returns :

TRUE on success, FALSE otherwise (with err set)

kolab_settings_handler_shutdown ()

gboolean            kolab_settings_handler_shutdown     (KolabSettingsHandler *self,
                                                         GError **err);

Shuts down the KolabSettingsHandler object. Must be called before object destruction. No further operation on the object is valid unless kolab_settings_handler_bringup() is called again.

self :

a KolabSettingsHandler instance

err :

a GError object (or NULL)

Returns :

TRUE on success, FALSE otherwise (with err set)

See Also

KolabMailAccess