FileLoader

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_source_file_loader_get_type ()" ) ]
public sealed class FileLoader : Object

Load a file into a GtkSourceBuffer.

A `GtkSourceFileLoader` object permits to load the contents of a [iface@Gio.File] or a [class@Gio.InputStream] into a [class@Buffer].

A file loader should be used only for one load operation, including errors handling. If an error occurs, you can reconfigure the loader and relaunch the operation with [method@FileLoader.load_async].

Running a `GtkSourceFileLoader` is an undoable action for the [class@Buffer].

After a file loading, the buffer is reset to the contents provided by the [iface@Gio.File] or [class@Gio.InputStream], so the buffer is set as “unmodified”, that is, [method@Gtk.TextBuffer.set_modified] is called with false. If the contents isn't saved somewhere (for example if you load from stdin), then you should probably call [method@Gtk.TextBuffer.set_modified] with true after calling [method@FileLoader.load_finish].

Namespace: GtkSource

Package: gtksourceview-5

Content:

Properties:

public Buffer buffer { get; construct; }
The Buffer to load the contents into.
public File file { get; construct; }
The File.
public InputStream input_stream { get; construct; }
The InputStream to load.
public File location { get; construct; }
The File to load.

Creation methods:

public FileLoader (Buffer buffer, File file)
Creates a new `GtkSourceFileLoader` object.
public FileLoader.from_stream (Buffer buffer, File file, InputStream stream)
Creates a new FileLoader object.

Methods:

public unowned Buffer get_buffer ()
public CompressionType get_compression_type ()
public unowned Encoding get_encoding ()
public unowned File get_file ()
public unowned InputStream? get_input_stream ()
public unowned File? get_location ()
public NewlineType get_newline_type ()
public async bool load_async (int io_priority, Cancellable? cancellable, owned FileProgressCallback? progress_callback) throws Error
Loads asynchronously the file or input stream contents into the [ class@Buffer].
public void set_candidate_encodings (SList<Encoding> candidate_encodings)
Sets the candidate encodings for the file loading.

Inherited Members:

All known members inherited from class GLib.Object