myscript::iink::ContentPart Class Reference

#include <ContentPart.h>

Public Member Functions
virtual	~ContentPart ()=default
virtual std::shared_ptr< ContentPackage >	getPackage () const noexcept=0
virtual String	getId () const noexcept=0
virtual String	getType () const =0
virtual graphics::Rectangle	getViewBox () const noexcept=0
virtual graphics::Point	getFixedSize () const noexcept=0
virtual String	getLanguage ()=0
virtual std::shared_ptr< ParameterSet >	getMetadata ()=0
virtual void	setMetadata (std::shared_ptr< ParameterSet > parameters)=0

Detailed Description

A part stores one content item. It is structured into several blocks that consist of semantically meaningful sub sections of content. A part can be interpreted as a hierarchy of blocks.

See also

ContentPackage.

Constructor & Destructor Documentation

~ContentPart()

virtual myscript::iink::ContentPart::~ContentPart ( )

virtualdefault

Member Function Documentation

getPackage()

virtual std::shared_ptr< ContentPackage > myscript::iink::ContentPart::getPackage ( ) const

pure virtualnoexcept

Returns the package that contains this part.

Returns

the package.

getId()

virtual String myscript::iink::ContentPart::getId ( ) const

pure virtualnoexcept

Returns the identifier of this part.

Returns

the part identifier.

getType()

virtual String myscript::iink::ContentPart::getType ( ) const

pure virtual

Returns the type of this part.

Returns

the part type.

getViewBox()

virtual graphics::Rectangle myscript::iink::ContentPart::getViewBox ( ) const

pure virtualnoexcept

Returns the view box, the rectangle that represents the viewable area of this part's content.

Returns

the view box (document coordinates in mm).

getFixedSize()

virtual graphics::Point myscript::iink::ContentPart::getFixedSize ( ) const

pure virtualnoexcept

Warning

This is a Beta API.

Returns the part's fixed-size, if defined.

Returns

{width, height} if fixed-size, otherwise {0.f, 0.f} (document coordinates in mm).

Since

4.1

getLanguage()

virtual String myscript::iink::ContentPart::getLanguage ( )

pure virtual

Returns the language of this part.

Returns

the part language locale identifier, empty if not set yet (will be set by Editor#setPart).

Exceptions

std::runtime_error

when part does not support text recognition (i.e. for types Math and Drawing).

Since

2.0

getMetadata()

virtual std::shared_ptr< ParameterSet > myscript::iink::ContentPart::getMetadata ( )

pure virtual

Returns the part's metadata as a parameter set.

Returns

the parameter set.

setMetadata()

virtual void myscript::iink::ContentPart::setMetadata ( std::shared_ptr< ParameterSet >  parameters )

pure virtual

Set the part's metadata with the given parameter set.

Parameters

parameters

the parameters to set.

---

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

• iink/ContentPart.h