conf

conf

Synopsis

#define             TPL_CONF_ERROR
enum                TplConfError;
TplConf *           tpl_conf_dup                        (void);
GConfClient *       tpl_conf_get_gconf_client           (TplConf *self);
gboolean            tpl_conf_is_globally_enabled        (TplConf *self,
                                                         GError **error);
gboolean            tpl_conf_is_account_ignored         (TplConf *self,
                                                         const gchar *account_path,
                                                         GError **error);
GSList *            tpl_conf_get_accounts_ignorelist    (TplConf *self,
                                                         GError **error);
void                tpl_conf_globally_enable            (TplConf *self,
                                                         gboolean enable,
                                                         GError **error);
void                tpl_conf_set_accounts_ignorelist    (TplConf *self,
                                                         GSList *newlist,
                                                         GError **error);

Description

Details

TPL_CONF_ERROR

#define TPL_CONF_ERROR g_quark_from_static_string ("tpl-conf-error-quark")


enum TplConfError

typedef enum
{
  /* generic error */
  TPL_CONF_ERROR_FAILED,
  /* GCONF KEY ERROR */
  TPL_CONF_ERROR_GCONF_KEY
} TplConfError;


tpl_conf_dup ()

TplConf *           tpl_conf_dup                        (void);

Convenience function to obtain a TPL Configuration object, which is a singleton.

Returns :

a TplConf signleton instance with its reference counter incremented. Remember to unref the counter.

tpl_conf_get_gconf_client ()

GConfClient *       tpl_conf_get_gconf_client           (TplConf *self);

You probably won't need to and anyway you shoudln't access directly the GConf client. In case you *really* need, remember to ref/unref properly.

self :

TplConf instance

Returns :

an GConfClient instance, owned by the TplConfInstance.

tpl_conf_is_globally_enabled ()

gboolean            tpl_conf_is_globally_enabled        (TplConf *self,
                                                         GError **error);

Wether TPL is globally enabled or not. If it's not globally enabled, no signals will be logged at all. To enable/disable a single account use tpl_conf_set_accounts_ignorelist()

self :

a TplConf instance

error :

memory adress where to store a GError, in case of error, or NULL to ignore error reporting.

Returns :

TRUE if TPL logging is globally enable, otherwise returns FALSE and error will be used.

tpl_conf_is_account_ignored ()

gboolean            tpl_conf_is_account_ignored         (TplConf *self,
                                                         const gchar *account_path,
                                                         GError **error);

Wether account_path is enabled or disable (aka ignored).

self :

a TplConf instance

account_path :

a TpAccount object-path

error :

memory adress where to store a GError, in case of error, or NULL to ignore error reporting.

Returns :

TRUE if account_path is ignored, FALSE if it's not or FALSE and error set if an error occurs.

tpl_conf_get_accounts_ignorelist ()

GSList *            tpl_conf_get_accounts_ignorelist    (TplConf *self,
                                                         GError **error);

The list of ignored accounts. If an account is ignored, no signals for this account will be logged.

self :

a TplConf instance

error :

memory adress where to store a GError, in case of error, or NULL to ignore error reporting.

Returns :

a GList of (gchar *) contaning ignored accounts' object paths or NULL with error set otherwise.

tpl_conf_globally_enable ()

void                tpl_conf_globally_enable            (TplConf *self,
                                                         gboolean enable,
                                                         GError **error);

Globally enables or disables logging for TPL. If it's globally disabled, no signals will be logged at all. Note that this will change the global TPL configuration, affecting all the TPL instances, including the TPL logging process and all the clients using libtelepathy-logger.

self :

a TplConf instance

enable :

wether to globally enable or globally disable logging.

error :

memory adress where to store a GError, in case of error, or NULL to ignore error reporting.

tpl_conf_set_accounts_ignorelist ()

void                tpl_conf_set_accounts_ignorelist    (TplConf *self,
                                                         GSList *newlist,
                                                         GError **error);

Globally disables logging for newlist account's path. If an account is disabled, no signals for such account will be logged.

Note that this will change the global TPL configuration, affecting all the TPL instances, including the TPL logging process and all the clients using libtelepathy-logger.

self :

a TplConf instance

newlist :

a new GList containing account's object paths (gchar *) to be ignored

error :

memory adress where to store a GError, in case of error, or NULL to ignore error reporting.