IAnjutaFileSavable

IAnjutaFileSavable — Implemented by plugins that can save files.

Stability Level

Unstable, unless otherwise indicated

Synopsis




#define     IANJUTA_FILE_SAVABLE_ERROR
            IAnjutaFileSavable;
            IAnjutaFileSavableIface;
GQuark      ianjuta_file_savable_error_quark
                                            (void);
gboolean    ianjuta_file_savable_is_dirty   (IAnjutaFileSavable *obj,
                                             GError **err);
void        ianjuta_file_savable_save       (IAnjutaFileSavable *obj,
                                             GError **err);
void        ianjuta_file_savable_save_as    (IAnjutaFileSavable *obj,
                                             const gchar *uri,
                                             GError **err);
void        ianjuta_file_savable_set_dirty  (IAnjutaFileSavable *obj,
                                             gboolean dirty,
                                             GError **err);

Object Hierarchy


  GInterface
   +----IAnjutaFileSavable

Prerequisites

IAnjutaFileSavable requires IAnjutaFile and GObject.

Description

Plugins implementing IAnjutaFile inteface that can also save files should also implement this interface.

Details

IANJUTA_FILE_SAVABLE_ERROR

#define IANJUTA_FILE_SAVABLE_ERROR ianjuta_file_savable_error_quark()


IAnjutaFileSavable

typedef struct _IAnjutaFileSavable IAnjutaFileSavable;


IAnjutaFileSavableIface

typedef struct {
	IAnjutaFileIface g_iface;
	
	/* Signal */
	void (*save_point) (IAnjutaFileSavable *obj, gboolean entered);
	/* Signal */
	void (*saved) (IAnjutaFileSavable *obj, const gchar *uri);

	gboolean (*is_dirty) (IAnjutaFileSavable *obj, GError **err);
	void (*save) (IAnjutaFileSavable *obj, GError **err);
	void (*save_as) (IAnjutaFileSavable *obj, const gchar *uri, GError **err);
	void (*set_dirty) (IAnjutaFileSavable *obj, gboolean dirty, GError **err);
} IAnjutaFileSavableIface;


ianjuta_file_savable_error_quark ()

GQuark      ianjuta_file_savable_error_quark
                                            (void);

Returns :


ianjuta_file_savable_is_dirty ()

gboolean    ianjuta_file_savable_is_dirty   (IAnjutaFileSavable *obj,
                                             GError **err);

Returns the dirty status of the content.

obj :

Self

err :

Error propagation and reporting

Returns :

TRUE if dirty, FALSE otherwise.

ianjuta_file_savable_save ()

void        ianjuta_file_savable_save       (IAnjutaFileSavable *obj,
                                             GError **err);

Saves the content to the original URI from which it was loaded.

obj :

Self

err :

Error propagation and reporting

ianjuta_file_savable_save_as ()

void        ianjuta_file_savable_save_as    (IAnjutaFileSavable *obj,
                                             const gchar *uri,
                                             GError **err);

Saves the content to a different URI.

obj :

Self

uri :

URI to save the content.

err :

Error propagation and reporting

ianjuta_file_savable_set_dirty ()

void        ianjuta_file_savable_set_dirty  (IAnjutaFileSavable *obj,
                                             gboolean dirty,
                                             GError **err);

if dirty is TRUE, sets dirty for the content. Save point will be left and the content will be considered not saved. Otherwise, content will considered saved and save-point will be entered.

obj :

Self

dirty :

err :

Error propagation and reporting

See Also

IAnjutaFile