CodeSlayerEngine

CodeSlayerEngine — Central delegation class.

Synopsis

#include <codeslayer/codeslayer-engine.h>

struct              CodeSlayerEngine;
CodeSlayerEngine *  codeslayer_engine_new               (GtkWindow *window,
                                                         CodeSlayerProfile *profile,
                                                         CodeSlayerProfiles *profiles,
                                                         GtkWidget *profiles_manager,
                                                         CodeSlayerPlugins *plugins,
                                                         GtkWidget *projects,
                                                         GtkWidget *menu_bar,
                                                         GtkWidget *notebook,
                                                         GtkWidget *notebook_pane,
                                                         GtkWidget *side_pane,
                                                         GtkWidget *bottom_pane,
                                                         GtkWidget *hpaned,
                                                         GtkWidget *vpaned);
void                codeslayer_engine_load_profile      (CodeSlayerEngine *engine);
void                codeslayer_engine_open_document     (CodeSlayerEngine *engine,
                                                         gchar *file_path);
gboolean            codeslayer_engine_save_profile      (CodeSlayerEngine *engine);

Object Hierarchy

  GObject
   +----CodeSlayerEngine

Description

The engine sits in the middle of the framework and delegates calls out to the rest of the API. By having such a central engine we can keep various parts of the application very decoupled.

Details

struct CodeSlayerEngine

struct CodeSlayerEngine;

codeslayer_engine_new ()

CodeSlayerEngine *  codeslayer_engine_new               (GtkWindow *window,
                                                         CodeSlayerProfile *profile,
                                                         CodeSlayerProfiles *profiles,
                                                         GtkWidget *profiles_manager,
                                                         CodeSlayerPlugins *plugins,
                                                         GtkWidget *projects,
                                                         GtkWidget *menu_bar,
                                                         GtkWidget *notebook,
                                                         GtkWidget *notebook_pane,
                                                         GtkWidget *side_pane,
                                                         GtkWidget *bottom_pane,
                                                         GtkWidget *hpaned,
                                                         GtkWidget *vpaned);

window :

a GtkWindow.

profile :

a CodeSlayerProfile.

profiles :

a CodeSlayerProfiles.

profiles_manager :

a CodeSlayerProfilesManager.

plugins :

a CodeSlayerPlugins.

projects :

a CodeSlayerProjects.

menu_bar :

a CodeSlayerMenuBar.

notebook :

a CodeSlayerNotebook.

notebook_pane :

a CodeSlayerNotebookPane.

side_pane :

a CodeSlayerSidePane.

bottom_pane :

a CodeSlayerBottomPane.

hpaned :

the main horizontal pane.

vpaned :

the main vertical pane.

Returns :

a new CodeSlayerEngine.

codeslayer_engine_load_profile ()

void                codeslayer_engine_load_profile      (CodeSlayerEngine *engine);

engine :

a CodeSlayerEngine.

codeslayer_engine_open_document ()

void                codeslayer_engine_open_document     (CodeSlayerEngine *engine,
                                                         gchar *file_path);

Will first check to make sure that the document doesn't already exist.

engine :

a CodeSlayerEngine.

file_path :

the document to open by file path.

codeslayer_engine_save_profile ()

gboolean            codeslayer_engine_save_profile      (CodeSlayerEngine *engine);

engine :

a CodeSlayerEngine.