RGroupSet

RGroupSet —

Synopsis




#define     R_GROUP_SET_TYPE
#define     R_GROUP_SET                     (obj)
#define     R_GROUP_SET_CLASS               (klass)
#define     IS_R_GROUP_SET                  (obj)
#define     IS_R_GROUP_SET_CLASS            (kls)
#define     R_GROUP_SET_GET_CLASS           (kls)
            RGroupSetPrivate;
            RGroupSet;
GType       r_group_set_get_type            (void);
RGroupSet*  r_group_set_new                 (void);
void        r_group_set_free                (RGroupSet *set);
gpointer    r_group_set_find                (RGroupSet *set,
                                             gchar *group_name);
gboolean    r_group_set_owns_group          (RGroupSet *set,
                                             gchar *group_name);
gboolean    r_group_set_add_group           (RGroupSet *set,
                                             RGroup *group);
gboolean    r_group_set_rename_group        (RGroupSet *set,
                                             gchar *oldname,
                                             gchar *newname);
gboolean    r_group_set_delete_group        (RGroupSet *set,
                                             RGroup *group);
gboolean    r_group_set_delete_group_by_name
                                            (RGroupSet *set,
                                             gchar *name);
void        r_group_set_disable_all         (RGroupSet *set);
void        r_group_set_enable_group        (RGroupSet *set,
                                             RGroup *group);
void        r_group_set_disable_group       (RGroupSet *set,
                                             RGroup *group);
void        r_group_set_reset               (RGroupSet *set);
RGroup*     r_group_set_get_group           (RGroupSet *set);
RGroup*     r_group_set_get_next_group      (RGroupSet *set);
RGroup*     r_group_set_get_prev_group      (RGroupSet *set);
RGroupSet*  r_group_set_merge_sets          (RGroupSet *set,
                                             RGroupSet *second);

Object Hierarchy


  GObject
   +----RGroupSet

Signals


"group-added"
            void        user_function      (RGroupSet *rgroupset,
                                            gpointer   arg1,
                                            gpointer   user_data)      : Run last
"group-removed"
            void        user_function      (RGroupSet *rgroupset,
                                            gpointer   arg1,
                                            gpointer   user_data)      : Run last

Description

Details

R_GROUP_SET_TYPE

#define R_GROUP_SET_TYPE           (r_group_set_get_type())


R_GROUP_SET()

#define     R_GROUP_SET(obj)

obj :

R_GROUP_SET_CLASS()

#define     R_GROUP_SET_CLASS(klass)

klass :

IS_R_GROUP_SET()

#define     IS_R_GROUP_SET(obj)

obj :

IS_R_GROUP_SET_CLASS()

#define     IS_R_GROUP_SET_CLASS(kls)

kls :

R_GROUP_SET_GET_CLASS()

#define     R_GROUP_SET_GET_CLASS(kls)

kls :

RGroupSetPrivate

typedef struct _RGroupSetPrivate RGroupSetPrivate;


RGroupSet

typedef struct _RGroupSet RGroupSet;


r_group_set_get_type ()

GType       r_group_set_get_type            (void);

Returns :

r_group_set_new ()

RGroupSet*  r_group_set_new                 (void);

Returns :

r_group_set_free ()

void        r_group_set_free                (RGroupSet *set);

free memory owned by a RGroupSet

set : a RGroupSet

r_group_set_find ()

gpointer    r_group_set_find                (RGroupSet *set,
                                             gchar *group_name);

find a group by name

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

r_group_set_owns_group ()

gboolean    r_group_set_owns_group          (RGroupSet *set,
                                             gchar *group_name);

test if set owns the given group

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

r_group_set_add_group ()

gboolean    r_group_set_add_group           (RGroupSet *set,
                                             RGroup *group);

add the group to te set

set : a RGroupSet
group : a RGroup
Returns : a gboolean. TRUE if group if added successfully, FALSE otherwise

r_group_set_rename_group ()

gboolean    r_group_set_rename_group        (RGroupSet *set,
                                             gchar *oldname,
                                             gchar *newname);

rename a group in the set

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

r_group_set_delete_group ()

gboolean    r_group_set_delete_group        (RGroupSet *set,
                                             RGroup *group);

delete a group from set

set : a RGroupSet
group : a RGroup
Returns : a gboolean. TRUE if group is deleted, FALSE otherwise

r_group_set_delete_group_by_name ()

gboolean    r_group_set_delete_group_by_name
                                            (RGroupSet *set,
                                             gchar *name);

delete a group from set

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

r_group_set_disable_all ()

void        r_group_set_disable_all         (RGroupSet *set);

disable all groups in set

set : a RGroupSet

r_group_set_enable_group ()

void        r_group_set_enable_group        (RGroupSet *set,
                                             RGroup *group);

enable the given group

set : a RGroupSet
group : a RGroup

r_group_set_disable_group ()

void        r_group_set_disable_group       (RGroupSet *set,
                                             RGroup *group);

disable the given group

set : a RGroupSet
group : a RGroup

r_group_set_reset ()

void        r_group_set_reset               (RGroupSet *set);

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

set : a RGroupSet

r_group_set_get_group ()

RGroup*     r_group_set_get_group           (RGroupSet *set);

get the first group in set

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

r_group_set_get_next_group ()

RGroup*     r_group_set_get_next_group      (RGroupSet *set);

get the next group in set.

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

r_group_set_get_prev_group ()

RGroup*     r_group_set_get_prev_group      (RGroupSet *set);

get the previous group in set.

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

r_group_set_merge_sets ()

RGroupSet*  r_group_set_merge_sets          (RGroupSet *set,
                                             RGroupSet *second);

merges the RGroupSets

set : a RGroupSet
second : a RGroupSet
Returns : a RGroupSet*

Signal Details

The "group-added" signal

void        user_function                  (RGroupSet *rgroupset,
                                            gpointer   arg1,
                                            gpointer   user_data)      : Run last

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

The "group-removed" signal

void        user_function                  (RGroupSet *rgroupset,
                                            gpointer   arg1,
                                            gpointer   user_data)      : Run last

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