Mako 7.3.0 API
JawsMako::INamedDestination Class Referenceabstract

A named destination in a PDF Document. More...

#include <interactive.h>

Inheritance diagram for JawsMako::INamedDestination:

Public Member Functions

virtual INamedDestinationPtr clone () const =0
 Clone the named destination. More...
 
virtual const U8StringgetName () const =0
 Get the name of this named destination. More...
 
virtual IDOMPageRectTargetPtr getTarget () const =0
 Get the destination. More...
 
- Public Member Functions inherited from IRCObject
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. More...
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to. More...
 

Static Public Member Functions

static JAWSMAKO_API INamedDestinationPtr create (const IJawsMakoPtr &jawsMako, const U8String &name, const IDOMPageRectTargetPtr &target)
 Create a named destination with the given name to the given target. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

A named destination in a PDF Document.

Member Function Documentation

◆ clone()

virtual INamedDestinationPtr JawsMako::INamedDestination::clone ( ) const
pure virtual

Clone the named destination.

Returns
INamedDestinationPtr A smart pointer to the cloned named destination

◆ create()

static JAWSMAKO_API INamedDestinationPtr JawsMako::INamedDestination::create ( const IJawsMakoPtr &  jawsMako,
const U8String name,
const IDOMPageRectTargetPtr &  target 
)
static

Create a named destination with the given name to the given target.

Parameters
jawsMakoThe JawsMako instance
nameThe name of the destination
targetThe target of the destination
Returns
INamedDestinationPtr A smart pointer to the new named destination

◆ getName()

virtual const U8String& JawsMako::INamedDestination::getName ( ) const
pure virtual

Get the name of this named destination.

Returns
U8String The name of this named destination

◆ getTarget()

virtual IDOMPageRectTargetPtr JawsMako::INamedDestination::getTarget ( ) const
pure virtual

Get the destination.

Returns
IDOMPageRectTargetPtr A smart pointer to a page rect target that represents the destination of this named destination, or NULL if the destination is not understood

Do not edit this destination


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