1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; coding: utf-8 -*- */
/*
* This file is part of GtkSourceView
*
* Copyright (C) 2005, 2007 - Paolo Maggi
* Copyrhing (C) 2007 - Steve Frécinaux
* Copyright (C) 2008 - Jesse van den Kieboom
* Copyright (C) 2014 - Sébastien Wilmet
*
* GtkSourceView is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* GtkSourceView is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
#ifndef GTK_SOURCE_FILE_SAVER_H
#define GTK_SOURCE_FILE_SAVER_H
#if !defined (GTK_SOURCE_H_INSIDE) && !defined (GTK_SOURCE_COMPILATION)
#error "Only <gtksourceview/gtksource.h> can be included directly."
#endif
#include <gtk/gtk.h>
#include <gtksourceview/gtksourcetypes.h>
#include <gtksourceview/gtksourcefile.h>
G_BEGIN_DECLS
#define GTK_SOURCE_TYPE_FILE_SAVER (gtk_source_file_saver_get_type())
#define GTK_SOURCE_FILE_SAVER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GTK_SOURCE_TYPE_FILE_SAVER, GtkSourceFileSaver))
#define GTK_SOURCE_FILE_SAVER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GTK_SOURCE_TYPE_FILE_SAVER, GtkSourceFileSaverClass))
#define GTK_SOURCE_IS_FILE_SAVER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GTK_SOURCE_TYPE_FILE_SAVER))
#define GTK_SOURCE_IS_FILE_SAVER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_SOURCE_TYPE_FILE_SAVER))
#define GTK_SOURCE_FILE_SAVER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_SOURCE_TYPE_FILE_SAVER, GtkSourceFileSaverClass))
typedef struct _GtkSourceFileSaverClass GtkSourceFileSaverClass;
typedef struct _GtkSourceFileSaverPrivate GtkSourceFileSaverPrivate;
#define GTK_SOURCE_FILE_SAVER_ERROR gtk_source_file_saver_error_quark ()
/**
* GtkSourceFileSaverError:
* @GTK_SOURCE_FILE_SAVER_ERROR_INVALID_CHARS: The buffer contains invalid
* characters.
* @GTK_SOURCE_FILE_SAVER_ERROR_EXTERNALLY_MODIFIED: The file is externally
* modified.
*
* An error code used with the %GTK_SOURCE_FILE_SAVER_ERROR domain.
* Since: 3.14
*/
typedef enum _GtkSourceFileSaverError
{
GTK_SOURCE_FILE_SAVER_ERROR_INVALID_CHARS,
GTK_SOURCE_FILE_SAVER_ERROR_EXTERNALLY_MODIFIED
} GtkSourceFileSaverError;
/**
* GtkSourceFileSaverFlags:
* @GTK_SOURCE_FILE_SAVER_FLAGS_NONE: No flags.
* @GTK_SOURCE_FILE_SAVER_FLAGS_IGNORE_INVALID_CHARS: Ignore invalid characters.
* @GTK_SOURCE_FILE_SAVER_FLAGS_IGNORE_MODIFICATION_TIME: Save file despite external modifications.
* @GTK_SOURCE_FILE_SAVER_FLAGS_CREATE_BACKUP: Create a backup before saving the file.
*
* Flags to define the behavior of a #GtkSourceFileSaver.
* Since: 3.14
*/
typedef enum _GtkSourceFileSaverFlags
{
GTK_SOURCE_FILE_SAVER_FLAGS_NONE = 0,
GTK_SOURCE_FILE_SAVER_FLAGS_IGNORE_INVALID_CHARS = 1 << 0,
GTK_SOURCE_FILE_SAVER_FLAGS_IGNORE_MODIFICATION_TIME = 1 << 1,
GTK_SOURCE_FILE_SAVER_FLAGS_CREATE_BACKUP = 1 << 2
} GtkSourceFileSaverFlags;
struct _GtkSourceFileSaver
{
GObject object;
GtkSourceFileSaverPrivate *priv;
};
struct _GtkSourceFileSaverClass
{
GObjectClass parent_class;
gpointer padding[10];
};
G_MODULE_EXPORT
GType gtk_source_file_saver_get_type (void) G_GNUC_CONST;
G_MODULE_EXPORT
GQuark gtk_source_file_saver_error_quark (void);
G_MODULE_EXPORT
GtkSourceFileSaver *gtk_source_file_saver_new (GtkSourceBuffer *buffer,
GtkSourceFile *file);
G_MODULE_EXPORT
GtkSourceFileSaver *gtk_source_file_saver_new_with_target (GtkSourceBuffer *buffer,
GtkSourceFile *file,
GFile *target_location);
G_MODULE_EXPORT
GtkSourceBuffer *gtk_source_file_saver_get_buffer (GtkSourceFileSaver *saver);
G_MODULE_EXPORT
GtkSourceFile *gtk_source_file_saver_get_file (GtkSourceFileSaver *saver);
G_MODULE_EXPORT
GFile *gtk_source_file_saver_get_location (GtkSourceFileSaver *saver);
G_MODULE_EXPORT
void gtk_source_file_saver_set_encoding (GtkSourceFileSaver *saver,
const GtkSourceEncoding *encoding);
G_MODULE_EXPORT
const GtkSourceEncoding *gtk_source_file_saver_get_encoding (GtkSourceFileSaver *saver);
G_MODULE_EXPORT
void gtk_source_file_saver_set_newline_type (GtkSourceFileSaver *saver,
GtkSourceNewlineType newline_type);
G_MODULE_EXPORT
GtkSourceNewlineType gtk_source_file_saver_get_newline_type (GtkSourceFileSaver *saver);
G_MODULE_EXPORT
void gtk_source_file_saver_set_compression_type
(GtkSourceFileSaver *saver,
GtkSourceCompressionType compression_type);
G_MODULE_EXPORT
GtkSourceCompressionType gtk_source_file_saver_get_compression_type
(GtkSourceFileSaver *saver);
G_MODULE_EXPORT
void gtk_source_file_saver_set_flags (GtkSourceFileSaver *saver,
GtkSourceFileSaverFlags flags);
G_MODULE_EXPORT
GtkSourceFileSaverFlags gtk_source_file_saver_get_flags (GtkSourceFileSaver *saver);
G_MODULE_EXPORT
void gtk_source_file_saver_save_async (GtkSourceFileSaver *saver,
gint io_priority,
GCancellable *cancellable,
GFileProgressCallback progress_callback,
gpointer progress_callback_data,
GDestroyNotify progress_callback_notify,
GAsyncReadyCallback callback,
gpointer user_data);
G_MODULE_EXPORT
gboolean gtk_source_file_saver_save_finish (GtkSourceFileSaver *saver,
GAsyncResult *result,
GError **error);
G_END_DECLS
#endif /* GTK_SOURCE_FILE_SAVER_H */
|