Top | ![]() |
![]() |
![]() |
![]() |
gboolean | busy | Read |
gboolean | changed-on-volume | Read |
IdeContext * | context | Read / Write / Construct Only |
gboolean | failed | Read |
IdeFile * | file | Read / Write |
gboolean | has-diagnostics | Read |
gboolean | highlight-diagnostics | Read / Write |
gboolean | read-only | Read |
gchar * | style-scheme-name | Read / Write |
gchar * | title | Read / Write |
void | change-settled | Run Last |
void | cursor-moved | Run Last |
void | destroy | Run Last |
void | line-flags-changed | Run Last |
void | loaded | Run Last |
void | saved | Run Last |
void | symbol-resolvers-loaded | Run Last |
#define | IDE_TYPE_BUFFER |
#define | IDE_BUFFER_LINE_FLAGS_DIAGNOSTICS_MASK |
enum | IdeBufferLineFlags |
struct | IdeBufferClass |
IdeBuffer |
GFlags ╰── IdeBufferLineFlags GObject ╰── GtkTextBuffer ╰── GtkSourceBuffer ╰── IdeBuffer
void ide_buffer_format_selection_async (IdeBuffer *self
,IdeFormatterOptions *options
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
gboolean ide_buffer_format_selection_finish (IdeBuffer *self
,GAsyncResult *result
,GError **error
);
gboolean
ide_buffer_get_busy (IdeBuffer *self
);
Gets the “busy” property. Return whether the buffer is performing background work or not.
gboolean
ide_buffer_get_changed_on_volume (IdeBuffer *self
);
Gets if the file backing the buffer has changed on the underlying storage.
Use ide_buffer_manager_load_file_async()
to reload the buffer.
GBytes *
ide_buffer_get_content (IdeBuffer *self
);
Gets the contents of the buffer as GBytes.
By using this function to get the bytes, you allow IdeBuffer to avoid calculating the buffer text unnecessarily, potentially saving on allocations.
Additionally, this allows the buffer to update the state in IdeUnsavedFiles if the content is out of sync.
IdeContext *
ide_buffer_get_context (IdeBuffer *self
);
Gets the “context” property. This is the IdeContext that owns the buffer.
IdeDiagnostic * ide_buffer_get_diagnostic_at_iter (IdeBuffer *self
,const GtkTextIter *iter
);
Gets the first diagnostic that overlaps the position
IdeFile *
ide_buffer_get_file (IdeBuffer *self
);
Gets the underlying file behind the buffer.
IdeBufferLineFlags ide_buffer_get_line_flags (IdeBuffer *self
,guint line
);
Return the flags set for the IdeBuffer line
number.
(diagnostics and errors messages, line changed or added, notes)
gboolean
ide_buffer_get_read_only (IdeBuffer *self
);
Gets the “read-only” property. This property indicate if the underlying file is read only or not.
gboolean
ide_buffer_get_highlight_diagnostics (IdeBuffer *self
);
Gets the “highlight-diagnostics” property. Return whether the diagnostic warnings and errors should be highlighted.
const gchar *
ide_buffer_get_style_scheme_name (IdeBuffer *self
);
Gets the “style-scheme-name” property. This property contains the current style scheme used by the buffer.
const gchar *
ide_buffer_get_title (IdeBuffer *self
);
Gets the “title” property. This property contains a title for the buffer suitable for display.
void ide_buffer_set_file (IdeBuffer *self
,IdeFile *file
);
Sets the underlying file to use when saving and loading self
to and from storage.
void ide_buffer_set_highlight_diagnostics (IdeBuffer *self
,gboolean highlight_diagnostics
);
Sets the “highlight-diagnostics” property. Sets whether the diagnostic warnings and errors should be highlighted.
void ide_buffer_set_spell_checking (IdeBuffer *self
,gboolean enable
);
void ide_buffer_set_style_scheme_name (IdeBuffer *self
,const gchar *style_scheme_name
);
Sets the “style-scheme-name” property. Sets the style scheme to be used by this buffer.
self |
an IdeBuffer. |
|
style_scheme_name |
A string containing the name of the style scheme to use. |
void
ide_buffer_trim_trailing_whitespace (IdeBuffer *self
);
Trim trailing whitespaces from the buffer.
void
ide_buffer_check_for_volume_change (IdeBuffer *self
);
Update the “read-only” property and the corresponding modification time (mtime).
IdeSourceLocation *
ide_buffer_get_insert_location (IdeBuffer *self
);
Gets the location of the insert mark as an IdeSourceLocation.
IdeSourceLocation * ide_buffer_get_iter_location (IdeBuffer *self
,const GtkTextIter *iter
);
Gets the location of the iter as an IdeSourceLocation.
void ide_buffer_get_iter_at_source_location (IdeBuffer *self
,GtkTextIter *iter
,IdeSourceLocation *location
);
Fill iter
with the position designated by location
.
void
ide_buffer_rehighlight (IdeBuffer *self
);
Force the IdeBuffer to rebuild the highlight.
void ide_buffer_get_selection_bounds (IdeBuffer *self
,GtkTextIter *insert
,GtkTextIter *selection
);
This function acts like gtk_text_buffer_get_selection_bounds()
except that it always
places the location of the insert mark at insert
and the location of the selection
mark at selection
.
Calling gtk_text_iter_order()
with the results of this function would be equivalent
to calling gtk_text_buffer_get_selection_bounds()
.
self |
an IdeBuffer. |
|
insert |
a GtkTextIter to get the insert position. |
[out] |
selection |
a GtkTextIter to get the selection position. |
[out] |
IdeRenameProvider *
ide_buffer_get_rename_provider (IdeBuffer *self
);
Gets the IdeRenameProvider for this buffer, or NULL
.
An IdeRenameProvider or NULL
if there
is no IdeRenameProvider that can statisfy the buffer.
[nullable][transfer none]
IdeExtensionSetAdapter *
ide_buffer_get_symbol_resolvers (IdeBuffer *self
);
Gets the symbol resolvers for the buffer based on the current language.
void ide_buffer_get_symbol_at_location_async (IdeBuffer *self
,const GtkTextIter *location
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously get a possible symbol at location
.
self |
an IdeBuffer. |
|
location |
a GtkTextIter indicating a position to search for a symbol. |
|
cancellable |
a GCancellable. |
|
callback |
a GAsyncReadyCallback. |
|
user_data |
a gpointer to hold user data. |
IdeSymbol * ide_buffer_get_symbol_at_location_finish (IdeBuffer *self
,GAsyncResult *result
,GError **error
);
Completes an asynchronous request to locate a symbol at a location.
gchar * ide_buffer_get_word_at_iter (IdeBuffer *self
,const GtkTextIter *iter
);
Gets the word found under the position denoted by iter
.
gboolean
ide_buffer_get_has_diagnostics (IdeBuffer *self
);
Gets the “has-diagnostics” property. Return whether the buffer contains diagnostic messages or not.
void ide_buffer_get_build_flags_async (IdeBuffer *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
gchar ** ide_buffer_get_build_flags_finish (IdeBuffer *self
,GAsyncResult *result
,GError **error
);
Completes a request to get the build flags for the buffer.
Since: 3.30
struct IdeBufferClass { GtkSourceBufferClass parent_class; void (*cursor_moved) (IdeBuffer *self, const GtkTextIter *location); };
“busy”
property “busy” gboolean
If the buffer is performing background work.
Flags: Read
Default value: FALSE
“changed-on-volume”
property “changed-on-volume” gboolean
If the file has changed on disk and the buffer is not in sync.
Flags: Read
Default value: FALSE
“context”
property“context” IdeContext *
The IdeContext for the buffer.
Flags: Read / Write / Construct Only
“failed”
property “failed” gboolean
The "failed" property is set to TRUE
if the buffer failed to load.
Flags: Read
Default value: FALSE
Since: 3.28
“has-diagnostics”
property “has-diagnostics” gboolean
If the buffer contains diagnostic messages.
Flags: Read
Default value: FALSE
“highlight-diagnostics”
property “highlight-diagnostics” gboolean
If diagnostic warnings and errors should be highlighted.
Flags: Read / Write
Default value: TRUE
“read-only”
property “read-only” gboolean
If the underlying file is read only.
Flags: Read
Default value: FALSE
“style-scheme-name”
property “style-scheme-name” gchar *
Style Scheme Name.
Flags: Read / Write
Default value: NULL
“change-settled”
signalvoid user_function (IdeBuffer *self, gpointer user_data)
This signal is emitted as short period of time after changes have occurred. It provides plugins a convenient way to wait for the editor to settle before performing expensive work.
You should probably use this instead of implementing your own settling management.
Flags: Run Last
Since: 3.26
“cursor-moved”
signalvoid user_function (IdeBuffer *self, GtkTextIter *location, gpointer user_data)
This signal is emitted when the insertion location has moved. You might want to attach to this signal to update the location of the insert mark in the display.
self |
An IdeBuffer. |
|
location |
a GtkTextIter. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“destroy”
signalvoid user_function (IdeBuffer *idebuffer, gpointer user_data)
This signal is emitted when the buffer should be destroyed, as the IdeBufferManager has reclaimed the buffer.
Flags: Run Last
“line-flags-changed”
signalvoid user_function (IdeBuffer *idebuffer, gpointer user_data)
This signal is emitted when the calculated line flags have changed. This occurs when diagnostics and line changes have been recalculated.
Flags: Run Last
“loaded”
signalvoid user_function (IdeBuffer *idebuffer, gpointer user_data)
This signal is emitted when the buffer manager has completed loading the file.
Flags: Run Last
“saved”
signalvoid user_function (IdeBuffer *idebuffer, gpointer user_data)
This signal is emitted when the buffer manager has completed saving the file.
Flags: Run Last
“symbol-resolvers-loaded”
signalvoid user_function (IdeBuffer *idebuffer, gpointer user_data)
Flags: Run Last