Inkscape::Extension::Implementation::Implementation Class Reference

Base class for all implementations of modules. More...

#include <implementation.h>

Inheritance diagram for Inkscape::Extension::Implementation::Implementation:

Public Member Functions
	Implementation ()=default
virtual	~Implementation ()=default
virtual bool	load (Inkscape::Extension::Extension *)
virtual void	unload (Inkscape::Extension::Extension *)
virtual ImplementationDocumentCache *	newDocCache (Inkscape::Extension::Extension *, SPDesktop *)
	Create a new document cache object.
virtual bool	check (Inkscape::Extension::Extension *)
	Verify any dependencies.
virtual bool	cancelProcessing ()
virtual void	commitDocument ()
virtual std::unique_ptr< SPDocument >	new_from_template (Inkscape::Extension::Template *)
virtual void	get_template_presets (const Template *tmod, TemplatePresets &presets) const
virtual void	resize_to_template (Inkscape::Extension::Template *tmod, SPDocument *doc, SPPage *page)
virtual bool	match_template_size (Inkscape::Extension::Template *tmod, double width, double height)
virtual std::unique_ptr< SPDocument >	open (Inkscape::Extension::Input *module, char const *filename, bool is_importing)
	Open a file.
virtual void	save (Inkscape::Extension::Output *, SPDocument *, gchar const *)
	Find out information about the file.
virtual void	export_raster (Inkscape::Extension::Output *module, const SPDocument *doc, std::string const &png_file, gchar const *filename)
	Convert from PNG to raster format.
virtual Gtk::Widget *	prefs_effect (Inkscape::Extension::Effect *module, SPDesktop *desktop, sigc::signal< void()> *changeSignal, ImplementationDocumentCache *docCache)
	Find out information about the file.
virtual void	effect (Inkscape::Extension::Effect *, ExecutionEnv *, SPDesktop *, ImplementationDocumentCache *)
virtual void	effect (Inkscape::Extension::Effect *, ExecutionEnv *, SPDocument *document)
virtual bool	apply_filter (Inkscape::Extension::Effect *module, SPItem *item)
virtual unsigned	setup (Inkscape::Extension::Print *)
virtual unsigned	set_preview (Inkscape::Extension::Print *)
virtual unsigned	begin (Inkscape::Extension::Print *, SPDocument *)
virtual unsigned	finish (Inkscape::Extension::Print *)
virtual bool	textToPath (Inkscape::Extension::Print *)
	Tell the printing engine whether text should be text or path.
virtual bool	fontEmbedded (Inkscape::Extension::Print *)
	Get "fontEmbedded" param, i.e.
virtual unsigned	bind (Inkscape::Extension::Print *, Geom::Affine const &, float)
virtual unsigned	release (Inkscape::Extension::Print *)
virtual unsigned	fill (Inkscape::Extension::Print *, Geom::PathVector const &, Geom::Affine const &, SPStyle const *, Geom::OptRect const &, Geom::OptRect const &, Geom::OptRect const &)
virtual unsigned	stroke (Inkscape::Extension::Print *, Geom::PathVector const &, Geom::Affine const &, SPStyle const *, Geom::OptRect const &, Geom::OptRect const &, Geom::OptRect const &)
virtual unsigned	image (Inkscape::Extension::Print *, unsigned char *, unsigned int, unsigned int, unsigned int, Geom::Affine const &, SPStyle const *)
virtual unsigned	text (Inkscape::Extension::Print *, char const *, Geom::Point const &, SPStyle const *)
virtual void	processPath (Inkscape::XML::Node *)
virtual void	setDetachBase (bool detach)
	If detach = true, when saving to a file, don't store URIs relative to the filename.

Detailed Description

Base class for all implementations of modules.

This is whether they are done systematically by having something like the scripting system, or they are implemented internally they all derive from this class.

Definition at line 74 of file implementation.h.

Constructor & Destructor Documentation

Implementation()

Inkscape::Extension::Implementation::Implementation::Implementation ( )

default

~Implementation()

virtual Inkscape::Extension::Implementation::Implementation::~Implementation ( )

virtualdefault

Member Function Documentation

apply_filter()

virtual bool Inkscape::Extension::Implementation::Implementation::apply_filter ( Inkscape::Extension::Effect *  module, SPItem *  item  )

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::Filter::Filter.

Definition at line 146 of file implementation.h.

Referenced by Inkscape::Extension::Effect::apply_filter().

begin()

virtual unsigned Inkscape::Extension::Implementation::Implementation::begin ( Inkscape::Extension::Print *  , SPDocument *    )

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::PrintEmf, Inkscape::Extension::Internal::PrintLatex, and Inkscape::Extension::Internal::PrintWmf.

Definition at line 152 of file implementation.h.

bind()

virtual unsigned Inkscape::Extension::Implementation::Implementation::bind ( Inkscape::Extension::Print *  , Geom::Affine const &  , float    )

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::PrintLatex, and Inkscape::Extension::Internal::PrintMetafile.

Definition at line 175 of file implementation.h.

cancelProcessing()

virtual bool Inkscape::Extension::Implementation::Implementation::cancelProcessing ( )

inlinevirtual

Reimplemented in Inkscape::Extension::Implementation::Script.

Definition at line 100 of file implementation.h.

Referenced by Inkscape::Extension::ExecutionEnv::cancel().

check()

virtual bool Inkscape::Extension::Implementation::Implementation::check ( Inkscape::Extension::Extension *  )

inlinevirtual

Verify any dependencies.

Reimplemented in Inkscape::Extension::Implementation::Script, Inkscape::Extension::Implementation::XSLT, Inkscape::Extension::Internal::CairoPsOutput, Inkscape::Extension::Internal::CairoEpsOutput, Inkscape::Extension::Internal::CairoRendererPdfOutput, Inkscape::Extension::Internal::Emf, Inkscape::Extension::Internal::LatexOutput, Inkscape::Extension::Internal::OdfOutput, Inkscape::Extension::Internal::PngOutput, Inkscape::Extension::Internal::PovOutput, Inkscape::Extension::Internal::TemplateBase, Inkscape::Extension::Internal::TemplateFromFile, and Inkscape::Extension::Internal::Wmf.

Definition at line 98 of file implementation.h.

commitDocument()

virtual void Inkscape::Extension::Implementation::Implementation::commitDocument ( )

inlinevirtual

Definition at line 101 of file implementation.h.

Referenced by Inkscape::Extension::ExecutionEnv::commit().

effect() [1/2]

void Inkscape::Extension::Implementation::Implementation::effect ( Inkscape::Extension::Effect *  mod, ExecutionEnv *  executionEnv, SPDesktop *  desktop, ImplementationDocumentCache *    )

virtual

Reimplemented in Inkscape::Extension::Implementation::Script, Inkscape::Extension::Internal::Bitmap::ImageMagick, Inkscape::Extension::Internal::BlurEdge, Inkscape::Extension::Internal::Filter::Filter, and Inkscape::Extension::Internal::Grid.

Definition at line 58 of file implementation.cpp.

References desktop, effect(), and SPDesktop::getDocument().

Referenced by effect(), and Inkscape::Extension::ExecutionEnv::run().

effect() [2/2]

virtual void Inkscape::Extension::Implementation::Implementation::effect ( Inkscape::Extension::Effect *  , ExecutionEnv *  , SPDocument *  document  )

inlinevirtual

Reimplemented in Inkscape::Extension::Implementation::Script.

Definition at line 143 of file implementation.h.

export_raster()

virtual void Inkscape::Extension::Implementation::Implementation::export_raster ( Inkscape::Extension::Output *  module, const SPDocument *  doc, std::string const &  png_file, gchar const *  filename  )

inlinevirtual

Convert from PNG to raster format.

The function takes a PNG file and converts it into the specific format.

Parameters

png_file	Path to input file in PNG format. Value is in platform-native encoding (see Glib::filename_to_utf8).
filename	Path to output file. Value is in platform-native encoding (see Glib::filename_to_utf8).

Reimplemented in Inkscape::Extension::Implementation::Script, and Inkscape::Extension::Internal::PngOutput.

Definition at line 129 of file implementation.h.

fill()

virtual unsigned Inkscape::Extension::Implementation::Implementation::fill ( Inkscape::Extension::Print *  , Geom::PathVector const &  , Geom::Affine const &  , SPStyle const *  , Geom::OptRect const &  , Geom::OptRect const &  , Geom::OptRect const &    )

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::PrintEmf, Inkscape::Extension::Internal::PrintLatex, and Inkscape::Extension::Internal::PrintWmf.

Definition at line 179 of file implementation.h.

Referenced by Inkscape::Extension::Internal::Emf::output_style(), and Inkscape::Extension::Internal::Wmf::output_style().

finish()

virtual unsigned Inkscape::Extension::Implementation::Implementation::finish ( Inkscape::Extension::Print *  )

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::PrintEmf, Inkscape::Extension::Internal::PrintLatex, and Inkscape::Extension::Internal::PrintWmf.

Definition at line 154 of file implementation.h.

fontEmbedded()

virtual bool Inkscape::Extension::Implementation::Implementation::fontEmbedded ( Inkscape::Extension::Print *  )

inlinevirtual

Get "fontEmbedded" param, i.e.

tell the printing engine whether fonts should be embedded. Only available for Adobe Type 1 fonts in EPS output as of now

Return values

true	Fonts have to be embedded in the output so that the user might not need to install fonts to have the interpreter read the document correctly
false	Do not embed fonts

Definition at line 172 of file implementation.h.

get_template_presets()

virtual void Inkscape::Extension::Implementation::Implementation::get_template_presets ( const Template *  tmod, TemplatePresets &  presets  ) const

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::TemplateFromFile.

Definition at line 105 of file implementation.h.

image()

virtual unsigned Inkscape::Extension::Implementation::Implementation::image ( Inkscape::Extension::Print *  , unsigned char *  , unsigned int  , unsigned int  , unsigned int  , Geom::Affine const &  , SPStyle const *    )

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::PrintEmf, and Inkscape::Extension::Internal::PrintWmf.

Definition at line 193 of file implementation.h.

load()

virtual bool Inkscape::Extension::Implementation::Implementation::load ( Inkscape::Extension::Extension *  )

inlinevirtual

Reimplemented in Inkscape::Extension::Implementation::Script, Inkscape::Extension::Implementation::XSLT, Inkscape::Extension::Internal::Bitmap::ImageMagick, Inkscape::Extension::Internal::BlurEdge, Inkscape::Extension::Internal::Filter::Filter, Inkscape::Extension::Internal::GimpGrad, Inkscape::Extension::Internal::Grid, and Inkscape::Extension::Internal::Grid.

Definition at line 82 of file implementation.h.

match_template_size()

virtual bool Inkscape::Extension::Implementation::Implementation::match_template_size ( Inkscape::Extension::Template *  tmod, double  width, double  height  )

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::TemplateBase.

Definition at line 107 of file implementation.h.

new_from_template()

std::unique_ptr< SPDocument > Inkscape::Extension::Implementation::Implementation::new_from_template ( Inkscape::Extension::Template *  )

virtual

Reimplemented in Inkscape::Extension::Implementation::Script, Inkscape::Extension::Internal::TemplateBase, and Inkscape::Extension::Internal::TemplateFromFile.

Definition at line 28 of file implementation.cpp.

newDocCache()

virtual ImplementationDocumentCache * Inkscape::Extension::Implementation::Implementation::newDocCache ( Inkscape::Extension::Extension *  , SPDesktop *    )

inlinevirtual

Create a new document cache object.

This function just returns NULL. Subclasses are likely to reimplement it to do something useful.

Parameters

ext	The extension that is referencing us
doc	The document to create the cache of

Returns

A new document cache that is valid as long as the document is not changed.

Reimplemented in Inkscape::Extension::Internal::Bitmap::ImageMagick, and Inkscape::Extension::Internal::Filter::Filter.

Definition at line 95 of file implementation.h.

Referenced by Inkscape::Extension::ExecutionEnv::genDocCache().

open()

std::unique_ptr< SPDocument > Inkscape::Extension::Implementation::Implementation::open ( Inkscape::Extension::Input *  module, char const *  filename, bool  is_importing  )

virtual

Open a file.

Parameters

filename

File path. Value is in platform-native encoding (see Glib::filename_to_utf8).

Reimplemented in Inkscape::Extension::Internal::CdrInput, Inkscape::Extension::Internal::Emf, Inkscape::Extension::Internal::GdkpixbufInput, Inkscape::Extension::Internal::PdfInput, Inkscape::Extension::Internal::Svg, Inkscape::Extension::Internal::VsdInput, Inkscape::Extension::Internal::Wmf, Inkscape::Extension::Internal::WpgInput, Inkscape::Extension::Implementation::Script, Inkscape::Extension::Implementation::XSLT, and Inkscape::Extension::Internal::GimpGrad.

Definition at line 33 of file implementation.cpp.

prefs_effect()

Gtk::Widget * Inkscape::Extension::Implementation::Implementation::prefs_effect ( Inkscape::Extension::Effect *  module, SPDesktop *  desktop, sigc::signal< void()> *  changeSignal, ImplementationDocumentCache *  docCache  )

virtual

Find out information about the file.

Reimplemented in Inkscape::Extension::Internal::Bitmap::ImageMagick, Inkscape::Extension::Internal::BlurEdge, Inkscape::Extension::Internal::Grid, and Inkscape::Extension::Internal::Grid.

Definition at line 38 of file implementation.cpp.

References desktop, SPDesktop::doc(), SPObject::getRepr(), SPDesktop::getSelection(), item, Inkscape::ObjectSet::items(), and Inkscape::Extension::Extension::widget_visible_count().

Referenced by Inkscape::Extension::PrefDialog::PrefDialog().

processPath()

virtual void Inkscape::Extension::Implementation::Implementation::processPath ( Inkscape::XML::Node *  )

inlinevirtual

Definition at line 204 of file implementation.h.

release()

virtual unsigned Inkscape::Extension::Implementation::Implementation::release ( Inkscape::Extension::Print *  )

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::PrintLatex, and Inkscape::Extension::Internal::PrintMetafile.

Definition at line 178 of file implementation.h.

resize_to_template()

virtual void Inkscape::Extension::Implementation::Implementation::resize_to_template ( Inkscape::Extension::Template *  tmod, SPDocument *  doc, SPPage *  page  )

inlinevirtual

Reimplemented in Inkscape::Extension::Implementation::Script, and Inkscape::Extension::Internal::TemplateBase.

Definition at line 106 of file implementation.h.

save()

virtual void Inkscape::Extension::Implementation::Implementation::save ( Inkscape::Extension::Output *  , SPDocument *  , gchar const *    )

inlinevirtual

Find out information about the file.

Reimplemented in Inkscape::Extension::Internal::CairoPsOutput, Inkscape::Extension::Internal::CairoRendererPdfOutput, Inkscape::Extension::Internal::LatexOutput, Inkscape::Extension::Internal::PovOutput, Inkscape::Extension::Internal::CairoEpsOutput, and Inkscape::Extension::Implementation::Script.

Definition at line 118 of file implementation.h.

set_preview()

virtual unsigned Inkscape::Extension::Implementation::Implementation::set_preview ( Inkscape::Extension::Print *  )

inlinevirtual

Definition at line 150 of file implementation.h.

setDetachBase()

virtual void Inkscape::Extension::Implementation::Implementation::setDetachBase ( bool  detach )

inlinevirtual

If detach = true, when saving to a file, don't store URIs relative to the filename.

Reimplemented in Inkscape::Extension::Internal::Svg.

Definition at line 209 of file implementation.h.

setup()

virtual unsigned Inkscape::Extension::Implementation::Implementation::setup ( Inkscape::Extension::Print *  )

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::PrintEmf, Inkscape::Extension::Internal::PrintLatex, and Inkscape::Extension::Internal::PrintWmf.

Definition at line 149 of file implementation.h.

stroke()

virtual unsigned Inkscape::Extension::Implementation::Implementation::stroke ( Inkscape::Extension::Print *  , Geom::PathVector const &  , Geom::Affine const &  , SPStyle const *  , Geom::OptRect const &  , Geom::OptRect const &  , Geom::OptRect const &    )

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::PrintEmf, Inkscape::Extension::Internal::PrintLatex, and Inkscape::Extension::Internal::PrintWmf.

Definition at line 186 of file implementation.h.

Referenced by Inkscape::Extension::Internal::Filter::FeltFeather::get_filter_text(), Inkscape::Extension::Internal::Filter::InkBlot::get_filter_text(), Inkscape::Extension::Internal::Emf::output_style(), and Inkscape::Extension::Internal::Wmf::output_style().

text()

virtual unsigned Inkscape::Extension::Implementation::Implementation::text ( Inkscape::Extension::Print *  , char const *  , Geom::Point const &  , SPStyle const *    )

inlinevirtual

Reimplemented in Inkscape::Extension::Internal::PrintEmf, and Inkscape::Extension::Internal::PrintWmf.

Definition at line 200 of file implementation.h.

Referenced by Inkscape::Extension::Internal::PrintMetafile::center_ellipse_as_SVG_PathV(), Inkscape::Extension::Internal::PrintMetafile::center_elliptical_hole_as_SVG_PathV(), Inkscape::Extension::Internal::PrintMetafile::center_elliptical_ring_as_SVG_PathV(), and Inkscape::Extension::Internal::Wmf::myMetaFileProc().

textToPath()

virtual bool Inkscape::Extension::Implementation::Implementation::textToPath ( Inkscape::Extension::Print *  )

inlinevirtual

Tell the printing engine whether text should be text or path.

Default value is false because most printing engines will support paths more than they'll support text. (at least they do today)

Return values

true	Render the text as a path
false	Render text using the text function (above)

Reimplemented in Inkscape::Extension::Internal::CairoPsOutput, Inkscape::Extension::Internal::CairoEpsOutput, Inkscape::Extension::Internal::PrintLatex, and Inkscape::Extension::Internal::PrintMetafile.

Definition at line 163 of file implementation.h.

unload()

virtual void Inkscape::Extension::Implementation::Implementation::unload ( Inkscape::Extension::Extension *  )

inlinevirtual

Reimplemented in Inkscape::Extension::Implementation::Script, Inkscape::Extension::Implementation::XSLT, and Inkscape::Extension::Internal::GimpGrad.

Definition at line 84 of file implementation.h.

---

The documentation for this class was generated from the following files:

• /builds/inkscape/inkscape/src/extension/implementation/implementation.h
• /builds/inkscape/inkscape/src/extension/implementation/implementation.cpp