gui::QSAnnotation Class Reference

QObject wrapper around CAnnotation object. More...

#include <qsannotation.h>

Inheritance diagram for gui::QSAnnotation:
gui::QSCObject

List of all members.

Public Slots

QSDict * getDictionary ()
QSPage * getPage ()
bool remove ()
QString getType ()
QString getTypeName ()

Public Member Functions

 QSAnnotation (boost::shared_ptr< CAnnotation > pdfObj, boost::shared_ptr< CPage > _page, BaseCore *_base)
virtual ~QSAnnotation ()
boost::shared_ptr< CAnnotation > get () const

Private Attributes

boost::shared_ptr< CAnnotation > obj
boost::shared_ptr< CPage > page

Detailed Description

QObject wrapper around CAnnotation object.

Constructor & Destructor Documentation

gui::QSAnnotation::QSAnnotation ( boost::shared_ptr< CAnnotation >  pdfObj,
boost::shared_ptr< CPage >  _page,
BaseCore *  _base 
)

Construct wrapper with given CAnnotation

Parameters:
pdfObj CAnnotation object
_base scripting base
_page page holding the annotation

References obj, and page.

gui::QSAnnotation::~QSAnnotation (  )  [virtual]

destructor

Member Function Documentation

boost::shared_ptr< CAnnotation > gui::QSAnnotation::get (  )  const

get CAnnotation held inside this class. Not exposed to scripting

References obj.

Referenced by gui::QSPage::addAnnotation().

QSDict * gui::QSAnnotation::getDictionary (  )  [slot]

Call CAnnotation::getDictionary

References gui::QSCObject::base, and obj.

QSPage * gui::QSAnnotation::getPage (  )  [slot]

Get annotation's page

References gui::QSCObject::base, and page.

QString gui::QSAnnotation::getType (  )  [slot]

Return type identifier of annotation

References util::annotType(), and obj.

QString gui::QSAnnotation::getTypeName (  )  [slot]

Return human-readable, localized type identifier of annotation

References util::annotTypeName(), and obj.

bool gui::QSAnnotation::remove (  )  [slot]

Remove this annotation from its page, if it is in a page

Returns:
true if removed

References gui::QSCObject::base, gui::BaseCore::errorException(), obj, and page.

Member Data Documentation

boost::shared_ptr<CAnnotation> gui::QSAnnotation::obj [private]

Object held in class

Referenced by get(), getDictionary(), getType(), getTypeName(), QSAnnotation(), and remove().

boost::shared_ptr<CPage> gui::QSAnnotation::page [private]

Page holding this annotation

Referenced by getPage(), QSAnnotation(), and remove().

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