Inkscape
Vector Graphics Editor
Inkscape::Extension::Implementation::Implementation Class Reference

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

#include <implementation.h>

Inheritance diagram for Inkscape::Extension::Implementation::Implementation:
Inkscape::Extension::Implementation::Script Inkscape::Extension::Implementation::XSLT Inkscape::Extension::Internal::Bitmap::ImageMagick Inkscape::Extension::Internal::BlurEdge Inkscape::Extension::Internal::CairoEpsOutput Inkscape::Extension::Internal::CairoPsOutput Inkscape::Extension::Internal::CairoRendererPdfOutput Inkscape::Extension::Internal::CdrInput Inkscape::Extension::Internal::Filter::Filter Inkscape::Extension::Internal::GdkpixbufInput Inkscape::Extension::Internal::GimpGrad Inkscape::Extension::Internal::Grid Inkscape::Extension::Internal::LatexOutput Inkscape::Extension::Internal::Metafile Inkscape::Extension::Internal::OdfOutput Inkscape::Extension::Internal::PdfInput Inkscape::Extension::Internal::PngOutput Inkscape::Extension::Internal::PovOutput Inkscape::Extension::Internal::PrintLatex Inkscape::Extension::Internal::PrintMetafile Inkscape::Extension::Internal::Svg Inkscape::Extension::Internal::VsdInput Inkscape::Extension::Internal::WpgInput

Public Member Functions

 Implementation ()=default
 
virtual ~Implementation ()=default
 
virtual bool load (Inkscape::Extension::Extension *)
 
virtual void unload (Inkscape::Extension::Extension *)
 
virtual ImplementationDocumentCachenewDocCache (Inkscape::Extension::Extension *, Inkscape::UI::View::View *)
 Create a new document cache object. More...
 
virtual bool check (Inkscape::Extension::Extension *)
 Verify any dependencies. More...
 
virtual bool cancelProcessing ()
 
virtual void commitDocument ()
 
virtual Gtk::Widget * prefs_input (Inkscape::Extension::Input *module, gchar const *filename)
 Find out information about the file. More...
 
virtual SPDocumentopen (Inkscape::Extension::Input *, gchar const *)
 
virtual Gtk::Widget * prefs_output (Inkscape::Extension::Output *module)
 Find out information about the file. More...
 
virtual void save (Inkscape::Extension::Output *, SPDocument *, gchar const *)
 
virtual void export_raster (Inkscape::Extension::Output *, const SPDocument *, std::string const &, gchar const *)
 
virtual Gtk::Widget * prefs_effect (Inkscape::Extension::Effect *module, Inkscape::UI::View::View *view, sigc::signal< void > *changeSignal, ImplementationDocumentCache *docCache)
 Find out information about the file. More...
 
virtual void effect (Inkscape::Extension::Effect *, Inkscape::UI::View::View *, ImplementationDocumentCache *)
 
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. More...
 
virtual bool fontEmbedded (Inkscape::Extension::Print *)
 Get "fontEmbedded" param, i.e. More...
 
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. More...
 

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 71 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

◆ begin()

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

◆ bind()

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

◆ cancelProcessing()

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

◆ check()

◆ commitDocument()

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

Definition at line 98 of file implementation.h.

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

◆ effect()

◆ export_raster()

virtual void Inkscape::Extension::Implementation::Implementation::export_raster ( Inkscape::Extension::Output ,
const SPDocument ,
std::string const &  ,
gchar const *   
)
inlinevirtual

◆ 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

◆ finish()

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

◆ 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
trueFonts 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
falseDo not embed fonts

Definition at line 152 of file implementation.h.

Referenced by Inkscape::Extension::Print::fontEmbedded().

◆ 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 173 of file implementation.h.

Referenced by Inkscape::Extension::Internal::Bitmap::Despeckle::applyEffect(), Inkscape::Extension::Internal::Bitmap::Negate::applyEffect(), Inkscape::Extension::Internal::Bitmap::Normalize::applyEffect(), Inkscape::Extension::Internal::Bitmap::Enhance::applyEffect(), Inkscape::Extension::Internal::Bitmap::Equalize::applyEffect(), Inkscape::Extension::Internal::Bitmap::CycleColormap::applyEffect(), Inkscape::Extension::Internal::Bitmap::Edge::applyEffect(), Inkscape::Extension::Internal::Bitmap::Implode::applyEffect(), Inkscape::Extension::Internal::Bitmap::Spread::applyEffect(), Inkscape::Extension::Internal::Bitmap::Swirl::applyEffect(), Inkscape::Extension::Internal::Bitmap::Threshold::applyEffect(), Inkscape::Extension::Internal::Bitmap::MedianFilter::applyEffect(), Inkscape::Extension::Internal::Bitmap::AddNoise::applyEffect(), Inkscape::Extension::Internal::Bitmap::Contrast::applyEffect(), Inkscape::Extension::Internal::Bitmap::OilPaint::applyEffect(), Inkscape::Extension::Internal::Bitmap::Opacity::applyEffect(), Inkscape::Extension::Internal::Bitmap::ReduceNoise::applyEffect(), Inkscape::Extension::Internal::Bitmap::Solarize::applyEffect(), Inkscape::Extension::Internal::Bitmap::GaussianBlur::applyEffect(), Inkscape::Extension::Internal::Bitmap::Wave::applyEffect(), Inkscape::Extension::Internal::Bitmap::Emboss::applyEffect(), Inkscape::Extension::Internal::Bitmap::Charcoal::applyEffect(), Inkscape::Extension::Internal::Bitmap::Sample::applyEffect(), Inkscape::Extension::Internal::Bitmap::Sharpen::applyEffect(), Inkscape::Extension::Internal::Bitmap::Channel::applyEffect(), Inkscape::Extension::Internal::Bitmap::Blur::applyEffect(), Inkscape::Extension::Internal::Bitmap::Shade::applyEffect(), Inkscape::Extension::Internal::Bitmap::AdaptiveThreshold::applyEffect(), Inkscape::Extension::Internal::Bitmap::Raise::applyEffect(), Inkscape::Extension::Internal::Bitmap::Level::applyEffect(), Inkscape::Extension::Internal::Bitmap::Colorize::applyEffect(), Inkscape::Extension::Internal::Bitmap::Modulate::applyEffect(), Inkscape::Extension::Internal::Bitmap::Unsharpmask::applyEffect(), Inkscape::Extension::Internal::Bitmap::LevelChannel::applyEffect(), Inkscape::Extension::Internal::Bitmap::Crop::applyEffect(), Inkscape::Extension::Print::image(), and Inkscape::Extension::Internal::Bitmap::Crop::postEffect().

◆ load()

◆ newDocCache()

virtual ImplementationDocumentCache* Inkscape::Extension::Implementation::Implementation::newDocCache ( Inkscape::Extension::Extension ,
Inkscape::UI::View::View  
)
inlinevirtual

Create a new document cache object.

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

Parameters
extThe extension that is referencing us
docThe 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::Implementation::Script, Inkscape::Extension::Internal::Filter::Filter, and Inkscape::Extension::Internal::Bitmap::ImageMagick.

Definition at line 92 of file implementation.h.

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

◆ open()

◆ prefs_effect()

◆ prefs_input()

Gtk::Widget * Inkscape::Extension::Implementation::Implementation::prefs_input ( Inkscape::Extension::Input module,
gchar const *  filename 
)
virtual

Find out information about the file.

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

Definition at line 29 of file implementation.cpp.

References Inkscape::Extension::Extension::autogui().

Referenced by Inkscape::Extension::Input::prefs().

◆ prefs_output()

Gtk::Widget * Inkscape::Extension::Implementation::Implementation::prefs_output ( Inkscape::Extension::Output module)
virtual

Find out information about the file.

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

Definition at line 34 of file implementation.cpp.

References Inkscape::Extension::Extension::autogui().

Referenced by Inkscape::Extension::Output::prefs().

◆ processPath()

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

Definition at line 184 of file implementation.h.

◆ release()

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

◆ save()

◆ set_preview()

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

Definition at line 130 of file implementation.h.

Referenced by Inkscape::Extension::Print::set_preview().

◆ 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 189 of file implementation.h.

Referenced by Inkscape::Extension::Output::export_raster(), and Inkscape::Extension::Output::save().

◆ setup()

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

◆ stroke()

◆ text()

◆ 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
trueRender the text as a path
falseRender text using the text function (above)

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

Definition at line 143 of file implementation.h.

Referenced by Inkscape::Extension::Print::textToPath().

◆ unload()

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

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