ESourceGroup

ESourceGroup —

Synopsis




            ESourceGroup;
ESourceGroup* e_source_group_new            (const char *name,
                                             const char *base_uri);
ESourceGroup* e_source_group_new_from_xml   (const char *xml);
ESourceGroup* e_source_group_new_from_xmldoc
                                            (xmlDocPtr doc);
gboolean    e_source_group_update_from_xml  (ESourceGroup *group,
                                             const char *xml,
                                             gboolean *changed_return);
gboolean    e_source_group_update_from_xmldoc
                                            (ESourceGroup *group,
                                             xmlDocPtr doc,
                                             gboolean *changed_return);
char*       e_source_group_uid_from_xmldoc  (xmlDocPtr doc);
void        e_source_group_set_name         (ESourceGroup *group,
                                             const char *name);
void        e_source_group_set_base_uri     (ESourceGroup *group,
                                             const char *base_uri);
void        e_source_group_set_readonly     (ESourceGroup *group,
                                             gboolean readonly);
const char* e_source_group_peek_uid         (ESourceGroup *group);
const char* e_source_group_peek_name        (ESourceGroup *group);
const char* e_source_group_peek_base_uri    (ESourceGroup *group);
gboolean    e_source_group_get_readonly     (ESourceGroup *group);
GSList*     e_source_group_peek_sources     (ESourceGroup *group);
ESource*    e_source_group_peek_source_by_uid
                                            (ESourceGroup *group,
                                             const char *source_uid);
ESource*    e_source_group_peek_source_by_name
                                            (ESourceGroup *group,
                                             const char *source_name);
gboolean    e_source_group_add_source       (ESourceGroup *group,
                                             ESource *source,
                                             int position);
gboolean    e_source_group_remove_source    (ESourceGroup *group,
                                             ESource *source);
gboolean    e_source_group_remove_source_by_uid
                                            (ESourceGroup *group,
                                             const char *uid);
gchar*      e_source_group_get_property     (ESourceGroup *source,
                                             const gchar *property);
void        e_source_group_set_property     (ESourceGroup *source,
                                             const gchar *property,
                                             const gchar *value);
void        e_source_group_foreach_property (ESourceGroup *source,
                                             GHFunc func,
                                             gpointer data);
char*       e_source_group_to_xml           (ESourceGroup *group);


Object Hierarchy


  GObject
   +----ESourceGroup

Signals


"changed"   void        user_function      (ESourceGroup *esourcegroup,
                                            gpointer      user_data)         : Run last
"source-added"
            void        user_function      (ESourceGroup *esourcegroup,
                                            GObject      *arg1,
                                            gpointer      user_data)         : Run last
"source-removed"
            void        user_function      (ESourceGroup *esourcegroup,
                                            GObject      *arg1,
                                            gpointer      user_data)         : Run last

Description

Details

ESourceGroup

typedef struct _ESourceGroup ESourceGroup;


e_source_group_new ()

ESourceGroup* e_source_group_new            (const char *name,
                                             const char *base_uri);

name :
base_uri :
Returns :

e_source_group_new_from_xml ()

ESourceGroup* e_source_group_new_from_xml   (const char *xml);

xml :
Returns :

e_source_group_new_from_xmldoc ()

ESourceGroup* e_source_group_new_from_xmldoc
                                            (xmlDocPtr doc);

doc :
Returns :

e_source_group_update_from_xml ()

gboolean    e_source_group_update_from_xml  (ESourceGroup *group,
                                             const char *xml,
                                             gboolean *changed_return);

group :
xml :
changed_return :
Returns :

e_source_group_update_from_xmldoc ()

gboolean    e_source_group_update_from_xmldoc
                                            (ESourceGroup *group,
                                             xmlDocPtr doc,
                                             gboolean *changed_return);

group :
doc :
changed_return :
Returns :

e_source_group_uid_from_xmldoc ()

char*       e_source_group_uid_from_xmldoc  (xmlDocPtr doc);

doc :
Returns :

e_source_group_set_name ()

void        e_source_group_set_name         (ESourceGroup *group,
                                             const char *name);

group :
name :

e_source_group_set_base_uri ()

void        e_source_group_set_base_uri     (ESourceGroup *group,
                                             const char *base_uri);

group :
base_uri :

e_source_group_set_readonly ()

void        e_source_group_set_readonly     (ESourceGroup *group,
                                             gboolean readonly);

group :
readonly :

e_source_group_peek_uid ()

const char* e_source_group_peek_uid         (ESourceGroup *group);

group :
Returns :

e_source_group_peek_name ()

const char* e_source_group_peek_name        (ESourceGroup *group);

group :
Returns :

e_source_group_peek_base_uri ()

const char* e_source_group_peek_base_uri    (ESourceGroup *group);

group :
Returns :

e_source_group_get_readonly ()

gboolean    e_source_group_get_readonly     (ESourceGroup *group);

group :
Returns :

e_source_group_peek_sources ()

GSList*     e_source_group_peek_sources     (ESourceGroup *group);

group :
Returns :

e_source_group_peek_source_by_uid ()

ESource*    e_source_group_peek_source_by_uid
                                            (ESourceGroup *group,
                                             const char *source_uid);

group :
source_uid :
Returns :

e_source_group_peek_source_by_name ()

ESource*    e_source_group_peek_source_by_name
                                            (ESourceGroup *group,
                                             const char *source_name);

group :
source_name :
Returns :

e_source_group_add_source ()

gboolean    e_source_group_add_source       (ESourceGroup *group,
                                             ESource *source,
                                             int position);

group :
source :
position :
Returns :

e_source_group_remove_source ()

gboolean    e_source_group_remove_source    (ESourceGroup *group,
                                             ESource *source);

group :
source :
Returns :

e_source_group_remove_source_by_uid ()

gboolean    e_source_group_remove_source_by_uid
                                            (ESourceGroup *group,
                                             const char *uid);

group :
uid :
Returns :

e_source_group_get_property ()

gchar*      e_source_group_get_property     (ESourceGroup *source,
                                             const gchar *property);

source :
property :
Returns :

e_source_group_set_property ()

void        e_source_group_set_property     (ESourceGroup *source,
                                             const gchar *property,
                                             const gchar *value);

source :
property :
value :

e_source_group_foreach_property ()

void        e_source_group_foreach_property (ESourceGroup *source,
                                             GHFunc func,
                                             gpointer data);

source :
func :
data :

e_source_group_to_xml ()

char*       e_source_group_to_xml           (ESourceGroup *group);

group :
Returns :

Signal Details

The "changed" signal

void        user_function                  (ESourceGroup *esourcegroup,
                                            gpointer      user_data)         : Run last

esourcegroup : the object which received the signal.
user_data : user data set when the signal handler was connected.

The "source-added" signal

void        user_function                  (ESourceGroup *esourcegroup,
                                            GObject      *arg1,
                                            gpointer      user_data)         : Run last

esourcegroup : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.

The "source-removed" signal

void        user_function                  (ESourceGroup *esourcegroup,
                                            GObject      *arg1,
                                            gpointer      user_data)         : Run last

esourcegroup : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.