Mako 8.2.0 API
MakoCore SDK API Documentation
Loading...
Searching...
No Matches
JawsMako::IPDFName Class Referenceabstract

#include <jawsmako/pdfobjects.h>

Inheritance diagram for JawsMako::IPDFName:
[legend]

Public Member Functions

virtual ~IPDFName ()
virtual bool isValidUtf8 () const =0
 Determine if the string representing the name will validate as UTF-8.
virtual const RawStringgetValue () const =0
 Get the raw string value of the name.
Public Member Functions inherited from JawsMako::IPDFObject
virtual ePDFObjectType getType () const =0
 Get the type of this PDF object.
virtual IPDFObjectPtr clone () const =0
 Create a clone of this PDF object if appropriate. Note that simple immutable objects are not actually cloned and instead the same object is returned.
virtual IPDFObjectPtr deepClone () const =0
 Create a deep clone of this PDF object if appropriate. Note that simple immutable objects are not actually cloned and instead the same object is returned. If the object is composite (an IPDFArray, IPDFDictionary or IPDFStream) then the object will be cloned as well as the constituent objects in a recursive fashion.
virtual bool getIsExecutable () const =0
 Get whether the object is considered executable, such as an executable name, array, or operator.
virtual bool containsReferences () const =0
 Get whether the object contains indirect references to other objects (that is, does the object or any constituent object contain IPDFReference or IPDFFarReference objects).
virtual void emitPostScriptCode (const IOutputStreamPtr &dest) const =0
 Convert the object to PostScript code and write to the given stream. Only allowed for objects that are representable in PostScript.
virtual bool getNumber (double &number) const =0
 If the object is a number (a real or integer) obtain that number.
virtual bool getNumber (float &number) const =0
 If the object is a number (a real or integer) within the range of a 32-bit float, obtain that number. If the object is an integer, this will fail if the integer cannot be represented exactly in a single precision float.
virtual bool getNumber (int32 &number) const =0
 If the object is an integer (a integral real or integer) within the range of a 32-bit integer, obtain that number.
virtual bool getString (RawString &string) const =0
 If the object is a string or a name, retrieve the raw string data.
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.
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to.
Public Member Functions inherited from JawsMako::IHashable
virtual ~IHashable ()
virtual uint64 hash () const
 Obtain a 64-bit hash of the receiving object.
virtual void updateHash (uint64 &hash) const =0
 Update the given hash to include the receiver.

Static Public Member Functions

static JAWSMAKO_API IPDFNamePtr create (IEDLClassFactory *pFactory, const RawString &name)
 Create a name object from the given raw string. An attempt will be made to reuse an existing name object to avoid duplication of memory.
static JAWSMAKO_API IPDFNamePtr create (const RawString &name, bool executable=false)
 Create a new name object from the given raw string.
Static Public Member Functions inherited from JawsMako::IPDFObject
static JAWSMAKO_API IPDFObjectPtr createNumber (double number)
 If the given number is an integer, create an IPDFInteger, otherwise create an IPDFReal.

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ ~IPDFName()

virtual JawsMako::IPDFName::~IPDFName ( )
inlinevirtual

Member Function Documentation

◆ create() [1/2]

JAWSMAKO_API IPDFNamePtr JawsMako::IPDFName::create ( const RawString & name,
bool executable = false )
static

Create a new name object from the given raw string.

Parameters
nameThe raw string containing the value of the name.
executableIf this name should be marked executable.
Returns
IPDFNamePtr The created object.

◆ create() [2/2]

JAWSMAKO_API IPDFNamePtr JawsMako::IPDFName::create ( IEDLClassFactory * pFactory,
const RawString & name )
static

Create a name object from the given raw string. An attempt will be made to reuse an existing name object to avoid duplication of memory.

Parameters
pFactoryThe class factory or JawsMako instance to use.
nameThe raw string containing the value of the name.
Returns
IPDFNamePtr The created object.

◆ getValue()

virtual const RawString & JawsMako::IPDFName::getValue ( ) const
pure virtual

Get the raw string value of the name.

Returns
RawString The value of the real.

◆ isValidUtf8()

virtual bool JawsMako::IPDFName::isValidUtf8 ( ) const
pure virtual

Determine if the string representing the name will validate as UTF-8.

Returns
bool True if the name is valid UTF-8.

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