extension.h revision 0cd985e2a73949e7eb578c3f067efc93af73e48b
#ifndef __INK_EXTENSION_H__
#define __INK_EXTENSION_H__
/** \file
* Frontend to certain, possibly pluggable, actions.
*/
/*
* Authors:
* Ted Gould <ted@gould.cx>
*
* Copyright (C) 2002-2005 Authors
*
* Released under GNU GPL, read the file 'COPYING' for more information
*/
#include <ostream>
#include <fstream>
#include <vector>
#include "document.h"
#include "extension/extension-forward.h"
/** The key that is used to identify that the I/O should be autodetected */
#define SP_MODULE_KEY_AUTODETECT "autodetect"
/** This is the key for the SVG input module */
#define SP_MODULE_KEY_INPUT_SVG "org.inkscape.input.svg"
#define SP_MODULE_KEY_INPUT_SVGZ "org.inkscape.input.svgz"
/** Specifies the input module that should be used if none are selected */
/** The key for outputing standard W3C SVG */
#define SP_MODULE_KEY_OUTPUT_SVG "org.inkscape.output.svg.plain"
#define SP_MODULE_KEY_OUTPUT_SVGZ "org.inkscape.output.svgz.plain"
/** This is an output file that has SVG data with the Sodipodi namespace extensions */
#define SP_MODULE_KEY_OUTPUT_SVG_INKSCAPE "org.inkscape.output.svg.inkscape"
#define SP_MODULE_KEY_OUTPUT_SVGZ_INKSCAPE "org.inkscape.output.svgz.inkscape"
/** Which output module should be used? */
/** Defines the key for Postscript printing */
#define SP_MODULE_KEY_PRINT_PS "org.inkscape.print.ps"
/** Defines the key for PDF printing */
#define SP_MODULE_KEY_PRINT_PDF "org.inkscape.print.pdf"
#define SP_MODULE_KEY_PRINT_CAIRO_PDF "org.inkscape.print.pdf.cairo"
/** Defines the key for LaTeX printing */
#define SP_MODULE_KEY_PRINT_LATEX "org.inkscape.print.latex"
/** Defines the key for printing with GNOME Print */
#define SP_MODULE_KEY_PRINT_GNOME "org.inkscape.print.gnome"
/** Defines the key for printing under Win32 */
#define SP_MODULE_KEY_PRINT_WIN32 "org.inkscape.print.win32"
#ifdef WIN32
/** Defines the default printing to use */
#else
#ifdef WITH_GNOME_PRINT
/** Defines the default printing to use */
#else
/** Defines the default printing to use */
#endif
#endif
/** Mime type for SVG */
/** Name of the extension error file */
#define EXTENSION_ERROR_LOG_FILENAME "extension-errors.log"
/** The object that is the basis for the Extension system. This object
contains all of the information that all Extension have. The
individual items are detailed within. This is the interface that
those who want to _use_ the extensions system should use. This
is most likely to be those who are inside the Inkscape program. */
/** An enumeration to identify if the Extension has been loaded or not. */
typedef enum {
STATE_LOADED, /**< The extension has been loaded successfully */
STATE_UNLOADED, /**< The extension has not been loaded */
STATE_DEACTIVATED /**< The extension is missing something which makes it unusable */
} state_t;
Implementation::Implementation * imp; /**< An object that holds all the functions for making this work */
bool loaded (void);
/** \brief Gets the help string for this extension */
void deactivate (void);
bool deactivated (void);
/* Parameter Stuff */
This only gets created if there are parameters in this
extension */
/** An error class for when a parameter is called on a type it is not */
/** An error class for when a parameter is looked for that just
* simply doesn't exist */
class param_not_exist {};
/** An error class for when a filename already exists, but the user
* doesn't want to overwrite it */
class no_overwrite {};
#if 0
#endif
bool value,
int value,
float value,
/* Error file handling */
static void error_file_open (void);
static void error_file_close (void);
/* Extension editor dialog stuff */
inline static void add_val(Glib::ustring labelstr, Glib::ustring valuestr, Gtk::Table * table, int * row);
};
/*
This is a prototype for how collections should work. Whoever gets
around to implementing this gets to decide what a 'folder' and an
'item' really is. That is the joy of implementing it, eh?
class Collection : public Extension {
public:
folder get_root (void);
int get_count (folder);
thumbnail get_thumbnail(item);
item[] get_items(folder);
folder[] get_folders(folder);
metadata get_metadata(item);
image get_image(item);
};
*/
} /* namespace Extension */
} /* namespace Inkscape */
#endif /* __INK_EXTENSION_H__ */
/*
Local Variables:
mode:c++
c-file-style:"stroustrup"
c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
indent-tabs-mode:nil
fill-column:99
End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :