![]() |
![]() |
![]() |
CodeSlayer Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <codeslayer/codeslayer-document.h> struct CodeSlayerDocument; CodeSlayerDocument * codeslayer_document_new (void
); const gchar * codeslayer_document_get_name (CodeSlayerDocument *document
); const gchar * codeslayer_document_get_file_path (CodeSlayerDocument *document
); void codeslayer_document_set_file_path (CodeSlayerDocument *document
,const gchar *file_path
); const gint codeslayer_document_get_line_number (CodeSlayerDocument *document
); void codeslayer_document_set_line_number (CodeSlayerDocument *document
,const gint line_number
); CodeSlayerProject * codeslayer_document_get_project (CodeSlayerDocument *document
); void codeslayer_document_set_project (CodeSlayerDocument *document
,CodeSlayerProject *project
); GtkSourceView * codeslayer_document_get_source_view (CodeSlayerDocument *document
); void codeslayer_document_set_source_view (CodeSlayerDocument *document
,GtkSourceView *source_view
); GtkTreeRowReference * codeslayer_document_get_tree_row_reference (CodeSlayerDocument *document
); void codeslayer_document_set_tree_row_reference (CodeSlayerDocument *document
,GtkTreeRowReference *tree_row_reference
);
"file-path" gchar* : Read / Write "line-number" gint : Read / Write "name" gchar* : Read / Write "project" CodeSlayerProject* : Read / Write "source-view" CodeSlayerSourceView* : Read / Write "tree-row-reference" gpointer : Read / Write
The document represents the source file loaded into the source view. This
abstraction is very useful because you can create a document and then
pass it to the codeslayer_projects_select_document()
method.
This in turn selects the document in the projects tree and adds a page in
the notebook. It also automatically takes into account features like the
documents line number. This means that if you load a document that has
the line number specified it will load the document and the scroll to the
proper line in the source view.
CodeSlayerDocument * codeslayer_document_new (void
);
Creates a new CodeSlayerDocument.
Returns : |
a new CodeSlayerDocument. |
const gchar * codeslayer_document_get_name (CodeSlayerDocument *document
);
|
a CodeSlayerDocument. |
Returns : |
the name of the document. |
const gchar * codeslayer_document_get_file_path (CodeSlayerDocument *document
);
|
a CodeSlayerDocument. |
Returns : |
the fully qualified path to the document. |
void codeslayer_document_set_file_path (CodeSlayerDocument *document
,const gchar *file_path
);
Note: this is not a URI, but rather a normal file path.
|
a CodeSlayerDocument. |
|
the fully qualified path to the document. |
const gint codeslayer_document_get_line_number (CodeSlayerDocument *document
);
|
a CodeSlayerDocument. |
Returns : |
the line number to scroll to when loaded into the source view. |
void codeslayer_document_set_line_number (CodeSlayerDocument *document
,const gint line_number
);
|
a CodeSlayerDocument. |
|
the line number to scroll to when loaded into the source view. |
CodeSlayerProject * codeslayer_document_get_project (CodeSlayerDocument *document
);
|
a CodeSlayerDocument. |
Returns : |
the CodeSlayerProject that this document is a part of. |
void codeslayer_document_set_project (CodeSlayerDocument *document
,CodeSlayerProject *project
);
|
a CodeSlayerDocument. |
|
the CodeSlayerProject that this document is a part of. |
GtkSourceView * codeslayer_document_get_source_view (CodeSlayerDocument *document
);
|
a CodeSlayerDocument. |
Returns : |
the CodeSlayerSourceView that this document is attached to. |
void codeslayer_document_set_source_view (CodeSlayerDocument *document
,GtkSourceView *source_view
);
|
a CodeSlayerDocument. |
|
the CodeSlayerSourceView that this document is attached to. |
GtkTreeRowReference * codeslayer_document_get_tree_row_reference
(CodeSlayerDocument *document
);
|
a CodeSlayerDocument. |
Returns : |
the GtkTreeRowReference within the projects tree. |
void codeslayer_document_set_tree_row_reference (CodeSlayerDocument *document
,GtkTreeRowReference *tree_row_reference
);
|
a CodeSlayerDocument. |
|
a GtkTreeRowReference so the document can keep its position within the projects tree. |
"line-number"
property"line-number" gint : Read / Write
Line Number.
Allowed values: [0,100000]
Default value: 0