IDE_TYPE_BUFFER_MANAGER

#define IDE_TYPE_BUFFER_MANAGER (ide_buffer_manager_get_type())

ide_buffer_manager_create_temporary_buffer ()

IdeBuffer *
ide_buffer_manager_create_temporary_buffer
                               (IdeBufferManager *self);

Creates a new IdeBuffer that does not yet have a backing file attached to it. Interfaces should perform a save-as operation to save the file to a real file.

ide_file_get_file() will return NULL to denote this type of buffer.

ide_buffer_manager_load_file_async ()

void
ide_buffer_manager_load_file_async (IdeBufferManager *self,
                                    IdeFile *file,
                                    gboolean force_reload,
                                    IdeProgress **progress,
                                    GCancellable *cancellable,
                                    GAsyncReadyCallback callback,
                                    gpointer user_data);

Asynchronously requests that the file represented by file is loaded. If the file is already loaded, the previously loaded version of the file will be returned, asynchronously.

Before loading the file, IdeBufferManager will check the file size to help protect itself from the user accidentally loading very large files. You can change the maximum size of file that will be loaded with the “max-file-size” property.

See ide_buffer_manager_load_file_finish() for how to complete this asynchronous request.

ide_buffer_manager_load_file_finish ()

IdeBuffer *
ide_buffer_manager_load_file_finish (IdeBufferManager *self,
                                     GAsyncResult *result,
                                     GError **error);

Completes an asynchronous request to load a file via ide_buffer_manager_load_file_async(). If the buffer was already loaded, this function will return a reference to the previous buffer with it's reference count incremented by one.

ide_buffer_manager_save_file_async ()

void
ide_buffer_manager_save_file_async (IdeBufferManager *self,
                                    IdeBuffer *buffer,
                                    IdeFile *file,
                                    IdeProgress **progress,
                                    GCancellable *cancellable,
                                    GAsyncReadyCallback callback,
                                    gpointer user_data);

This function asynchronously requests that a buffer be saved to the storage represented by file . buffer should be a previously loaded buffer owned by self , such as one loaded with ide_buffer_manager_load_file_async().

Call ide_buffer_manager_save_file_finish() to complete this asynchronous request.

ide_buffer_manager_save_file_finish ()

gboolean
ide_buffer_manager_save_file_finish (IdeBufferManager *self,
                                     GAsyncResult *result,
                                     GError **error);

This function completes an asynchronous request to save a buffer to storage using ide_buffer_manager_save_file_async(). Upon failure, FALSE is returned and error is set.

ide_buffer_manager_save_all_async ()

void
ide_buffer_manager_save_all_async (IdeBufferManager *self,
                                   GCancellable *cancellable,
                                   GAsyncReadyCallback callback,
                                   gpointer user_data);

ide_buffer_manager_save_all_finish ()

gboolean
ide_buffer_manager_save_all_finish (IdeBufferManager *self,
                                    GAsyncResult *result,
                                    GError **error);

ide_buffer_manager_get_focus_buffer ()

IdeBuffer *
ide_buffer_manager_get_focus_buffer (IdeBufferManager *self);

Gets the “focus-buffer” property. This the buffer behind the current selected view.

ide_buffer_manager_set_focus_buffer ()

void
ide_buffer_manager_set_focus_buffer (IdeBufferManager *self,
                                     IdeBuffer *buffer);

ide_buffer_manager_get_buffers ()

GPtrArray *
ide_buffer_manager_get_buffers (IdeBufferManager *self);

Returns a newly allocated GPtrArray of all the buffers managed by the IdeBufferManager instance.

Buffers are generally not added to the buffer list until they have been loaded.

ide_buffer_manager_get_word_completion ()

GtkSourceCompletionWords *
ide_buffer_manager_get_word_completion
                               (IdeBufferManager *self);

Gets the GtkSourceCompletionWords completion provider that will complete words using the loaded documents.

ide_buffer_manager_get_n_buffers ()

guint
ide_buffer_manager_get_n_buffers (IdeBufferManager *self);

ide_buffer_manager_has_file ()

gboolean
ide_buffer_manager_has_file (IdeBufferManager *self,
                             GFile *file);

Checks to see if the buffer manager has the file loaded.

ide_buffer_manager_find_buffer ()

IdeBuffer *
ide_buffer_manager_find_buffer (IdeBufferManager *self,
                                GFile *file);

Gets the buffer for a given file. If it has not yet been loaded, NULL is returned.

ide_buffer_manager_get_max_file_size ()

gsize
ide_buffer_manager_get_max_file_size (IdeBufferManager *self);

Gets the “max-file-size” property. This contains the maximum file size in bytes that a file may be to be loaded by the IdeBufferManager.

If zero, no size limits will be enforced.

ide_buffer_manager_set_max_file_size ()

void
ide_buffer_manager_set_max_file_size (IdeBufferManager *self,
                                      gsize max_file_size);

Sets the maximum file size in bytes, that will be loaded by the IdeBufferManager.

IdeBufferManager

typedef struct _IdeBufferManager IdeBufferManager;

The “auto-save” property

  “auto-save”                gboolean

If the documents should auto save after a configured timeout.

Flags: Read / Write

Default value: TRUE

The “auto-save-timeout” property

  “auto-save-timeout”        guint

The number of seconds after modification before auto saving.

Flags: Read / Write

Default value: 60

The “focus-buffer” property

  “focus-buffer”             IdeBuffer *

The currently focused buffer.

Flags: Read / Write

The “buffer-focus-enter” signal

void
user_function (IdeBufferManager *self,
               IdeBuffer        *buffer,
               gpointer          user_data)

This signal is emitted when a view for buffer has received focus. You might connect to this signal when you want to perform an operation while a buffer is in focus.

Flags: Run Last

The “buffer-focus-leave” signal

void
user_function (IdeBufferManager *self,
               IdeBuffer        *buffer,
               gpointer          user_data)

This signal is emitted when the focus has left the view containing buffer . You might connect to this signal to stop any work you were performing while the buffer was focused.

Flags: Run Last

The “buffer-loaded” signal

void
user_function (IdeBufferManager *self,
               IdeBuffer        *buffer,
               gpointer          user_data)

This signal is emitted when a buffer has been successfully loaded. You might connect to this signal to be notified when a buffer has completed loading.

Flags: Run Last

The “buffer-saved” signal

void
user_function (IdeBufferManager *self,
               IdeBuffer        *buffer,
               gpointer          user_data)

This signal is emitted when a buffer has finished saving to storage. You might connect to this signal if you want to know when the modifications have successfully been written to storage.

Flags: Run Last

The “create-buffer” signal

IdeBuffer*
user_function (IdeBufferManager *self,
               IdeFile          *file,
               gpointer          user_data)

This signal is emitted when there is a request to create a new buffer object. This allows subclasses of IdeBuffer to be instantiated by the buffer manager.

The first handler of this signal is responsible for returning an IdeBuffer or NULL, for which one will be created.

Flags: Run Last

The “load-buffer” signal

void
user_function (IdeBufferManager *self,
               IdeBuffer        *buffer,
               gpointer          user_data)

This signal is emitted when a request has been made to load a buffer from storage. You might connect to this signal to be notified when loading of a buffer has begun.

Flags: Run Last

The “save-buffer” signal

void
user_function (IdeBufferManager *self,
               IdeBuffer        *buffer,
               gpointer          user_data)

This signal is emitted when a request has been made to save a buffer. Connect to this signal if you'd like to perform mutation of the buffer before it is persisted to storage.

Flags: Run Last