CodeSlayerProfile

CodeSlayerProfile — Contains the projects.

Synopsis

#include <codeslayer/codeslayer-profile.h>

struct              CodeSlayerProfile;
CodeSlayerProfile * codeslayer_profile_new              (void);
const gchar *       codeslayer_profile_get_name         (CodeSlayerProfile *profile);
void                codeslayer_profile_set_name         (CodeSlayerProfile *profile,
                                                         gchar *name);
const gchar *       codeslayer_profile_get_file_path    (CodeSlayerProfile *profile);
void                codeslayer_profile_set_file_path    (CodeSlayerProfile *profile,
                                                         const gchar *file_path);
gboolean            codeslayer_profile_get_enable_projects
                                                        (CodeSlayerProfile *profile);
void                codeslayer_profile_set_enable_projects
                                                        (CodeSlayerProfile *profile,
                                                         gboolean enable_projects);
GList *             codeslayer_profile_get_projects     (CodeSlayerProfile *profile);
void                codeslayer_profile_set_projects     (CodeSlayerProfile *profile,
                                                         GList *projects);
CodeSlayerProject * codeslayer_profile_find_project     (CodeSlayerProfile *profile,
                                                         const gchar *project_key);
CodeSlayerProject * codeslayer_profile_get_project_by_file_path
                                                        (CodeSlayerProfile *profile,
                                                         const gchar *file_path);
void                codeslayer_profile_add_project      (CodeSlayerProfile *profile,
                                                         CodeSlayerProject *project);
void                codeslayer_profile_remove_project   (CodeSlayerProfile *profile,
                                                         CodeSlayerProject *project);
void                codeslayer_profile_remove_all_projects
                                                        (CodeSlayerProfile *profile);
gboolean            codeslayer_profile_contains_project (CodeSlayerProfile *profile,
                                                         CodeSlayerProject *project);
GList *             codeslayer_profile_get_documents    (CodeSlayerProfile *profile);
void                codeslayer_profile_set_documents    (CodeSlayerProfile *profile,
                                                         GList *documents);
void                codeslayer_profile_add_document     (CodeSlayerProfile *profile,
                                                         CodeSlayerDocument *document);
void                codeslayer_profile_remove_document  (CodeSlayerProfile *profile,
                                                         CodeSlayerDocument *document);
void                codeslayer_profile_remove_all_documents
                                                        (CodeSlayerProfile *profile);
CodeSlayerRegistry * codeslayer_profile_get_registry    (CodeSlayerProfile *profile);
GList *             codeslayer_profile_get_plugins      (CodeSlayerProfile *profile);
void                codeslayer_profile_set_plugins      (CodeSlayerProfile *profile,
                                                         GList *plugins);
gboolean            codeslayer_profile_contains_plugin  (CodeSlayerProfile *profile,
                                                         const gchar *plugin);
void                codeslayer_profile_add_plugin       (CodeSlayerProfile *profile,
                                                         const gchar *plugin);
void                codeslayer_profile_remove_plugin    (CodeSlayerProfile *profile,
                                                         const gchar *plugin);

Object Hierarchy

  GObject
   +----CodeSlayerProfile

Description

Details

struct CodeSlayerProfile

struct CodeSlayerProfile;

codeslayer_profile_new ()

CodeSlayerProfile * codeslayer_profile_new              (void);

Creates a new CodeSlayerProfile.

Returns :

a new CodeSlayerProfile.

codeslayer_profile_get_name ()

const gchar *       codeslayer_profile_get_name         (CodeSlayerProfile *profile);

profile :

a CodeSlayerProfile.

Returns :

the text to display for the profile.

codeslayer_profile_set_name ()

void                codeslayer_profile_set_name         (CodeSlayerProfile *profile,
                                                         gchar *name);

profile :

a CodeSlayerProfile.

name :

the name of the profile.

Returns :

the text to display for the profile.

codeslayer_profile_get_file_path ()

const gchar *       codeslayer_profile_get_file_path    (CodeSlayerProfile *profile);

profile :

a CodeSlayerProfile.

Returns :

the path to the profiles file.

codeslayer_profile_set_file_path ()

void                codeslayer_profile_set_file_path    (CodeSlayerProfile *profile,
                                                         const gchar *file_path);

profile :

a CodeSlayerProfile.

file_path :

the path to the profiles file.

codeslayer_profile_get_enable_projects ()

gboolean            codeslayer_profile_get_enable_projects
                                                        (CodeSlayerProfile *profile);

codeslayer_profile_set_enable_projects ()

void                codeslayer_profile_set_enable_projects
                                                        (CodeSlayerProfile *profile,
                                                         gboolean enable_projects);

codeslayer_profile_get_projects ()

GList *             codeslayer_profile_get_projects     (CodeSlayerProfile *profile);

profile :

a CodeSlayerProfile.

Returns :

The list of CodeSlayerProject objects within the profile.

codeslayer_profile_set_projects ()

void                codeslayer_profile_set_projects     (CodeSlayerProfile *profile,
                                                         GList *projects);

profile :

a CodeSlayerProfile.

projects :

the list of CodeSlayerProject objects to add to the profile.

codeslayer_profile_find_project ()

CodeSlayerProject * codeslayer_profile_find_project     (CodeSlayerProfile *profile,
                                                         const gchar *project_key);

codeslayer_profile_get_project_by_file_path ()

CodeSlayerProject * codeslayer_profile_get_project_by_file_path
                                                        (CodeSlayerProfile *profile,
                                                         const gchar *file_path);

profile :

a CodeSlayerProfile.

file_path :

the file_path of the CodeSlayerProject to find.

Returns :

the project found by given file path. Will return NULL if the project specified is not found.

codeslayer_profile_add_project ()

void                codeslayer_profile_add_project      (CodeSlayerProfile *profile,
                                                         CodeSlayerProject *project);

profile :

a CodeSlayerProfile.

project :

the CodeSlayerProject to add to the profile.

codeslayer_profile_remove_project ()

void                codeslayer_profile_remove_project   (CodeSlayerProfile *profile,
                                                         CodeSlayerProject *project);

profile :

a CodeSlayerProfile.

project :

the CodeSlayerProject to remove from the profile.

codeslayer_profile_remove_all_projects ()

void                codeslayer_profile_remove_all_projects
                                                        (CodeSlayerProfile *profile);

profile :

a CodeSlayerProfile.

codeslayer_profile_contains_project ()

gboolean            codeslayer_profile_contains_project (CodeSlayerProfile *profile,
                                                         CodeSlayerProject *project);

profile :

a CodeSlayerProfile.

project :

the CodeSlayerProject to check.

codeslayer_profile_get_documents ()

GList *             codeslayer_profile_get_documents    (CodeSlayerProfile *profile);

profile :

a CodeSlayerProfile.

Returns :

The list of CodeSlayerDocuments objects within the profile.

codeslayer_profile_set_documents ()

void                codeslayer_profile_set_documents    (CodeSlayerProfile *profile,
                                                         GList *documents);

profile :

a CodeSlayerProfile.

documents :

the list of CodeSlayerDocument objects to add to the profile.

codeslayer_profile_add_document ()

void                codeslayer_profile_add_document     (CodeSlayerProfile *profile,
                                                         CodeSlayerDocument *document);

profile :

a CodeSlayerProfile.

document :

the CodeSlayerDocument to add to the profile.

codeslayer_profile_remove_document ()

void                codeslayer_profile_remove_document  (CodeSlayerProfile *profile,
                                                         CodeSlayerDocument *document);

profile :

a CodeSlayerProfile.

document :

the CodeSlayerDocument to remove from the profile.

codeslayer_profile_remove_all_documents ()

void                codeslayer_profile_remove_all_documents
                                                        (CodeSlayerProfile *profile);

profile :

a CodeSlayerProfile.

codeslayer_profile_get_registry ()

CodeSlayerRegistry * codeslayer_profile_get_registry    (CodeSlayerProfile *profile);

profile :

a CodeSlayerProfile.

Returns :

The CodeSlayerRegistry* for the profile.

codeslayer_profile_get_plugins ()

GList *             codeslayer_profile_get_plugins      (CodeSlayerProfile *profile);

profile :

a CodeSlayerProfile.

Returns :

The list of CodeSlayerPlugin plugin objects within the profile. For internal use only.

codeslayer_profile_set_plugins ()

void                codeslayer_profile_set_plugins      (CodeSlayerProfile *profile,
                                                         GList *plugins);

profile :

a CodeSlayerProfile.

plugins :

the list of CodeSlayerPlugin plugin objects to add to the profile.

codeslayer_profile_contains_plugin ()

gboolean            codeslayer_profile_contains_plugin  (CodeSlayerProfile *profile,
                                                         const gchar *plugin);

profile :

a CodeSlayerProfile.

plugin :

the plugin to find.

Returns :

is TRUE if the plugin is found in the profile.

codeslayer_profile_add_plugin ()

void                codeslayer_profile_add_plugin       (CodeSlayerProfile *profile,
                                                         const gchar *plugin);

profile :

a CodeSlayerProfile.

plugin :

the plugin to add.

codeslayer_profile_remove_plugin ()

void                codeslayer_profile_remove_plugin    (CodeSlayerProfile *profile,
                                                         const gchar *plugin);

profile :

a CodeSlayerProfile.

plugin :

the plugin to remove.