#include <sourcebuffer.h>
Public Types | |
typedef SourceBuffer | CppObjectType |
typedef SourceBuffer_Class | CppClassType |
typedef GtkSourceBuffer | BaseObjectType |
typedef GtkSourceBufferClass | BaseClassType |
Public Member Functions | |
virtual | ~SourceBuffer () |
GtkSourceBuffer * | gobj () |
Provides access to the underlying C GObject. | |
const GtkSourceBuffer * | gobj () const |
Provides access to the underlying C GObject. | |
GtkSourceBuffer * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
bool | get_highlight_matching_brackets () const |
Determines whether bracket match highlighting is activated for the source buffer. | |
void | set_highlight_matching_brackets (bool highlight=true) |
controls the bracket match highlighting function in the buffer. | |
bool | get_highlight_syntax () const |
Determines whether text highlighting is activated in the source buffer. | |
void | set_highlight_syntax (bool highlight=true) |
controls whether text is highlighted in the buffer. | |
int | get_max_undo_levels () const |
Determines the number of undo levels the buffer will track for buffer edits. | |
void | set_max_undo_levels (int max_undo_levels) |
Sets the number of undo levels for user actions the buffer will track. | |
Glib::RefPtr< SourceLanguage > | get_language () |
Determines the GtkSourceLanguage used by the buffer. | |
Glib::RefPtr< const SourceLanguage > | get_language () const |
Determines the GtkSourceLanguage used by the buffer. | |
void | set_language (const Glib::RefPtr< SourceLanguage > &language) |
Sets the GtkSourceLanguage the source buffer will use. | |
bool | can_undo () const |
Determines whether a source buffer can undo the last action. | |
bool | can_redo () const |
Determines whether a source buffer can redo the last action. | |
void | undo () |
Undoes the last user action which modified the buffer. | |
void | redo () |
redoes the last undo operation. | |
void | begin_not_undoable_action () |
Marks the beginning of a not undoable action on the buffer, disabling the undo manager. | |
void | end_not_undoable_action () |
Marks the end of a not undoable action on the buffer. | |
bool | backward_iter_to_source_mark (Gtk::TextIter &iter, const Glib::ustring &category) |
Moves iter to the position of the previous GtkSourceMark of the given category. | |
bool | backward_iter_to_source_mark (Gtk::TextIter &iter) |
bool | forward_iter_to_source_mark (Gtk::TextIter &iter, const Glib::ustring &category) |
Moves iter to the position of the next SourceMark of the given category. | |
bool | forward_iter_to_source_mark (Gtk::TextIter &iter) |
Moves iter to the position of the next SourceMark. | |
void | ensure_highlight (const Gtk::TextIter &start, const Gtk::TextIter &end) |
Forces buffer to analyze and highlight the given area synchronously. | |
void | set_style_scheme (const Glib::RefPtr< SourceStyleScheme > &scheme) |
Sets style scheme used by the buffer. | |
Glib::RefPtr< SourceStyleScheme > | get_style_scheme () |
Returns the style scheme currently used by the buffer. | |
Glib::RefPtr< const SourceStyleScheme > | get_style_scheme () const |
Returns the style scheme currently used by the buffer. | |
Glib::RefPtr< SourceMark > | create_source_mark (const Glib::ustring &name, const Glib::ustring &category, const Gtk::TextIter &where) |
Creates a source mark in the buffer of category category. | |
Glib::SListHandle < Glib::RefPtr< SourceMark > > | get_source_marks_at_line (int line, const Glib::ustring &category) const |
Returns the list of marks of the given category at line. | |
Glib::SListHandle < Glib::RefPtr< SourceMark > > | get_source_marks_at_line (int line) const |
Returns all source marks marks at line. | |
Glib::SListHandle < Glib::RefPtr< SourceMark > > | get_source_marks_at_iter (Gtk::TextIter &iter, const Glib::ustring &category) const |
returns the list of marks of the given category at a given itertor. | |
Glib::SListHandle < Glib::RefPtr< SourceMark > > | get_source_marks_at_iter (Gtk::TextIter &iter) const |
returns all the marks at a given iterator. | |
void | remove_source_marks (const Gtk::TextIter &start, const Gtk::TextIter &end, const Glib::ustring &category) |
Remove all marks of a given category, from a given region of the. | |
signals | |
Glib::SignalProxy2< void, Gtk::TextIter &, Gtk::TextIter & > | signal_highlight_updated () |
Emitted whenever the syntax highlighting information has been updated, so that views can request a redraw if the region changed is visible. | |
Glib::SignalProxy1< void, const Glib::RefPtr< SourceMark > & > | signal_source_mark_updated () |
Emitted whenever a marker of sourcebuffer has changed and needs to be redisplayed by the view. | |
Static Public Member Functions | |
static GType | get_type () G_GNUC_CONST |
static GType | get_base_type () G_GNUC_CONST |
static Glib::RefPtr< SourceBuffer > | create (const Glib::RefPtr< Gtk::TextTagTable > &tagtable) |
create a new SourceBuffer, from a Gtk::TextTagTable. | |
static Glib::RefPtr< SourceBuffer > | create (const Glib::RefPtr< SourceLanguage > &language) |
Protected Member Functions | |
SourceBuffer (const Glib::ConstructParams &construct_params) | |
SourceBuffer (GtkSourceBuffer *castitem) | |
SourceBuffer () | |
SourceBuffer (const Glib::RefPtr< Gtk::TextTagTable > &tagtable) | |
SourceBuffer (const Glib::RefPtr< SourceLanguage > &language) | |
Friends | |
class | SourceBuffer_Class |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr < gtksourceview::SourceBuffer > | wrap (GtkSourceBuffer *object, bool take_copy=false) |
It extends the TextBuffer object by adding features necessary to display and edit source code: syntax highlighting, bracket matching and markers. It also implements support for undo/redo operations. To create a SourceBuffer use SourceBuffer::create(). By default highlighting is enabled, but you can disable it with SourceBuffer::set_highlight_syntax(). This can be useful if you're not using SourceLanguage objects to set the highlighting patterns, and instead you're manually adding SourceTag objects to the buffer's tag table.
typedef SourceBuffer_Class gtksourceview::SourceBuffer::CppClassType |
gtksourceview::SourceBuffer::SourceBuffer | ( | const Glib::ConstructParams & | construct_params | ) | [explicit, protected] |
gtksourceview::SourceBuffer::SourceBuffer | ( | GtkSourceBuffer * | castitem | ) | [explicit, protected] |
virtual gtksourceview::SourceBuffer::~SourceBuffer | ( | ) | [virtual] |
gtksourceview::SourceBuffer::SourceBuffer | ( | ) | [protected] |
gtksourceview::SourceBuffer::SourceBuffer | ( | const Glib::RefPtr< Gtk::TextTagTable > & | tagtable | ) | [explicit, protected] |
gtksourceview::SourceBuffer::SourceBuffer | ( | const Glib::RefPtr< SourceLanguage > & | language | ) | [explicit, protected] |
static GType gtksourceview::SourceBuffer::get_type | ( | ) | [static] |
static GType gtksourceview::SourceBuffer::get_base_type | ( | ) | [static] |
GtkSourceBuffer* gtksourceview::SourceBuffer::gobj | ( | ) | [inline] |
Provides access to the underlying C GObject.
const GtkSourceBuffer* gtksourceview::SourceBuffer::gobj | ( | ) | const [inline] |
Provides access to the underlying C GObject.
GtkSourceBuffer* gtksourceview::SourceBuffer::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
static Glib::RefPtr<SourceBuffer> gtksourceview::SourceBuffer::create | ( | const Glib::RefPtr< Gtk::TextTagTable > & | tagtable | ) | [static] |
create a new SourceBuffer, from a Gtk::TextTagTable.
tagtable | a tag table to be taken in account |
static Glib::RefPtr<SourceBuffer> gtksourceview::SourceBuffer::create | ( | const Glib::RefPtr< SourceLanguage > & | language | ) | [static] |
brief create a new SourceBuffer
language | the language to be considered by the SourceBuffer for syntax highlighting. |
bool gtksourceview::SourceBuffer::get_highlight_matching_brackets | ( | ) | const |
Determines whether bracket match highlighting is activated for the source buffer.
true
if the source buffer will highlight matching brackets.
void gtksourceview::SourceBuffer::set_highlight_matching_brackets | ( | bool | highlight = true |
) |
controls the bracket match highlighting function in the buffer.
If activated, when you position your cursor over a bracket character (a parenthesis, a square bracket, etc.) the matching opening or closing bracket character will be highlighted. You can specify the style with the SourceBuffer::set_bracket_match_style() function.
highlight | true if you want matching brackets highlighted. Controls the bracket match highlighting function in the buffer. If activated, when you position your cursor over a bracket character (a parenthesis, a square bracket, etc.) the matching opening or closing bracket character will be highlighted. You can specify the style with the gtk_source_buffer_set_bracket_match_style() function. | |
highlight | true if you want matching brackets highlighted. |
bool gtksourceview::SourceBuffer::get_highlight_syntax | ( | ) | const |
Determines whether text highlighting is activated in the source buffer.
true
if syntax highlighting is enabled, false
otherwise.
void gtksourceview::SourceBuffer::set_highlight_syntax | ( | bool | highlight = true |
) |
controls whether text is highlighted in the buffer.
If highlight is TRUE, the text will be highlighted according to the patterns installed in the buffer (either set with SourceBuffer::set_language() or by adding individual GtkSourceTag tags to the buffer's tag table). Otherwise, any current highlighted text will be restored to the default buffer style. Tags not of SourceTag type will not be removed by this option, and normal Gtk::TextTag priority settings apply when highlighting is enabled. If not using a SourceLanguage for setting the highlighting patterns in the buffer, it is recommended for performance reasons that you add all the SourceTag tags with highlighting disabled and enable it when finished.
highlight | true if you want to activate highlighting Controls whether syntax is highlighted in the buffer. If highlight is true , the text will be highlighted according to the syntax patterns specified in the language set with set_language(). If highlight is false , syntax highlighting is disabled and all the GtkTextTag objects that have been added by the syntax highlighting engine are removed from the buffer. | |
highlight | true to enable syntax highlighting, false to disable it. |
int gtksourceview::SourceBuffer::get_max_undo_levels | ( | ) | const |
Determines the number of undo levels the buffer will track for buffer edits.
The maximum number of possible undo levels or -1 if no limit is set.
void gtksourceview::SourceBuffer::set_max_undo_levels | ( | int | max_undo_levels | ) |
Sets the number of undo levels for user actions the buffer will track.
If the number of user actions exceeds the limit set by this function, older actions will be discarded. A new action is started whenever the function Gtk::TextBuffer::begin_user_action() is called. In general, this happens whenever the user presses any key which modifies the buffer, but the undo manager will try to merge similar consecutive actions, such as multiple character insertions into one action. But, inserting a newline does start a new action.
max_undo_levels | the desired maximum number of undo levels. Sets the number of undo levels for user actions the buffer will track. If the number of user actions exceeds the limit set by this function, older actions will be discarded. |
A new action is started whenever the function gtk_text_buffer_begin_user_action() is called. In general, this happens whenever the user presses any key which modifies the buffer, but the undo manager will try to merge similar consecutive actions, such as multiple character insertions into one action. But, inserting a newline does start a new action.
max_undo_levels | The desired maximum number of undo levels. |
Glib::RefPtr<SourceLanguage> gtksourceview::SourceBuffer::get_language | ( | ) |
Determines the GtkSourceLanguage used by the buffer.
0
.
Gtk::SourceLanguage associated with the buffer, or 0
.
Glib::RefPtr<const SourceLanguage> gtksourceview::SourceBuffer::get_language | ( | ) | const |
Determines the GtkSourceLanguage used by the buffer.
0
.
Gtk::SourceLanguage associated with the buffer, or 0
.
void gtksourceview::SourceBuffer::set_language | ( | const Glib::RefPtr< SourceLanguage > & | language | ) |
Sets the GtkSourceLanguage the source buffer will use.
This adds GtkSourceTag tags with the language's patterns and sets the escape character with SourceBuffer::set_escape_char(). Note that this will remove any SourceTag tags currently in the buffer's tag table. The buffer holds a reference to the language set.
language | a GtkSourceLanguage to set. Associate a Gtk::SourceLanguage with the source buffer. If language is not-0 and syntax highlighting is enabled (see set_highlight_syntax()), the syntax patterns defined in language will be used to highlight the text contained in the buffer. If language is 0 , the text contained in the buffer is not highlighted. |
language | A Gtk::SourceLanguage to set, or 0 . |
bool gtksourceview::SourceBuffer::can_undo | ( | ) | const |
Determines whether a source buffer can undo the last action.
true
if it's possible to undo the last action.
bool gtksourceview::SourceBuffer::can_redo | ( | ) | const |
Determines whether a source buffer can redo the last action.
I.E if the last operation was an undo.
true
if a redo is possible.
void gtksourceview::SourceBuffer::undo | ( | ) |
Undoes the last user action which modified the buffer.
Use SourceBuffer::can_undo() to check whether a call to this function will have any effect. Actions are defined as groups of operations between a call to TextBuffer::begin_user_action() and TextBuffer::end_user_action(), or sequences of similar edits (inserts or deletes) on the same line. Undoes the last user action which modified the buffer. Use can_undo() to check whether a call to this function will have any effect.
Actions are defined as groups of operations between a call to gtk_text_buffer_begin_user_action() and gtk_text_buffer_end_user_action(), or sequences of similar edits (inserts or deletes) on the same line.
void gtksourceview::SourceBuffer::redo | ( | ) |
redoes the last undo operation.
Use SourceBuffer::can_redo() to check whether a call to this function will have any effect. Redoes the last undo operation. Use can_redo() to check whether a call to this function will have any effect.
void gtksourceview::SourceBuffer::begin_not_undoable_action | ( | ) |
Marks the beginning of a not undoable action on the buffer, disabling the undo manager.
Typically you would call this function before initially setting the contents of the buffer (e.g. when loading a file in a text editor). You may nest SourceBuffer::begin_not_undoable_action() / SourceBuffer::end_not_undoable_action() blocks. Marks the beginning of a not undoable action on the buffer, disabling the undo manager. Typically you would call this function before initially setting the contents of the buffer (e.g. when loading a file in a text editor).
You may nest begin_not_undoable_action() / end_not_undoable_action() blocks.
void gtksourceview::SourceBuffer::end_not_undoable_action | ( | ) |
Marks the end of a not undoable action on the buffer.
When the last not undoable block is closed through the call to this function, the list of undo actions is cleared and the undo manager is re-enabled. Marks the end of a not undoable action on the buffer. When the last not undoable block is closed through the call to this function, the list of undo actions is cleared and the undo manager is re-enabled.
bool gtksourceview::SourceBuffer::backward_iter_to_source_mark | ( | Gtk::TextIter & | iter, | |
const Glib::ustring & | category | |||
) |
Moves iter to the position of the previous GtkSourceMark of the given category.
Returns true if iter was moved. If category is NULL, the previous source mark can be of any category.
iter | the iterator to consider. | |
category | the category to search for or NULL. |
bool gtksourceview::SourceBuffer::backward_iter_to_source_mark | ( | Gtk::TextIter & | iter | ) |
bool gtksourceview::SourceBuffer::forward_iter_to_source_mark | ( | Gtk::TextIter & | iter, | |
const Glib::ustring & | category | |||
) |
Moves iter to the position of the next SourceMark of the given category.
Returns true if iter was moved. If category is NULL, the next source mark can be of any category.
iter | the iterator to move. | |
category | the category to search for, or NULL. |
bool gtksourceview::SourceBuffer::forward_iter_to_source_mark | ( | Gtk::TextIter & | iter | ) |
Moves iter to the position of the next SourceMark.
Returns true if iter was moved. The category of the next SourceMark is considered to be NULL so that SourceMark can be of any category.
iter | the iterator to move. |
void gtksourceview::SourceBuffer::ensure_highlight | ( | const Gtk::TextIter & | start, | |
const Gtk::TextIter & | end | |||
) |
Forces buffer to analyze and highlight the given area synchronously.
start | start of the area to highlight. | |
end | end of the area to highlight. Forces buffer to analyze and highlight the given area synchronously. |
This is a potentially slow operation and should be used only when you need to make sure that some text not currently visible is highlighted, for instance before printing.
</note>
start | Start of the area to highlight. | |
end | End of the area to highlight. |
void gtksourceview::SourceBuffer::set_style_scheme | ( | const Glib::RefPtr< SourceStyleScheme > & | scheme | ) |
Sets style scheme used by the buffer.
scheme | the style scheme to be used by the buffer Sets style scheme used by the buffer. | |
scheme | Style scheme. |
Glib::RefPtr<SourceStyleScheme> gtksourceview::SourceBuffer::get_style_scheme | ( | ) |
Returns the style scheme currently used by the buffer.
The Gtk::SourceStyleScheme set by set_style_scheme(), or 0
.
Glib::RefPtr<const SourceStyleScheme> gtksourceview::SourceBuffer::get_style_scheme | ( | ) | const |
Returns the style scheme currently used by the buffer.
This method is const and returns a const value. Returns: the Gtk::SourceStyleScheme set by
0
. Glib::RefPtr<SourceMark> gtksourceview::SourceBuffer::create_source_mark | ( | const Glib::ustring & | name, | |
const Glib::ustring & | category, | |||
const Gtk::TextIter & | where | |||
) |
Creates a source mark in the buffer of category category.
A source mark is a Gtk::TextMark but organised into categories. Depending on the category a pixbuf can be specified that will be displayed along the line of the mark. Like a Gtk::TextMark, a SourceMark can be anonymous if the passed name is NULL.
Note that the buffer owns the marks.
Marks always have left gravity and are moved to the beginning of the line when the user deletes the line they were in. Typical uses for a source mark are bookmarks, breakpoints, current executing instruction indication in a source file, etc..
name | the name of the mark, can be "". | |
category | a string defining the mark category. | |
where | location where to place the mark. |
Glib::SListHandle<Glib::RefPtr<SourceMark> > gtksourceview::SourceBuffer::get_source_marks_at_line | ( | int | line, | |
const Glib::ustring & | category | |||
) | const |
Returns the list of marks of the given category at line.
If category is NULL, all marks at line are returned.
line | the line number to consider. | |
category | category to search for or NULL. | |
a | newly allocated GSList. |
Glib::SListHandle<Glib::RefPtr<SourceMark> > gtksourceview::SourceBuffer::get_source_marks_at_line | ( | int | line | ) | const |
Returns all source marks marks at line.
line | the line number to consider. | |
a | newly allocated GSList. |
Glib::SListHandle<Glib::RefPtr<SourceMark> > gtksourceview::SourceBuffer::get_source_marks_at_iter | ( | Gtk::TextIter & | iter, | |
const Glib::ustring & | category | |||
) | const |
returns the list of marks of the given category at a given itertor.
If category is NULL it returns all marks at iter.
iter | the iterator to consider. | |
category | the category to search for, or NULL. |
Glib::SListHandle<Glib::RefPtr<SourceMark> > gtksourceview::SourceBuffer::get_source_marks_at_iter | ( | Gtk::TextIter & | iter | ) | const |
returns all the marks at a given iterator.
iter | the iterator to consider. |
void gtksourceview::SourceBuffer::remove_source_marks | ( | const Gtk::TextIter & | start, | |
const Gtk::TextIter & | end, | |||
const Glib::ustring & | category | |||
) |
Remove all marks of a given category, from a given region of the.
buffer
If category is NULL, all marks in the range will be removed.
start | the begining of the region to consider | |
end | the end of the region to consider. | |
category | the category of the marks to consider. |
Glib::SignalProxy2< void,Gtk::TextIter&,Gtk::TextIter& > gtksourceview::SourceBuffer::signal_highlight_updated | ( | ) |
Emitted whenever the syntax highlighting information has been updated, so that views can request a redraw if the region changed is visible.
Usually only view widgets displaying this buffer will be interested in this signal. parameter start: an iterator at the start of the updated region. parameter end: and iterator at the end of the updated region.
void on_my_highlight_updated(Gtk::TextIter& start, Gtk::TextIter& end)
Glib::SignalProxy1< void,const Glib::RefPtr<SourceMark>& > gtksourceview::SourceBuffer::signal_source_mark_updated | ( | ) |
Emitted whenever a marker of sourcebuffer has changed and needs to be redisplayed by the view.
A change in a marker's type or location can trigger this signal. Note that moving a marker causes the emission of this signal twice: one for the old location and one for the new. parameter where: an iterator at the location where the change occurred.
void on_my_source_mark_updated(const Glib::RefPtr<SourceMark>& where)
friend class SourceBuffer_Class [friend] |
Glib::RefPtr< gtksourceview::SourceBuffer > wrap | ( | GtkSourceBuffer * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
object | The C instance. | |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |