Inkscape
Vector Graphics Editor
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
Inkscape::Extension::Internal::TemplateBase Class Reference

#include <template-base.h>

Inheritance diagram for Inkscape::Extension::Internal::TemplateBase:
Inkscape::Extension::Implementation::Implementation Inkscape::Extension::Internal::TemplateOther Inkscape::Extension::Internal::TemplatePaper Inkscape::Extension::Internal::TemplateScreen Inkscape::Extension::Internal::TemplateSocial Inkscape::Extension::Internal::TemplateVideo

Public Member Functions

bool check (Inkscape::Extension::Extension *module) override
 Verify any dependencies.
 
std::unique_ptr< SPDocument > new_from_template (Inkscape::Extension::Template *tmod) override
 
void resize_to_template (Inkscape::Extension::Template *tmod, SPDocument *doc, SPPage *page) override
 
bool match_template_size (Inkscape::Extension::Template *tmod, double width, double height) override
 
- Public Member Functions inherited from Inkscape::Extension::Implementation::Implementation
 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 cancelProcessing ()
 
virtual void commitDocument ()
 
virtual void get_template_presets (const Template *tmod, TemplatePresets &presets) const
 
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.
 

Protected Member Functions

virtual Geom::Point get_template_size (Inkscape::Extension::Template *tmod) const
 Return the width and height of the new page, the default is a fixed orientation.
 
virtual Geom::Point get_template_size (Inkscape::Extension::Template *tmod, const Util::Unit *unit) const
 Return the template size in the required unit.
 
virtual const Util::Unit * get_template_unit (Inkscape::Extension::Template *tmod) const
 Return the unit the size is given in.
 

Detailed Description

Definition at line 23 of file template-base.h.

Member Function Documentation

◆ check()

bool Inkscape::Extension::Internal::TemplateBase::check ( Inkscape::Extension::Extension *  )
inlineoverridevirtual

Verify any dependencies.

Reimplemented from Inkscape::Extension::Implementation::Implementation.

Definition at line 26 of file template-base.h.

◆ get_template_size() [1/2]

Geom::Point Inkscape::Extension::Internal::TemplateBase::get_template_size ( Inkscape::Extension::Template *  tmod) const
protectedvirtual

Return the width and height of the new page, the default is a fixed orientation.

Reimplemented in Inkscape::Extension::Internal::TemplateOther, and Inkscape::Extension::Internal::TemplatePaper.

Definition at line 27 of file template-base.cpp.

References Inkscape::Extension::Extension::get_param_float().

Referenced by get_template_size(), match_template_size(), new_from_template(), and resize_to_template().

◆ get_template_size() [2/2]

Geom::Point Inkscape::Extension::Internal::TemplateBase::get_template_size ( Inkscape::Extension::Template *  tmod,
const Util::Unit *  unit 
) const
protectedvirtual

Return the template size in the required unit.

Definition at line 40 of file template-base.cpp.

References get_template_size(), get_template_unit(), height, Inkscape::size, Inkscape::Util::Quantity::value(), and width.

◆ get_template_unit()

const Util::Unit * Inkscape::Extension::Internal::TemplateBase::get_template_unit ( Inkscape::Extension::Template *  tmod) const
protectedvirtual

Return the unit the size is given in.

Definition at line 52 of file template-base.cpp.

References Inkscape::Util::UnitTable::get(), Inkscape::Extension::Extension::get_param_optiongroup(), and Inkscape::Extension::Extension::get_param_string().

Referenced by get_template_size(), and new_from_template().

◆ match_template_size()

bool Inkscape::Extension::Internal::TemplateBase::match_template_size ( Inkscape::Extension::Template *  tmod,
double  width,
double  height 
)
overridevirtual

Reimplemented from Inkscape::Extension::Implementation::Implementation.

Definition at line 87 of file template-base.cpp.

References Geom::are_near(), Inkscape::Util::UnitTable::get(), get_template_size(), Inkscape::Util::UnitTable::getUnit(), height, and width.

◆ new_from_template()

std::unique_ptr< SPDocument > Inkscape::Extension::Internal::TemplateBase::new_from_template ( Inkscape::Extension::Template *  tmod)
overridevirtual

Reimplemented from Inkscape::Extension::Implementation::Implementation.

Definition at line 62 of file template-base.cpp.

References Inkscape::Extension::Template::get_template_document(), get_template_size(), get_template_unit(), height, Inkscape::size, and width.

◆ resize_to_template()

void Inkscape::Extension::Internal::TemplateBase::resize_to_template ( Inkscape::Extension::Template *  tmod,
SPDocument *  doc,
SPPage *  page 
)
overridevirtual

Reimplemented from Inkscape::Extension::Implementation::Implementation.

Definition at line 80 of file template-base.cpp.

References Inkscape::Util::UnitTable::get(), get_template_size(), SPDocument::getPageManager(), Inkscape::Util::UnitTable::getUnit(), page, Inkscape::PageManager::resizePage(), and Inkscape::size.

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