GimpConfigWriter

typedef struct _GimpConfigWriter GimpConfigWriter;

gimp_config_writer_new_file ()

GimpConfigWriter *  gimp_config_writer_new_file         (const gchar *filename,
                                                         gboolean atomic,
                                                         const gchar *header,
                                                         GError **error);

Creates a new GimpConfigWriter and sets it up to write to filename. If atomic is TRUE, a temporary file is used to avoid possible race conditions. The temporary file is then moved to filename when the writer is closed.

Since GIMP 2.4

gimp_config_writer_new_fd ()

GimpConfigWriter *  gimp_config_writer_new_fd           (gint fd);

Since GIMP 2.4

gimp_config_writer_new_string ()

GimpConfigWriter *  gimp_config_writer_new_string       (GString *string);

Since GIMP 2.4

gimp_config_writer_open ()

void                gimp_config_writer_open             (GimpConfigWriter *writer,
                                                         const gchar *name);

This function writes the opening parenthese followed by name. It also increases the indentation level and sets a mark that can be used by gimp_config_writer_revert().

Since GIMP 2.4

gimp_config_writer_comment_mode ()

void                gimp_config_writer_comment_mode     (GimpConfigWriter *writer,
                                                         gboolean enable);

This function toggles whether the writer should create commented or uncommented output. This feature is used to generate the system-wide installed gimprc that documents the default settings.

Since comments have to start at the beginning of a line, this funtion will insert a newline if necessary.

Since GIMP 2.4

gimp_config_writer_print ()

void                gimp_config_writer_print            (GimpConfigWriter *writer,
                                                         const gchar *string,
                                                         gint len);

Appends a space followed by string to the writer. Note that string must not contain any special characters that might need to be escaped.

Since GIMP 2.4

gimp_config_writer_printf ()

void                gimp_config_writer_printf           (GimpConfigWriter *writer,
                                                         const gchar *format,
                                                         ...);

A printf-like function for GimpConfigWriter.

Since GIMP 2.4

gimp_config_writer_identifier ()

void                gimp_config_writer_identifier       (GimpConfigWriter *writer,
                                                         const gchar *identifier);

Writes an identifier to writer. The string is *not* quoted and special characters are *not* escaped.

Since GIMP 2.4

gimp_config_writer_string ()

void                gimp_config_writer_string           (GimpConfigWriter *writer,
                                                         const gchar *string);

Writes a string value to writer. The string is quoted and special characters are escaped.

Since GIMP 2.4

gimp_config_writer_data ()

void                gimp_config_writer_data             (GimpConfigWriter *writer,
                                                         gint length,
                                                         const guint8 *data);

Since GIMP 2.4

gimp_config_writer_comment ()

void                gimp_config_writer_comment          (GimpConfigWriter *writer,
                                                         const gchar *comment);

Appends the comment to str and inserts linebreaks and hash-marks to format it as a comment. Note that this function does not handle non-ASCII characters.

Since GIMP 2.4

gimp_config_writer_linefeed ()

void                gimp_config_writer_linefeed         (GimpConfigWriter *writer);

gimp_config_writer_revert ()

void                gimp_config_writer_revert           (GimpConfigWriter *writer);

Reverts all changes to writer that were done since the last call to gimp_config_writer_open(). This can only work if you didn't call gimp_config_writer_close() yet.

Since GIMP 2.4

gimp_config_writer_close ()

void                gimp_config_writer_close            (GimpConfigWriter *writer);

Closes an element opened with gimp_config_writer_open().

Since GIMP 2.4

gimp_config_writer_finish ()

gboolean            gimp_config_writer_finish           (GimpConfigWriter *writer,
                                                         const gchar *footer,
                                                         GError **error);

This function finishes the work of writer and frees it afterwards. It closes all open elements, appends an optional comment and releases all resources allocated by writer. You must not access the writer afterwards.

Since GIMP 2.4