myscript::iink::ContentSelection Class Reference

#include <ContentSelection.h>

Inheritance diagram for myscript::iink::ContentSelection:

Public Member Functions
virtual	~ContentSelection ()=default
virtual std::shared_ptr< ContentPart >	getPart ()=0
virtual bool	isValid () noexcept=0
virtual myscript::iink::graphics::Rectangle	getBox ()=0
virtual std::underlying_type< ConversionState >::type	getConversionState ()=0

Detailed Description

Represents a selection.

Since

2.0

Constructor & Destructor Documentation

~ContentSelection()

virtual myscript::iink::ContentSelection::~ContentSelection ( )

virtualdefault

Member Function Documentation

getPart()

virtual std::shared_ptr<ContentPart> myscript::iink::ContentSelection::getPart ( )

pure virtual

Returns the part that contains this selection.

Returns

the content part.

Exceptions

std::runtime_error

when selection is invalid.

isValid()

virtual bool myscript::iink::ContentSelection::isValid ( )

pure virtualnoexcept

Tells whether this selection is still valid. A selection becomes invalid when all its content blocks are invalid. If this selection is a ContentBlock, it becomes invalid when it is removed or when the currently edited part changes (see IEditorListener#partChanged).

Returns

true if this selection is valid.

getBox()

virtual myscript::iink::graphics::Rectangle myscript::iink::ContentSelection::getBox ( )

pure virtual

Returns the bounding box of this selection. Deprecated since 3.2. Use Editor#getBox instead.

Returns

the box (document coordinates in mm).

Exceptions

std::runtime_error

when selection is invalid.

getConversionState()

virtual std::underlying_type<ConversionState>::type myscript::iink::ContentSelection::getConversionState ( )

pure virtual

Returns the current conversion state of this selection as a bitwise or combination of ConversionState values. Deprecated since 3.2. Use Editor#getConversionState instead.

Returns

the conversion state combination.

Exceptions

std::runtime_error

when selection is invalid.

---

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

• iink/ContentSelection.h