Top | ![]() |
![]() |
![]() |
![]() |
GtkSourceBuffer * | buffer | Read / Write / Construct Only |
GtkSourceCompressionType | compression-type | Read / Write / Construct |
TeplEncoding * | encoding | Read / Write / Construct |
TeplFile * | file | Read / Write / Construct Only |
TeplFileSaverFlags | flags | Read / Write / Construct |
GFile * | location | Read / Write / Construct Only |
GtkSourceNewlineType | newline-type | Read / Write / Construct |
TeplFileSaver | |
#define | TEPL_FILE_SAVER_ERROR |
enum | TeplFileSaverError |
enum | TeplFileSaverFlags |
GEnum ╰── TeplFileSaverError GFlags ╰── TeplFileSaverFlags GObject ╰── TeplFileSaver
A TeplFileSaver object permits to save a TeplBuffer into a GFile.
A file saver should be used only for one save operation, including errors
handling. If an error occurs, you can reconfigure the saver and relaunch the
operation with tepl_file_saver_save_async()
.
TeplFileSaver is a fork of GtkSourceFileSaver, the code has been a little improved (but no major changes). See the description of TeplFile for more background on why a fork was needed.
TeplFileSaver * tepl_file_saver_new (TeplBuffer *buffer
,TeplFile *file
);
Creates a new TeplFileSaver object. The buffer
will be saved to the
TeplFile's location.
This constructor is suitable for a simple "save" operation, when the file
already contains a non-NULL
“location”.
Since: 1.0
TeplFileSaver * tepl_file_saver_new_with_target (TeplBuffer *buffer
,TeplFile *file
,GFile *target_location
);
Creates a new TeplFileSaver object with a target location. When the
file saving is finished successfully, target_location
is set to the file
's
“location” property. If an error occurs, the previous valid
location is still available in TeplFile.
This constructor adds TEPL_FILE_SAVER_FLAGS_IGNORE_MODIFICATION_TIME
to the
“flags” property.
This constructor is suitable for a "save as" operation, or for saving a new buffer for the first time.
buffer |
the TeplBuffer to save. |
|
file |
the TeplFile. |
|
target_location |
the GFile where to save the buffer to. |
Since: 1.0
TeplBuffer *
tepl_file_saver_get_buffer (TeplFileSaver *saver
);
Since: 1.0
GFile *
tepl_file_saver_get_location (TeplFileSaver *saver
);
Since: 1.0
void tepl_file_saver_set_encoding (TeplFileSaver *saver
,const TeplEncoding *encoding
);
Sets the encoding. If encoding
is NULL
, the UTF-8 encoding will be set.
By default the encoding is taken from the TeplFile.
Since: 1.0
const TeplEncoding *
tepl_file_saver_get_encoding (TeplFileSaver *saver
);
Since: 1.0
void tepl_file_saver_set_newline_type (TeplFileSaver *saver
,TeplNewlineType newline_type
);
Sets the newline type. By default the newline type is taken from the TeplFile.
Since: 1.0
TeplNewlineType
tepl_file_saver_get_newline_type (TeplFileSaver *saver
);
Since: 1.0
void tepl_file_saver_set_compression_type (TeplFileSaver *saver
,TeplCompressionType compression_type
);
Sets the compression type. By default the compression type is taken from the TeplFile.
Since: 1.0
TeplCompressionType
tepl_file_saver_get_compression_type (TeplFileSaver *saver
);
Since: 1.0
void tepl_file_saver_set_flags (TeplFileSaver *saver
,TeplFileSaverFlags flags
);
Since: 1.0
TeplFileSaverFlags
tepl_file_saver_get_flags (TeplFileSaver *saver
);
Since: 1.0
void tepl_file_saver_save_async (TeplFileSaver *saver
,gint io_priority
,GCancellable *cancellable
,GFileProgressCallback progress_callback
,gpointer progress_callback_data
,GDestroyNotify progress_callback_notify
,GAsyncReadyCallback callback
,gpointer user_data
);
Saves asynchronously the buffer into the file. See the GAsyncResult documentation to know how to use this function.
saver |
||
io_priority |
the I/O priority of the request. E.g. |
|
cancellable |
optional GCancellable object, |
[nullable] |
progress_callback |
function to call back with
progress information, or |
[scope notified][nullable] |
progress_callback_data |
user data to pass to |
[closure] |
progress_callback_notify |
function to call on
|
[nullable] |
callback |
a GAsyncReadyCallback to call when the request is satisfied. |
[scope async] |
user_data |
user data to pass to |
Since: 1.0
gboolean tepl_file_saver_save_finish (TeplFileSaver *saver
,GAsyncResult *result
,GError **error
);
Finishes a file saving started with tepl_file_saver_save_async()
.
If the file has been saved successfully, the following TeplFile properties will be updated: the location, the encoding, the newline type and the compression type.
gtk_text_buffer_set_modified() is called with FALSE
if the file has been
saved successfully.
Since: 1.0
An error code used with the TEPL_FILE_SAVER_ERROR
domain.
Since: 1.0
“buffer”
property“buffer” GtkSourceBuffer *
The TeplBuffer to save. The TeplFileSaver object has a weak reference to the buffer.
Owner: TeplFileSaver
Flags: Read / Write / Construct Only
Since: 1.0
“compression-type”
property“compression-type” GtkSourceCompressionType
The compression type.
Owner: TeplFileSaver
Flags: Read / Write / Construct
Default value: GTK_SOURCE_COMPRESSION_TYPE_NONE
Since: 1.0
“encoding”
property“encoding” TeplEncoding *
The file's encoding.
Owner: TeplFileSaver
Flags: Read / Write / Construct
Since: 1.0
“file”
property“file” TeplFile *
The TeplFile. The TeplFileSaver object has a weak reference to the file.
Owner: TeplFileSaver
Flags: Read / Write / Construct Only
Since: 1.0
“flags”
property“flags” TeplFileSaverFlags
File saving flags.
Owner: TeplFileSaver
Flags: Read / Write / Construct
Since: 1.0
“location”
property“location” GFile *
The GFile where to save the buffer. By default the location is taken from the TeplFile at construction time.
Owner: TeplFileSaver
Flags: Read / Write / Construct Only
Since: 1.0
“newline-type”
property“newline-type” GtkSourceNewlineType
The newline type.
Owner: TeplFileSaver
Flags: Read / Write / Construct
Default value: GTK_SOURCE_NEWLINE_TYPE_LF
Since: 1.0