CodeSlayerGroup

CodeSlayerGroup — Contains the projects.

Synopsis

#include <codeslayer/codeslayer-group.h>

struct              CodeSlayerGroup;
CodeSlayerGroup *   codeslayer_group_new                (void);
const gchar *       codeslayer_group_get_name           (CodeSlayerGroup *group);
void                codeslayer_group_set_name           (CodeSlayerGroup *group,
                                                         const gchar *name);
GList *             codeslayer_group_get_projects       (CodeSlayerGroup *group);
void                codeslayer_group_set_projects       (CodeSlayerGroup *group,
                                                         GList *projects);
CodeSlayerProject * codeslayer_group_find_project       (CodeSlayerGroup *group,
                                                         const gchar *project_key);
void                codeslayer_group_add_project        (CodeSlayerGroup *group,
                                                         CodeSlayerProject *project);
void                codeslayer_group_remove_project     (CodeSlayerGroup *group,
                                                         CodeSlayerProject *project);
gboolean            codeslayer_group_contains_project   (CodeSlayerGroup *group,
                                                         CodeSlayerProject *project);
void                codeslayer_group_add_lib            (CodeSlayerGroup *group,
                                                         const gchar *lib);
gboolean            codeslayer_group_contains_lib       (CodeSlayerGroup *group,
                                                         const gchar *lib);
GList *             codeslayer_group_get_libs           (CodeSlayerGroup *group);
void                codeslayer_group_remove_lib         (CodeSlayerGroup *group,
                                                         const gchar *lib);
void                codeslayer_group_set_libs           (CodeSlayerGroup *group,
                                                         GList *libs);
#define             CODESLAYER_GROUP_CONF
#define             CODESLAYER_GROUP_LIBS

Object Hierarchy

  GObject
   +----CodeSlayerGroup

Properties

  "libs"                     gpointer              : Read / Write
  "name"                     gchar*                : Read / Write
  "projects"                 gpointer              : Read / Write

Description

Details

struct CodeSlayerGroup

struct CodeSlayerGroup;

codeslayer_group_new ()

CodeSlayerGroup *   codeslayer_group_new                (void);

Creates a new CodeSlayerGroup.

Returns :

a new CodeSlayerGroup.

codeslayer_group_get_name ()

const gchar *       codeslayer_group_get_name           (CodeSlayerGroup *group);

group :

a CodeSlayerGroup.

Returns :

the text to display for the group.

codeslayer_group_set_name ()

void                codeslayer_group_set_name           (CodeSlayerGroup *group,
                                                         const gchar *name);

group :

a CodeSlayerGroup.

name :

the text to display for the group.

codeslayer_group_get_projects ()

GList *             codeslayer_group_get_projects       (CodeSlayerGroup *group);

group :

a CodeSlayerGroup.

Returns :

The list of CodeSlayerProject objects within the group.

codeslayer_group_set_projects ()

void                codeslayer_group_set_projects       (CodeSlayerGroup *group,
                                                         GList *projects);

group :

a CodeSlayerGroup.

projects :

the list of CodeSlayerProject objects to add to the group.

codeslayer_group_find_project ()

CodeSlayerProject * codeslayer_group_find_project       (CodeSlayerGroup *group,
                                                         const gchar *project_key);

group :

a CodeSlayerGroup.

project_key :

the key of the CodeSlayerProject to find.

Returns :

the project found by project_key. Will return NULL if the project specified by project_key is not found.

codeslayer_group_add_project ()

void                codeslayer_group_add_project        (CodeSlayerGroup *group,
                                                         CodeSlayerProject *project);

group :

a CodeSlayerGroup.

project :

the CodeSlayerProject to add to the group.

codeslayer_group_remove_project ()

void                codeslayer_group_remove_project     (CodeSlayerGroup *group,
                                                         CodeSlayerProject *project);

group :

a CodeSlayerGroup.

project :

the CodeSlayerProject to remove from the group.

codeslayer_group_contains_project ()

gboolean            codeslayer_group_contains_project   (CodeSlayerGroup *group,
                                                         CodeSlayerProject *project);

group :

a CodeSlayerGroup.

project :

the CodeSlayerProject to check.

codeslayer_group_add_lib ()

void                codeslayer_group_add_lib            (CodeSlayerGroup *group,
                                                         const gchar *lib);

group :

a CodeSlayerGroup.

lib :

the lib to add.

codeslayer_group_contains_lib ()

gboolean            codeslayer_group_contains_lib       (CodeSlayerGroup *group,
                                                         const gchar *lib);

group :

a CodeSlayerGroup.

lib :

the lib to find.

Returns :

is TRUE if the lib is found in the group.

codeslayer_group_get_libs ()

GList *             codeslayer_group_get_libs           (CodeSlayerGroup *group);

group :

a CodeSlayerGroup.

Returns :

The list of CodeSlayerPlugin lib objects within the group.

codeslayer_group_remove_lib ()

void                codeslayer_group_remove_lib         (CodeSlayerGroup *group,
                                                         const gchar *lib);

group :

a CodeSlayerGroup.

lib :

the lib to remove.

codeslayer_group_set_libs ()

void                codeslayer_group_set_libs           (CodeSlayerGroup *group,
                                                         GList *libs);

group :

a CodeSlayerGroup.

libs :

the list of CodeSlayerPlugin lib objects to add to the group.

CODESLAYER_GROUP_CONF

#define CODESLAYER_GROUP_CONF "group.conf"

CODESLAYER_GROUP_LIBS

#define CODESLAYER_GROUP_LIBS "libs"

Property Details

The "libs" property

  "libs"                     gpointer              : Read / Write

The list of libs in the group.


The "name" property

  "name"                     gchar*                : Read / Write

The name that will be displayed for the plugin.

Default value: ""


The "projects" property

  "projects"                 gpointer              : Read / Write

The list of projects in the group.