gedit-document-saver.h 3.78 KB
Newer Older
Paolo Borelli's avatar
Paolo Borelli committed
1 2 3 4
/*
 * gedit-document-saver.h
 * This file is part of gedit
 *
5 6
 * Copyright (C) 2005 - Paolo Maggi
 * Copyrhing (C) 2007 - Paolo Maggi, Steve Frécinaux
7
 * Copyright (C) 2008 - Jesse van den Kieboom
Paolo Borelli's avatar
Paolo Borelli committed
8 9 10 11 12 13 14 15 16 17 18 19
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
20
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
Paolo Borelli's avatar
Paolo Borelli committed
21
 */
22

Paolo Borelli's avatar
Paolo Borelli committed
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
#ifndef __GEDIT_DOCUMENT_SAVER_H__
#define __GEDIT_DOCUMENT_SAVER_H__

#include <gedit/gedit-document.h>

G_BEGIN_DECLS

/*
 * Type checking and casting macros
 */
#define GEDIT_TYPE_DOCUMENT_SAVER              (gedit_document_saver_get_type())
#define GEDIT_DOCUMENT_SAVER(obj)              (G_TYPE_CHECK_INSTANCE_CAST((obj), GEDIT_TYPE_DOCUMENT_SAVER, GeditDocumentSaver))
#define GEDIT_DOCUMENT_SAVER_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), GEDIT_TYPE_DOCUMENT_SAVER, GeditDocumentSaverClass))
#define GEDIT_IS_DOCUMENT_SAVER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE((obj), GEDIT_TYPE_DOCUMENT_SAVER))
#define GEDIT_IS_DOCUMENT_SAVER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GEDIT_TYPE_DOCUMENT_SAVER))
#define GEDIT_DOCUMENT_SAVER_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS((obj), GEDIT_TYPE_DOCUMENT_SAVER, GeditDocumentSaverClass))

40 41 42
/* Private structure type */
typedef struct _GeditDocumentSaverPrivate GeditDocumentSaverPrivate;

Paolo Borelli's avatar
Paolo Borelli committed
43 44 45 46 47
/*
 * Main object structure
 */
typedef struct _GeditDocumentSaver GeditDocumentSaver;

48
struct _GeditDocumentSaver
Paolo Borelli's avatar
Paolo Borelli committed
49 50 51
{
	GObject object;

52
	/*< private >*/
53
	GeditDocumentSaverPrivate *priv;
Paolo Borelli's avatar
Paolo Borelli committed
54 55 56 57 58 59 60
};

/*
 * Class definition
 */
typedef struct _GeditDocumentSaverClass GeditDocumentSaverClass;

61
struct _GeditDocumentSaverClass
Paolo Borelli's avatar
Paolo Borelli committed
62 63 64
{
	GObjectClass parent_class;

65
	/* Signals */
66
	void (* saving) (GeditDocumentSaver  *saver,
Paolo Borelli's avatar
Paolo Borelli committed
67 68 69 70 71 72 73 74 75 76
			 gboolean             completed,
			 const GError        *error);
};

/*
 * Public methods
 */
GType 		 	 gedit_document_saver_get_type		(void) G_GNUC_CONST;

/* If enconding == NULL, the encoding will be autodetected */
77 78 79 80 81 82
GeditDocumentSaver 	*gedit_document_saver_new 		(GeditDocument                *doc,
								 GFile                        *location,
								 const GeditEncoding          *encoding,
								 GeditDocumentNewlineType      newline_type,
								 GeditDocumentCompressionType  compression_type,
								 GeditDocumentSaveFlags        flags);
Paolo Borelli's avatar
Paolo Borelli committed
83

Garrett Regier's avatar
Garrett Regier committed
84 85 86
void			 gedit_document_saver_saving		(GeditDocumentSaver  *saver,
								 gboolean             completed,
								 GError              *error);
87
void			 gedit_document_saver_save		(GeditDocumentSaver  *saver,
88
								 GTimeVal            *old_mtime);
89

Paolo Borelli's avatar
Paolo Borelli committed
90 91 92 93
#if 0
void			 gedit_document_saver_cancel		(GeditDocumentSaver  *saver);
#endif

94 95
GeditDocument		*gedit_document_saver_get_document	(GeditDocumentSaver  *saver);

96
GFile			*gedit_document_saver_get_location	(GeditDocumentSaver  *saver);
Paolo Borelli's avatar
Paolo Borelli committed
97 98 99 100 101 102 103

/* If backup_uri is NULL no backup will be made */
const gchar		*gedit_document_saver_get_backup_uri	(GeditDocumentSaver  *saver);
void			*gedit_document_saver_set_backup_uri	(GeditDocumentSaver  *saver,
							 	 const gchar         *backup_uri);

/* Returns 0 if file size is unknown */
Paolo Borelli's avatar
Paolo Borelli committed
104
goffset			 gedit_document_saver_get_file_size	(GeditDocumentSaver  *saver);
Paolo Borelli's avatar
Paolo Borelli committed
105

Paolo Borelli's avatar
Paolo Borelli committed
106
goffset			 gedit_document_saver_get_bytes_written	(GeditDocumentSaver  *saver);
Paolo Borelli's avatar
Paolo Borelli committed
107

108 109
GFileInfo		*gedit_document_saver_get_info		(GeditDocumentSaver  *saver);

Paolo Borelli's avatar
Paolo Borelli committed
110 111 112
G_END_DECLS

#endif  /* __GEDIT_DOCUMENT_SAVER_H__  */
113
/* ex:set ts=8 noet: */