RGroup

RGroup

Synopsis




#define             R_GROUP_TYPE
#define             R_GROUP                             (obj)
#define             R_GROUP_CLASS                       (klass)
#define             IS_R_GROUP                          (obj)
#define             IS_R_GROUP_CLASS                    (kls)
#define             R_GROUP_GET_CLASS                   (kls)
                    RGroupPrivate;
                    RGroup;
GType               r_group_get_type                    (void);
RGroup*             r_group_new                         (void);
void                r_group_free                        (RGroup *group);
RGroup*             r_group_copy                        (RGroup *group);
gboolean            r_group_rename                      (RGroup *group,
                                                         gchar *newname);
gboolean            r_group_change_pixmap               (RGroup *group,
                                                         gchar *newpix);
gboolean            r_group_has_name                    (RGroup *group,
                                                         const gchar *name);
gboolean            r_group_has_owner                   (RGroup *group,
                                                         const gchar *owner);

Object Hierarchy


  GObject
   +----RGroup

Properties


  "enabled"                  gboolean              : Read / Write / Construct
  "group-label"              gchararray            : Read / Write / Construct
  "group-name"               gchararray            : Read / Write / Construct
  "group-owner"              gchararray            : Read / Write / Construct
  "group-pixmap"             gchararray            : Read / Write / Construct
  "id"                       gint                  : Read

Description

Details

R_GROUP_TYPE

#define R_GROUP_TYPE           (r_group_get_type())


R_GROUP()

#define             R_GROUP(obj)

obj :


R_GROUP_CLASS()

#define             R_GROUP_CLASS(klass)

klass :


IS_R_GROUP()

#define             IS_R_GROUP(obj)

obj :


IS_R_GROUP_CLASS()

#define IS_R_GROUP_CLASS(kls)  (G_TYPE_CHECK_CLASS_TYPE((kls), R_GROUP_TYPE))

kls :


R_GROUP_GET_CLASS()

#define             R_GROUP_GET_CLASS(kls)

kls :


RGroupPrivate

typedef struct _RGroupPrivate RGroupPrivate;


RGroup

typedef struct _RGroup RGroup;


r_group_get_type ()

GType               r_group_get_type                    (void);

Returns :


r_group_new ()

RGroup*             r_group_new                         (void);

create a new RGroup

Returns :

a RGroup*

r_group_free ()

void                r_group_free                        (RGroup *group);

free memory

group :

a RGroup

r_group_copy ()

RGroup*             r_group_copy                        (RGroup *group);

copy the given group

group :

a RGroup

Returns :

a new allocated RGroup*

r_group_rename ()

gboolean            r_group_rename                      (RGroup *group,
                                                         gchar *newname);

rename the given group.

group :

a RGroup

newname :

a gchar

Returns :

a gboolean. TRUE if group has been renamed, FALSE otherwise.

r_group_change_pixmap ()

gboolean            r_group_change_pixmap               (RGroup *group,
                                                         gchar *newpix);

replace the pixmap's path with the new one

group :

a RGroup

newpix :

a gchar*

Returns :

a gboolean. TRUE if pixmap's path has been changed, FALSE otherwise.

r_group_has_name ()

gboolean            r_group_has_name                    (RGroup *group,
                                                         const gchar *name);

group :

name :

Returns :


r_group_has_owner ()

gboolean            r_group_has_owner                   (RGroup *group,
                                                         const gchar *owner);

check group's owner

group :

a RGroup

owner :

a gchar*

Returns :

TRUE if "owner" is the group's owner, FALSE otherwise

Property Details

The "enabled" property

  "enabled"                  gboolean              : Read / Write / Construct

enabled/disabled

Default value: FALSE


The "group-label" property

  "group-label"              gchararray            : Read / Write / Construct

the name of the group

Default value: NULL


The "group-name" property

  "group-name"               gchararray            : Read / Write / Construct

the name of the group

Default value: NULL


The "group-owner" property

  "group-owner"              gchararray            : Read / Write / Construct

the owner (creator) of the group. It can have two values: "r" for the default groups, and "user" for the user's defined groups

Default value: "rubrica"


The "group-pixmap" property

  "group-pixmap"             gchararray            : Read / Write / Construct

a pixmap for the group

Default value: NULL


The "id" property

  "id"                       gint                  : Read

the id of the groups.

Default value: 0