RGroupBox

RGroupBox

Synopsis




#define             R_GROUP_BOX_TYPE
#define             R_GROUP_BOX                         (obj)
#define             R_GROUP_BOX_CLASS                   (klass)
#define             IS_R_GROUP_BOX                      (obj)
#define             IS_R_GROUP_BOX_CLASS                (kls)
#define             R_GROUP_BOX_GET_CLASS               (kls)
                    RGroupBoxPrivate;
                    RGroupBox;
GType               r_group_box_get_type                (void);
RGroupBox*          r_group_box_new                     (void);
void                r_group_box_free                    (RGroupBox *box);
gboolean            r_group_box_is_empty                (RGroupBox *box);
gpointer            r_group_box_find                    (RGroupBox *box,
                                                         const gchar *group_name);
gboolean            r_group_box_owns_group              (RGroupBox *box,
                                                         const gchar *group_name);
gboolean            r_group_box_add_group               (RGroupBox *box,
                                                         RGroup *group);
gboolean            r_group_box_rename_group            (RGroupBox *box,
                                                         gchar *oldname,
                                                         gchar *newname);
void                r_group_box_disable_all             (RGroupBox *box);
void                r_group_box_enable_group            (RGroupBox *box,
                                                         RGroup *group);
void                r_group_box_disable_group           (RGroupBox *box,
                                                         RGroup *group);
gboolean            r_group_box_delete_group            (RGroupBox *box,
                                                         RGroup *group);
gboolean            r_group_box_delete_group_by_name    (RGroupBox *box,
                                                         gchar *name);
GList*              r_group_box_find_groups_owned_by    (RGroupBox *box,
                                                         const gchar *owner);
void                r_group_box_reset                   (RGroupBox *box);
RGroup*             r_group_box_get_group               (RGroupBox *box);
RGroup*             r_group_box_get_next_group          (RGroupBox *box);
RGroup*             r_group_box_get_prev_group          (RGroupBox *box);
RGroupBox*          r_group_box_merge_boxes             (RGroupBox *box,
                                                         RGroupBox *second);

Object Hierarchy


  GObject
   +----RGroupBox

Signals


  "group-added"                                    : Run Last
  "group-removed"                                  : Run Last
  "group-renamed"                                  : Run Last

Description

Details

R_GROUP_BOX_TYPE

#define R_GROUP_BOX_TYPE           (r_group_box_get_type())


R_GROUP_BOX()

#define             R_GROUP_BOX(obj)

obj :

R_GROUP_BOX_CLASS()

#define             R_GROUP_BOX_CLASS(klass)

klass :

IS_R_GROUP_BOX()

#define             IS_R_GROUP_BOX(obj)

obj :

IS_R_GROUP_BOX_CLASS()

#define             IS_R_GROUP_BOX_CLASS(kls)

kls :

R_GROUP_BOX_GET_CLASS()

#define             R_GROUP_BOX_GET_CLASS(kls)

kls :

RGroupBoxPrivate

typedef struct _RGroupBoxPrivate RGroupBoxPrivate;


RGroupBox

typedef struct _RGroupBox RGroupBox;


r_group_box_get_type ()

GType               r_group_box_get_type                (void);

Returns :

r_group_box_new ()

RGroupBox*          r_group_box_new                     (void);

Returns :

r_group_box_free ()

void                r_group_box_free                    (RGroupBox *box);

free memory owned by a RGroupBox

box : a RGroupBox

r_group_box_is_empty ()

gboolean            r_group_box_is_empty                (RGroupBox *box);

Test if the given group_box is empty

box : a RGroupBox
Returns : TRUE if the box is empty, FALSE otherwise

r_group_box_find ()

gpointer            r_group_box_find                    (RGroupBox *box,
                                                         const gchar *group_name);

find a group by name

box : a RGroupBox
group_name : a RGroup's name
Returns : a gpointer to the group with the given name, or NULL if box haven't the group.

r_group_box_owns_group ()

gboolean            r_group_box_owns_group              (RGroupBox *box,
                                                         const gchar *group_name);

test if box owns the given group

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

r_group_box_add_group ()

gboolean            r_group_box_add_group               (RGroupBox *box,
                                                         RGroup *group);

add the group to te box

box : a RGroupBox
group : a RGroup
Returns : a gboolean. TRUE if group if added successfully, FALSE otherwise

r_group_box_rename_group ()

gboolean            r_group_box_rename_group            (RGroupBox *box,
                                                         gchar *oldname,
                                                         gchar *newname);

rename a group in the box

box : a RGroupBox
oldname :
newname :
Returns : a gboolean. TRUE if group is renamed, FALSE otherwise

r_group_box_disable_all ()

void                r_group_box_disable_all             (RGroupBox *box);

disable all groups in box

box : a RGroupBox

r_group_box_enable_group ()

void                r_group_box_enable_group            (RGroupBox *box,
                                                         RGroup *group);

enable the given group

box : a RGroupBox
group : a RGroup

r_group_box_disable_group ()

void                r_group_box_disable_group           (RGroupBox *box,
                                                         RGroup *group);

disable the given group

box : a RGroupBox
group : a RGroup

r_group_box_delete_group ()

gboolean            r_group_box_delete_group            (RGroupBox *box,
                                                         RGroup *group);

delete a group from box

box : a RGroupBox
group : a RGroup
Returns : a gboolean. TRUE if group is deleted, FALSE otherwise

r_group_box_delete_group_by_name ()

gboolean            r_group_box_delete_group_by_name    (RGroupBox *box,
                                                         gchar *name);

delete a group from box

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

r_group_box_find_groups_owned_by ()

GList*              r_group_box_find_groups_owned_by    (RGroupBox *box,
                                                         const gchar *owner);

search for all groups owned by the given "owner"

box : a RGroupBox
owner : a gchar*
Returns : a GList of RGroup or NULL

r_group_box_reset ()

void                r_group_box_reset                   (RGroupBox *box);

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

box : a RGroupBox

r_group_box_get_group ()

RGroup*             r_group_box_get_group               (RGroupBox *box);

get the first group in box

box : a RGroupBox
Returns : a gpointer or NULL if box is void

r_group_box_get_next_group ()

RGroup*             r_group_box_get_next_group          (RGroupBox *box);

get the next group in box.

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

r_group_box_get_prev_group ()

RGroup*             r_group_box_get_prev_group          (RGroupBox *box);

get the previous group in box.

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

r_group_box_merge_boxes ()

RGroupBox*          r_group_box_merge_boxes             (RGroupBox *box,
                                                         RGroupBox *second);

merges the RGroupBoxs

box : a RGroupBox
second : a RGroupBox
Returns : a RGroupBox*

Signal Details

The "group-added" signal

void                user_function                      (RGroupBox *box,
                                                        gpointer   group,
                                                        gpointer   user_data)      : Run Last

signal emitted when a new group is added to the group's box.

box : the RGroupBox that receives the signal
group : the group added to the box
user_data : user data set when the signal handler was connected.

The "group-removed" signal

void                user_function                      (RGroupBox *rgroupbox,
                                                        gint       arg1,
                                                        gpointer   user_data)      : Run Last

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

The "group-renamed" signal

void                user_function                      (RGroupBox *rgroupbox,
                                                        gpointer   arg1,
                                                        gpointer   user_data)      : Run Last

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