#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_syntax () const |
Determines whether bracket match highlighting is activated for the source buffer.controls the bracket match highlighting function in the buffer.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 the escaping character used by the source buffer highlighting engine.Sets the escape character to be used by the highlighting engine.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. | |
signals | |
Glib::SignalProxy2< void, Gtk::TextIter &, Gtk::TextIter & > | signal_highlight_updated () |
Emitted whenever there is a change in the buffer's ability to redo an operation.Emitted whenever there is a change in the buffer's ability to undo an operation.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, Gtk::TextIter & > | signal_marker_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_syntax | ( | ) | const |
Determines whether bracket match highlighting is activated for the source buffer.controls the bracket match highlighting function in the buffer.Determines whether text highlighting is activated in the source buffer.
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 |
int gtksourceview::SourceBuffer::get_max_undo_levels | ( | ) | const |
Determines the number of undo levels the buffer will track for buffer edits.
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. |
Glib::RefPtr<SourceLanguage> gtksourceview::SourceBuffer::get_language | ( | ) |
Determines the GtkSourceLanguage used by the buffer.
Glib::RefPtr<const SourceLanguage> gtksourceview::SourceBuffer::get_language | ( | ) | const |
Determines the GtkSourceLanguage used by the buffer.
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. |
bool gtksourceview::SourceBuffer::can_undo | ( | ) | const |
Determines the escaping character used by the source buffer highlighting engine.Sets the escape character to be used by the highlighting engine.Determines whether a source buffer can 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.
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.
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.
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.
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.
Glib::SignalProxy2< void,Gtk::TextIter &,Gtk::TextIter & > gtksourceview::SourceBuffer::signal_highlight_updated | ( | ) |
Emitted whenever there is a change in the buffer's ability to redo an operation.Emitted whenever there is a change in the buffer's ability to undo an operation.Emitted whenever the syntax highlighting information has been updated, so that views can request a redraw if the region changed is visible.
void on_my_highlight_updated(Gtk::TextIter & start, Gtk::TextIter & end)
Glib::SignalProxy1< void,Gtk::TextIter & > gtksourceview::SourceBuffer::signal_marker_updated | ( | ) |
Emitted whenever a marker of sourcebuffer has changed and needs to be redisplayed by the view.
void on_my_marker_updated(Gtk::TextIter & 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. |