An interface class for an annotation appearance, describing the graphical content of an annotation in a given usage and state. Annotation appearances are immutable.
More...
#include <interactive.h>
|
| virtual IAnnotationAppearancePtr | clone () const =0 |
| | Clone the appearance. This is a deep clone.
|
| |
| virtual eAppearanceUsage | getUsage () const =0 |
| | Get the usage for this appearance.
|
| |
| virtual U8String | getState () const =0 |
| | Get the appearance state for this appearance. Will return an empty string if there is no state associated with the appearance.
|
| |
| virtual IDOMFormPtr | getForm () const =0 |
| | Get the graphical contents as an IDOMForm. Do not edit this form.
|
| |
| virtual IDOMNodePtr | getScaledAppearance (const FRect &annotRect) const =0 |
| | Get DOM for the annotation scaled appropriately to the given rect. Useful for preparing an annotation appearance for display or rendering. A clone of the contents will be returned.
|
| |
|
virtual void | addRef () const =0 |
| | Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
|
| |
| virtual bool | decRef () const =0 |
| | Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
|
| |
| virtual int32 | getRefCount () const =0 |
| | Retrieve the current reference count of the actual object pointed to.
|
| |
|
| static JAWSMAKO_API IAnnotationAppearancePtr | create (const IJawsMakoPtr &jawsMako, const IDOMFormPtr &form, eAppearanceUsage usage, const U8String &state=U8String()) |
| | Create a new annotation appearance.
|
| |
|
|
virtual | ~IRCObject () |
| | Virtual destructor.
|
| |
An interface class for an annotation appearance, describing the graphical content of an annotation in a given usage and state. Annotation appearances are immutable.
◆ clone()
| virtual IAnnotationAppearancePtr JawsMako::IAnnotationAppearance::clone |
( |
| ) |
const |
|
pure virtual |
Clone the appearance. This is a deep clone.
- Returns
- IAnnotationAppearancePtr A smart pointer to the cloned annotation appearance
◆ create()
| static JAWSMAKO_API IAnnotationAppearancePtr JawsMako::IAnnotationAppearance::create |
( |
const IJawsMakoPtr & | jawsMako, |
|
|
const IDOMFormPtr & | form, |
|
|
eAppearanceUsage | usage, |
|
|
const U8String & | state = U8String() ) |
|
static |
Create a new annotation appearance.
- Parameters
-
| jawsMako | The JawsMako instance |
| form | The graphical contents as an IDOMForm |
| usage | The usage for this appearance |
| state | The appearance state for this appearance |
- Returns
- IAnnotationAppearancePtr A smart pointer to the new annotation appearance
◆ getForm()
| virtual IDOMFormPtr JawsMako::IAnnotationAppearance::getForm |
( |
| ) |
const |
|
pure virtual |
Get the graphical contents as an IDOMForm. Do not edit this form.
- Returns
- IDOMFormPtr The graphical contents as an IDOMForm
◆ getScaledAppearance()
| virtual IDOMNodePtr JawsMako::IAnnotationAppearance::getScaledAppearance |
( |
const FRect & | annotRect | ) |
const |
|
pure virtual |
Get DOM for the annotation scaled appropriately to the given rect. Useful for preparing an annotation appearance for display or rendering. A clone of the contents will be returned.
- Parameters
-
| annotRect | An FRect that defines the scale of the returned DOM node |
- Returns
- IDOMNodePtr The DOM for the annotation
◆ getState()
| virtual U8String JawsMako::IAnnotationAppearance::getState |
( |
| ) |
const |
|
pure virtual |
Get the appearance state for this appearance. Will return an empty string if there is no state associated with the appearance.
- Returns
- U8String The appearance state for this appearance
◆ getUsage()
Get the usage for this appearance.
- Returns
- eAppearanceUsage The usage for this appearance
The documentation for this class was generated from the following file:
Public Member Functions inherited from IRCObject