na-iexporter
na-iexporter
|
|
Object Hierarchy
GInterface
+----NAIExporter
Prerequisites
NAIExporter requires
GObject.
Details
NA_IEXPORTER_TYPE
#define NA_IEXPORTER_TYPE ( na_iexporter_get_type())
NA_IEXPORTER_GET_INTERFACE()
#define NA_IEXPORTER_GET_INTERFACE( instance ) ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IEXPORTER_TYPE, NAIExporterInterface ))
NAIExporter
typedef struct NAIExporter NAIExporter;
NAIExporterFileParms
typedef struct NAIExporterFileParms NAIExporterFileParms;
NAIExporterBufferParms
typedef struct NAIExporterBufferParms NAIExporterBufferParms;
NAIExporterInterfacePrivate
typedef struct NAIExporterInterfacePrivate NAIExporterInterfacePrivate;
NAIExporterFormat
typedef struct {
gchar *format; /* format identifier (ascii) */
gchar *label; /* short label to be displayed in dialog (UTF-8 localized) */
gchar *description; /* full description of the format (UTF-8 localized)
* mainly used in the export assistant */
} NAIExporterFormat;
NAIExporterInterface
typedef struct {
GTypeInterface parent;
NAIExporterInterfacePrivate *private;
/**
* get_version:
* @instance: this #NAIExporter instance.
*
* Returns: the version of this interface supported by the I/O provider.
*
* Defaults to 1.
*/
guint ( *get_version )( const NAIExporter *instance );
/**
* get_name:
* @instance: this #NAIExporter instance.
*
* Returns: the name to be displayed for this instance, as a
* newly allocated string which should be g_free() by the caller.
*/
gchar * ( *get_name ) ( const NAIExporter *instance );
/**
* get_formats:
* @instance: this #NAIExporter instance.
*
* Returns: a list of #NAIExporterFormat structures which describe the
* formats supported by @instance.
*
* Defaults to %NULL (no format at all).
*
* The returned list is owned by the @instance. It must not be
* released by the caller.
*
* To avoid any collision, the format id is allocated by the
* Nautilus-Actions maintainer team. If you wish develop a new
* export format, and so need a new format id, please contact the
* maintainers (see #nautilus-actions.doap).
*/
const NAIExporterFormat * ( *get_formats )( const NAIExporter *instance );
/**
* to_file:
* @instance: this #NAIExporter instance.
* @parms: a #NAIExporterFileParms structure.
*
* Exports the specified 'exported' to the target 'folder' in the required
* 'format'.
*
* Returns: the status of the operation.
*/
guint ( *to_file ) ( const NAIExporter *instance, NAIExporterFileParms *parms );
/**
* to_buffer:
* @instance: this #NAIExporter instance.
* @parms: a #NAIExporterFileParms structure.
*
* Exports the specified 'exported' to a newly allocated 'buffer' in
* the required 'format'. The allocated 'buffer' should be g_free()
* by the caller.
*
* Returns: the status of the operation.
*/
guint ( *to_buffer ) ( const NAIExporter *instance, NAIExporterBufferParms *parms );
} NAIExporterInterface;