RubricaGroupSet

RubricaGroupSet —

Synopsis




#define     RUBRICA_GROUP_SET_TYPE
#define     RUBRICA_GROUP_SET               (obj)
#define     RUBRICA_GROUP_SET_CLASS         (klass)
#define     IS_RUBRICA_GROUP_SET            (obj)
#define     IS_RUBRICA_GROUP_SET_CLASS      (kls)
#define     RUBRICA_GROUP_SET_GET_CLASS     (kls)
            RubricaGroupSetPrivate;
GType       rubrica_group_set_get_type      (void);
RubricaGroupSet* rubrica_group_set_new      (void);
void        rubrica_group_set_free          (RubricaGroupSet *set);
gpointer    rubrica_group_set_find          (RubricaGroupSet *set,
                                             gchar *group_name);
gboolean    rubrica_group_set_owns_group    (RubricaGroupSet *set,
                                             gchar *group_name);
gboolean    rubrica_group_set_add_group     (RubricaGroupSet *set,
                                             RubricaGroup *group);
gboolean    rubrica_group_set_delete_group  (RubricaGroupSet *set,
                                             RubricaGroup *group);
gboolean    rubrica_group_set_delete_group_by_name
                                            (RubricaGroupSet *set,
                                             gchar *name);
gboolean    rubrica_group_set_rename_group  (RubricaGroupSet *set,
                                             gchar *oldname,
                                             gchar *newname);
void        rubrica_group_set_disable_all   (RubricaGroupSet *set);
void        rubrica_group_set_enable_group  (RubricaGroupSet *set,
                                             RubricaGroup *group);
void        rubrica_group_set_disable_group (RubricaGroupSet *set,
                                             RubricaGroup *group);
void        rubrica_group_set_reset         (RubricaGroupSet *set);
RubricaGroup* rubrica_group_set_get_group   (RubricaGroupSet *set);
RubricaGroup* rubrica_group_set_get_next_group
                                            (RubricaGroupSet *set);
RubricaGroup* rubrica_group_set_get_prev_group
                                            (RubricaGroupSet *set);
RubricaGroupSet* rubrica_group_set_merge_sets
                                            (RubricaGroupSet *set,
                                             RubricaGroupSet *second);

Description

Details

RUBRICA_GROUP_SET_TYPE

#define RUBRICA_GROUP_SET_TYPE           (rubrica_group_set_get_type())


RUBRICA_GROUP_SET()

#define     RUBRICA_GROUP_SET(obj)

obj :

RUBRICA_GROUP_SET_CLASS()

#define     RUBRICA_GROUP_SET_CLASS(klass)

klass :

IS_RUBRICA_GROUP_SET()

#define     IS_RUBRICA_GROUP_SET(obj)

obj :

IS_RUBRICA_GROUP_SET_CLASS()

#define     IS_RUBRICA_GROUP_SET_CLASS(kls)

kls :

RUBRICA_GROUP_SET_GET_CLASS()

#define     RUBRICA_GROUP_SET_GET_CLASS(kls)

kls :

RubricaGroupSetPrivate

typedef struct _RubricaGroupSetPrivate RubricaGroupSetPrivate;


rubrica_group_set_get_type ()

GType       rubrica_group_set_get_type      (void);

Returns :

rubrica_group_set_new ()

RubricaGroupSet* rubrica_group_set_new      (void);

Returns :

rubrica_group_set_free ()

void        rubrica_group_set_free          (RubricaGroupSet *set);

free memory owned by a RubricaGroupSet

set : a RubricaGroupSet

rubrica_group_set_find ()

gpointer    rubrica_group_set_find          (RubricaGroupSet *set,
                                             gchar *group_name);

find a group by name

set : a RubricaGroupSet
group_name : a RubricaGroup's name
Returns : a gpoiter, to the group with the given name or NULL, if set haven't the group.

rubrica_group_set_owns_group ()

gboolean    rubrica_group_set_owns_group    (RubricaGroupSet *set,
                                             gchar *group_name);

test if set owns the given group

set : a RubricaGroupSet
group_name : a RubricaGroup's name
Returns : a gboolean, TRUE if set owns group, FALSE otherwise

rubrica_group_set_add_group ()

gboolean    rubrica_group_set_add_group     (RubricaGroupSet *set,
                                             RubricaGroup *group);

add the group to te set

set : a RubricaGroupSet
group : a RubricaGroup
Returns : a gboolean. TRUE if group if added successfully, FALSE otherwise

rubrica_group_set_delete_group ()

gboolean    rubrica_group_set_delete_group  (RubricaGroupSet *set,
                                             RubricaGroup *group);

delete a group from set

set : a RubricaGroupSet
group : a RubricaGroup
Returns : a gboolean. TRUE if group is deleted, FALSE otherwise

rubrica_group_set_delete_group_by_name ()

gboolean    rubrica_group_set_delete_group_by_name
                                            (RubricaGroupSet *set,
                                             gchar *name);

delete a group from set

set : a RubricaGroupSet
name : group's name
Returns : a gboolean. TRUE if group is deleted, FALSE otherwise

rubrica_group_set_rename_group ()

gboolean    rubrica_group_set_rename_group  (RubricaGroupSet *set,
                                             gchar *oldname,
                                             gchar *newname);

rename a group in the set

set : a RubricaGroupSet
oldname :
newname :
Returns : a gboolean. TRUE if group is renamed, FALSE otherwise

rubrica_group_set_disable_all ()

void        rubrica_group_set_disable_all   (RubricaGroupSet *set);

disable all groups in set

set : a RubricaGroupSet

rubrica_group_set_enable_group ()

void        rubrica_group_set_enable_group  (RubricaGroupSet *set,
                                             RubricaGroup *group);

enable the given group

set : a RubricaGroupSet
group : a RubricaGroup

rubrica_group_set_disable_group ()

void        rubrica_group_set_disable_group (RubricaGroupSet *set,
                                             RubricaGroup *group);

disable the given group

set : a RubricaGroupSet
group : a RubricaGroup

rubrica_group_set_reset ()

void        rubrica_group_set_reset         (RubricaGroupSet *set);

reset the private RubricaGroupSet iterator to the head of group's list.

set : a RubricaGroupSet

rubrica_group_set_get_group ()

RubricaGroup* rubrica_group_set_get_group   (RubricaGroupSet *set);

get the first group in set

set : a RubricaGroupSet
Returns : a gpointer or NULL if set is void

rubrica_group_set_get_next_group ()

RubricaGroup* rubrica_group_set_get_next_group
                                            (RubricaGroupSet *set);

get the next group in set.

set : a RubricaGroupSet
Returns : a gpointer or NULL if the groups's end list is reached.

rubrica_group_set_get_prev_group ()

RubricaGroup* rubrica_group_set_get_prev_group
                                            (RubricaGroupSet *set);

get the previous group in set.

set : a RubricaGroupSet
Returns : a gpointer or NULL if the groups's head list is reached.

rubrica_group_set_merge_sets ()

RubricaGroupSet* rubrica_group_set_merge_sets
                                            (RubricaGroupSet *set,
                                             RubricaGroupSet *second);

merges the RubricaGroupSets

set : a RubricaGroupSet
second : a RubricaGroupSet
Returns : a RubricaGroupSet*