CodeSlayerProject

CodeSlayerProject — Contains the documents.

Synopsis

#include <codeslayer/codeslayer-project.h>

struct              CodeSlayerProject;
CodeSlayerProject * codeslayer_project_new              (void);
const gchar *       codeslayer_project_get_name         (CodeSlayerProject *project);
void                codeslayer_project_set_name         (CodeSlayerProject *project,
                                                         const gchar *name);
const gchar *       codeslayer_project_get_key          (CodeSlayerProject *project);
void                codeslayer_project_set_key          (CodeSlayerProject *project,
                                                         const gchar *key);
const gchar *       codeslayer_project_get_folder_path  (CodeSlayerProject *project);
void                codeslayer_project_set_folder_path  (CodeSlayerProject *project,
                                                         const gchar *folder_path);

Object Hierarchy

  GObject
   +----CodeSlayerProject

Properties

  "folder-path"              gchar*                : Read / Write
  "key"                      gchar*                : Read / Write
  "name"                     gchar*                : Read / Write

Description

Details

struct CodeSlayerProject

struct CodeSlayerProject;

codeslayer_project_new ()

CodeSlayerProject * codeslayer_project_new              (void);

Creates a new CodeSlayerProject.

Returns :

 a new CodeSlayerProject.

codeslayer_project_get_name ()

const gchar *       codeslayer_project_get_name         (CodeSlayerProject *project);

project :

 a CodeSlayerProject.

Returns :

 the text to display for the project.

codeslayer_project_set_name ()

void                codeslayer_project_set_name         (CodeSlayerProject *project,
                                                         const gchar *name);

project :

 a CodeSlayerProject.

name :

 the text to display for the project.

codeslayer_project_get_key ()

const gchar *       codeslayer_project_get_key          (CodeSlayerProject *project);

project :

 a CodeSlayerProject.

Returns :

 the unique identifier for the project

codeslayer_project_set_key ()

void                codeslayer_project_set_key          (CodeSlayerProject *project,
                                                         const gchar *key);

project :

 a CodeSlayerProject.

key :

 the unique identifier for the project

codeslayer_project_get_folder_path ()

const gchar *       codeslayer_project_get_folder_path  (CodeSlayerProject *project);

project :

 a CodeSlayerProject.

Returns :

 the fully qualified path to the project.

codeslayer_project_set_folder_path ()

void                codeslayer_project_set_folder_path  (CodeSlayerProject *project,
                                                         const gchar *folder_path);

Note: this is not a URI, but rather a normal file path.

project :

 a CodeSlayerDocument.

folder_path :

 the fully qualified path to the project.

Property Details

The "folder-path" property

  "folder-path"              gchar*                : Read / Write

Folder Path.

Default value: ""

The "key" property

  "key"                      gchar*                : Read / Write

The key for the project to uniquely identify it.

Default value: ""

The "name" property

  "name"                     gchar*                : Read / Write

The displayed name for the project.

Default value: ""

Generated by GTK-Doc V1.18