![]() |
![]() |
![]() |
CodeSlayer Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Signals |
#include <codeslayer/codeslayer.h> struct CodeSlayer; CodeSlayer * codeslayer_new (GtkWindow *window
,CodeSlayerPreferences *preferences
,CodeSlayerProcesses *processes
,CodeSlayerMenuBar *menubar
,CodeSlayerNotebook *notebook
,CodeSlayerProjects *projects
,CodeSlayerProjectProperties *project_properties
,CodeSlayerSidePane *side_pane
,CodeSlayerBottomPane *bottom_pane
,CodeSlayerGroups *groups
); gboolean codeslayer_select_editor (CodeSlayer *codeslayer
,CodeSlayerDocument *document
); CodeSlayerEditor * codeslayer_get_active_editor (CodeSlayer *codeslayer
); CodeSlayerDocument * codeslayer_get_active_editor_document (CodeSlayer *codeslayer
); CodeSlayerProject * codeslayer_get_active_editor_project (CodeSlayer *codeslayer
); const gchar * codeslayer_get_active_editor_file_path (CodeSlayer *codeslayer
); GList * codeslayer_get_all_editors (CodeSlayer *codeslayer
); void codeslayer_add_to_side_pane (CodeSlayer *codeslayer
,GtkWidget *widget
,const gchar *title
); void codeslayer_remove_from_side_pane (CodeSlayer *codeslayer
,GtkWidget *widget
); void codeslayer_add_to_bottom_pane (CodeSlayer *codeslayer
,GtkWidget *widget
,const gchar *title
); void codeslayer_remove_from_bottom_pane (CodeSlayer *codeslayer
,GtkWidget *widget
); void codeslayer_show_bottom_pane (CodeSlayer *codeslayer
,GtkWidget *widget
); void codeslayer_show_side_pane (CodeSlayer *codeslayer
,GtkWidget *widget
); void codeslayer_add_to_menubar (CodeSlayer *codeslayer
,GtkMenuItem *menuitem
); void codeslayer_remove_from_menubar (CodeSlayer *codeslayer
,GtkMenuItem *menuitem
); void codeslayer_add_to_projects_popup (CodeSlayer *codeslayer
,GtkMenuItem *menuitem
); void codeslayer_remove_from_projects_popup (CodeSlayer *codeslayer
,GtkMenuItem *menuitem
); void codeslayer_add_to_project_properties (CodeSlayer *codeslayer
,GtkWidget *widget
,const gchar *title
); void codeslayer_remove_from_project_properties (CodeSlayer *codeslayer
,GtkWidget *widget
); GtkAccelGroup * codeslayer_get_menubar_accel_group (CodeSlayer *codeslayer
); CodeSlayerGroup * codeslayer_get_active_group (CodeSlayer *codeslayer
); gchar * codeslayer_get_active_group_folder_path (CodeSlayer *codeslayer
); gchar * codeslayer_get_configuration_folder_path (CodeSlayer *codeslayer
); CodeSlayerProject * codeslayer_get_project_by_file_path (CodeSlayer *codeslayer
,const gchar *file_path
); CodeSlayerPreferences * codeslayer_get_preferences (CodeSlayer *codeslayer
); GtkWindow * codeslayer_get_toplevel_window (CodeSlayer *codeslayer
); gint codeslayer_add_to_process_bar (CodeSlayer *codeslayer
,gchar *name
,StopProcessFunc func
,gpointer data
); void codeslayer_remove_from_process_bar (CodeSlayer *codeslayer
,gint id
); CodeSlayerEditorLinker * codeslayer_get_editor_linker (CodeSlayer *codeslayer
,GtkTextView *text_view
);
"editor-added" :No Hooks
"editor-removed" :No Hooks
"editor-saved" :No Hooks
"editor-switched" :No Hooks
"editors-all-saved" :No Hooks
"project-properties-opened" :No Hooks
"project-properties-saved" :No Hooks
"projects-changed" :No Hooks
CodeSlayer * codeslayer_new (GtkWindow *window
,CodeSlayerPreferences *preferences
,CodeSlayerProcesses *processes
,CodeSlayerMenuBar *menubar
,CodeSlayerNotebook *notebook
,CodeSlayerProjects *projects
,CodeSlayerProjectProperties *project_properties
,CodeSlayerSidePane *side_pane
,CodeSlayerBottomPane *bottom_pane
,CodeSlayerGroups *groups
);
gboolean codeslayer_select_editor (CodeSlayer *codeslayer
,CodeSlayerDocument *document
);
Finds the editor based on the document file path. First it will find the document in the tree and then open up the editor in the notebook. It is Ok to call this method as much as you want because after the editor is initially loaded up then subsequent calls are very efficient.
|
a CodeSlayer. |
|
a CodeSlayerDocument. |
Returns : |
is TRUE if the editor is able to be found in the tree. |
CodeSlayerEditor * codeslayer_get_active_editor (CodeSlayer *codeslayer
);
|
a CodeSlayer. |
Returns : |
The editor in the notebook that has focus. Will return NULL if there is no active editor. |
CodeSlayerDocument * codeslayer_get_active_editor_document
(CodeSlayer *codeslayer
);
This is a convenience function so that you can easily get at the document associated with the active editor.
|
a CodeSlayer. |
Returns : |
The document that is associated with the active editor. Will return NULL if there is no active editor. |
CodeSlayerProject * codeslayer_get_active_editor_project
(CodeSlayer *codeslayer
);
This is a convenience function so that you can easily get at the project associated with the active editor.
|
a CodeSlayer. |
Returns : |
The project that is associated with the active editor. Will return NULL if there is no active editor. |
const gchar * codeslayer_get_active_editor_file_path
(CodeSlayer *codeslayer
);
The file path for the active editor.
|
a CodeSlayer. |
Returns : |
a string that is owned by the editor and should not be freed. |
void codeslayer_add_to_side_pane (CodeSlayer *codeslayer
,GtkWidget *widget
,const gchar *title
);
Add the given widget to the side pane.
|
a CodeSlayer. |
|
a GtkWidget. |
|
the title for the tab. |
void codeslayer_remove_from_side_pane (CodeSlayer *codeslayer
,GtkWidget *widget
);
Remove the given widget from the side pane.
|
a CodeSlayer. |
|
a GtkWidget. |
void codeslayer_add_to_bottom_pane (CodeSlayer *codeslayer
,GtkWidget *widget
,const gchar *title
);
Add the given widget to the bottom pane.
|
a CodeSlayer. |
|
a GtkWidget. |
|
the title for the tab. |
void codeslayer_remove_from_bottom_pane (CodeSlayer *codeslayer
,GtkWidget *widget
);
Remove the given widget from the bottom pane.
|
a CodeSlayer. |
|
a GtkWidget. |
void codeslayer_show_bottom_pane (CodeSlayer *codeslayer
,GtkWidget *widget
);
Show the bottom pane and display the tab with the given widget. This should be the same widget that you added to the bottom pane.
|
a CodeSlayer. |
|
a GtkWidget. |
void codeslayer_show_side_pane (CodeSlayer *codeslayer
,GtkWidget *widget
);
Show the side pane and display the tab with the given widget. This should be the same widget that you added to the side pane.
|
a CodeSlayer. |
|
a GtkWidget. |
void codeslayer_add_to_menubar (CodeSlayer *codeslayer
,GtkMenuItem *menuitem
);
Add the given menu item to the menubar tools menu.
|
a CodeSlayer. |
|
a GtkMenuItem. |
void codeslayer_remove_from_menubar (CodeSlayer *codeslayer
,GtkMenuItem *menuitem
);
Remove the given menu item from the menubar tools menu.
|
a CodeSlayer. |
|
a GtkMenuItem. |
void codeslayer_add_to_projects_popup (CodeSlayer *codeslayer
,GtkMenuItem *menuitem
);
Add the given menu item to the projects tree tools menu.
|
a CodeSlayer. |
|
a GtkMenuItem. |
void codeslayer_remove_from_projects_popup (CodeSlayer *codeslayer
,GtkMenuItem *menuitem
);
Remove the given menu item from the projects tree tools menu.
|
a CodeSlayer. |
|
a GtkMenuItem. |
void codeslayer_add_to_project_properties (CodeSlayer *codeslayer
,GtkWidget *widget
,const gchar *title
);
Add the given widget to the project properties.
|
a CodeSlayer. |
|
a GtkWidget. |
|
the title for the tab. |
void codeslayer_remove_from_project_properties (CodeSlayer *codeslayer
,GtkWidget *widget
);
Remove the given widget to the project properties.
|
a CodeSlayer. |
|
a GtkWidget. |
GtkAccelGroup * codeslayer_get_menubar_accel_group (CodeSlayer *codeslayer
);
|
a CodeSlayer. |
Returns : |
The GtkAccelGroup associated with the menu. |
CodeSlayerGroup * codeslayer_get_active_group (CodeSlayer *codeslayer
);
|
a CodeSlayer. |
Returns : |
The CodeSlayerGroup that is currently opened. |
gchar * codeslayer_get_active_group_folder_path
(CodeSlayer *codeslayer
);
The folder path to where you should place project/group configuration files.
|
a CodeSlayer. |
Returns : |
a newly-allocated string that must be freed with g_free() . |
gchar * codeslayer_get_configuration_folder_path
(CodeSlayer *codeslayer
);
The folder path to where you should place plugin configuration files.
|
a CodeSlayer. |
Returns : |
a newly-allocated string that must be freed with g_free() . |
CodeSlayerProject * codeslayer_get_project_by_file_path (CodeSlayer *codeslayer
,const gchar *file_path
);
|
a CodeSlayer. |
|
the file path to match against the projects folder path. |
Returns : |
The CodeSlayerProject if found, otherwise NULL. |
CodeSlayerPreferences * codeslayer_get_preferences (CodeSlayer *codeslayer
);
|
a CodeSlayer. |
Returns : |
The CodeSlayerPreferences. |
GtkWindow * codeslayer_get_toplevel_window (CodeSlayer *codeslayer
);
|
a CodeSlayer. |
Returns : |
The outer most GtkWindow that codeslayer uses. |
gint codeslayer_add_to_process_bar (CodeSlayer *codeslayer
,gchar *name
,StopProcessFunc func
,gpointer data
);
|
a CodeSlayer. |
|
the name of the process. |
|
a StopProcessFunc is a callback to request that the process be stopped |
|
user data supplied to the StopProcessFunc |
Returns : |
The identifier for the process. |
void codeslayer_remove_from_process_bar (CodeSlayer *codeslayer
,gint id
);
CodeSlayerEditorLinker * codeslayer_get_editor_linker (CodeSlayer *codeslayer
,GtkTextView *text_view
);
|
a CodeSlayer. |
|
the text_view to create the links in. |
Returns : |
Creates a new CodeSlayerEditorLinker . You must free this with
g_object_unref() when done with it. |
"editor-added"
signalvoid user_function (CodeSlayer *codeslayer,
CodeSlayerEditor *editor,
gpointer user_data) : No Hooks
The ::editor-added signal is emitted when the editor is added to the notebook
|
the plugin that received the signal |
|
the CodeSlayerEditor that was added |
|
user data set when the signal handler was connected. |
"editor-removed"
signalvoid user_function (CodeSlayer *codeslayer,
CodeSlayerEditor *editor,
gpointer user_data) : No Hooks
The ::editor-removed signal is emitted when the editor is removed from the notebook
|
the plugin that received the signal |
|
the CodeSlayerEditor that was removed |
|
user data set when the signal handler was connected. |
"editor-saved"
signalvoid user_function (CodeSlayer *codeslayer,
CodeSlayerEditor *editor,
gpointer user_data) : No Hooks
The ::editor-saved signal is emitted when an editor is saved successfully
|
the plugin that received the signal |
|
the CodeSlayerEditor that was saved |
|
user data set when the signal handler was connected. |
"editor-switched"
signalvoid user_function (CodeSlayer *codeslayer,
CodeSlayerEditor *editor,
gpointer user_data) : No Hooks
The ::editor-switched signal is emitted when the active editor is switched in the notebook
|
the plugin that received the signal |
|
the CodeSlayerEditor switched to |
|
user data set when the signal handler was connected. |
"editors-all-saved"
signalvoid user_function (CodeSlayer *codeslayer,
gpointer editors,
gpointer user_data) : No Hooks
The ::editors-all-saved signal is emitted when all the editors have been saved successfully
|
the plugin that received the signal |
|
a GList of CodeSlayerEditor objects that were saved |
|
user data set when the signal handler was connected. |
"project-properties-opened"
signalvoid user_function (CodeSlayer *codeslayer,
CodeSlayerProject *project_properties,
gpointer user_data) : No Hooks
The ::project-properties-opened signal is emitted when the project properties window is opened
|
the plugin that received the signal |
|
the CodeSlayerProjectProperties switched to |
|
user data set when the signal handler was connected. |
"project-properties-saved"
signalvoid user_function (CodeSlayer *codeslayer,
CodeSlayerProject *project_properties,
gpointer user_data) : No Hooks
The ::project-properties-saved signal is emitted when the project properties window is closed
|
the plugin that received the signal |
|
the CodeSlayerProjectProperties switched to |
|
user data set when the signal handler was connected. |
"projects-changed"
signalvoid user_function (CodeSlayer *codeslayer,
gpointer user_data) : No Hooks
The ::projects_changed signal is invoked when the projects structure changed.
|
the plugin that received the signal |
|
user data set when the signal handler was connected. |