CodeSlayerGroups

CodeSlayerGroups — Contains the list of groups.

Synopsis

#include <codeslayer/codeslayer-groups.h>

struct              CodeSlayerGroups;
CodeSlayerGroups *  codeslayer_groups_new               (void);
GList *             codeslayer_groups_get_list          (CodeSlayerGroups *groups);
void                codeslayer_groups_set_list          (CodeSlayerGroups *groups,
                                                         GList *list);
void                codeslayer_groups_add_group         (CodeSlayerGroups *groups,
                                                         CodeSlayerGroup *group);
void                codeslayer_groups_remove_group      (CodeSlayerGroups *groups,
                                                         CodeSlayerGroup *group);
CodeSlayerGroup *   codeslayer_groups_find_group        (CodeSlayerGroups *groups,
                                                         const gchar *name);
CodeSlayerGroup *   codeslayer_groups_find_next_group   (CodeSlayerGroups *groups,
                                                         const gchar *name);
CodeSlayerGroup *   codeslayer_groups_get_active_group  (CodeSlayerGroups *groups);
void                codeslayer_groups_set_active_group  (CodeSlayerGroups *groups,
                                                         CodeSlayerGroup *group);
#define             CODESLAYER_DEFAULT_GROUP_DIR
#define             CODESLAYER_GROUPS_ACTVIE
#define             CODESLAYER_GROUPS_CONF
#define             CODESLAYER_GROUPS_DIR

Object Hierarchy

  GObject
   +----CodeSlayerGroups

Properties

  "active"                   CodeSlayerGroup*      : Read / Write
  "list"                     gpointer              : Read / Write

Description

Details

struct CodeSlayerGroups

struct CodeSlayerGroups;

codeslayer_groups_new ()

CodeSlayerGroups *  codeslayer_groups_new               (void);

Creates a new CodeSlayerGroups.

Returns :

 a new CodeSlayerGroups.

codeslayer_groups_get_list ()

GList *             codeslayer_groups_get_list          (CodeSlayerGroups *groups);

groups :

 a CodeSlayerGroups.

Returns :

 The list of CodeSlayerGroup objects within the manager.

codeslayer_groups_set_list ()

void                codeslayer_groups_set_list          (CodeSlayerGroups *groups,
                                                         GList *list);

groups :

 a CodeSlayerGroups.

list :

 the list of CodeSlayerGroup objects to add to the manager.

codeslayer_groups_add_group ()

void                codeslayer_groups_add_group         (CodeSlayerGroups *groups,
                                                         CodeSlayerGroup *group);

groups :

 a CodeSlayerGroups.

group :

 the CodeSlayerGroup to add to the manager.

codeslayer_groups_remove_group ()

void                codeslayer_groups_remove_group      (CodeSlayerGroups *groups,
                                                         CodeSlayerGroup *group);

groups :

 a CodeSlayerGroups.

group :

 the CodeSlayerGroup to remove from the manager.

codeslayer_groups_find_group ()

CodeSlayerGroup *   codeslayer_groups_find_group        (CodeSlayerGroups *groups,
                                                         const gchar *name);

groups :

 a CodeSlayerGroups.

name :

 the name of the CodeSlayerGroup to find.

Returns :

 the group found by name. Will return NULL if the group specified by name is not found.

codeslayer_groups_find_next_group ()

CodeSlayerGroup *   codeslayer_groups_find_next_group   (CodeSlayerGroups *groups,
                                                         const gchar *name);

groups :

 a CodeSlayerGroups.

name :

 the name of the CodeSlayerGroup to start the search from.

Returns :

 the next logical group within the list. Will return NULL if the group specified by name is not found.

codeslayer_groups_get_active_group ()

CodeSlayerGroup *   codeslayer_groups_get_active_group  (CodeSlayerGroups *groups);

groups :

 a CodeSlayerGroups.

Returns :

 the active group in the manager.

codeslayer_groups_set_active_group ()

void                codeslayer_groups_set_active_group  (CodeSlayerGroups *groups,
                                                         CodeSlayerGroup *group);

groups :

 a CodeSlayerGroups.

group :

 the CodeSlayerGroup to set as active in the manager.

CODESLAYER_DEFAULT_GROUP_DIR

#define CODESLAYER_DEFAULT_GROUP_DIR "default"

CODESLAYER_GROUPS_ACTVIE

#define CODESLAYER_GROUPS_ACTVIE "active"

CODESLAYER_GROUPS_CONF

#define CODESLAYER_GROUPS_CONF "groups.conf"

CODESLAYER_GROUPS_DIR

#define CODESLAYER_GROUPS_DIR "groups"

Property Details

The "active" property

  "active"                   CodeSlayerGroup*      : Read / Write

The currently selected group.

The "list" property

  "list"                     gpointer              : Read / Write

The list of CodeSlayerGroup objects in the manager.

Generated by GTK-Doc V1.18