InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
DOMAttributeValue Class Reference

#include <DOMAttributeValue.h>

Inheritance diagram for DOMAttributeValue:
ScriptData

Public Types

typedef object_type data_type
 
typedef ScriptData::ScriptDataType AttributeType
 
- Public Types inherited from ScriptData
enum  ScriptDataType {
  s_empty, s_boolean, s_string, s_shortint,
  s_longint, s_longlongint, s_double, s_object,
  s_objectlist, s_list, s_date, s_file,
  s_enumeration, s_unit, s_record, s_stream,
  s_function
}
 
enum  UnitType {
  kXCoordinate, kYCoordinate, kPoints, kTextUnits,
  kTextSizeUnits, kLineUnits
}
 
typedef object_type data_type
 

Public Member Functions

 DOMAttributeValue ()
 
 DOMAttributeValue (const WideString &value)
 
 DOMAttributeValue (int32 value)
 
 DOMAttributeValue (IPMStream *value)
 
 DOMAttributeValue (const DOMAttributeValue &other)
 
 DOMAttributeValue (bool16 readOnly, ScriptData sd)
 
 DOMAttributeValue (adobe::move_from< DOMAttributeValue > other)
 
virtual ~DOMAttributeValue ()
 
bool16 IsReadOnly () const
 
void SetReadOnly (bool16 readOnly)
 
bool16 IsEmpty () const
 
bool16 operator== (const DOMAttributeValue &other) const
 
bool16 operator!= (const DOMAttributeValue &other) const
 
DOMAttributeValueoperator= (DOMAttributeValue other)
 
DOMAttributeValueoperator= (ScriptData other)
 
- Public Member Functions inherited from ScriptData
 ScriptData (const ScriptData &other)
 
 ScriptData (int16 integer, bool16 isBoolean=kFalse)
 
 ScriptData (int32 integer)
 
 ScriptData (int64 integer)
 
 ScriptData (ScriptID enumerator)
 
 ScriptData (PMReal real)
 
 ScriptData (const PMString &string)
 
 ScriptData (const WideString &string)
 
 ScriptData (IScript *object)
 
 ScriptData (IPMStream *stream)
 
 ScriptData (const ScriptList &objectList)
 
 ScriptData (const ScriptListData &list)
 
 ScriptData (const ScriptRecordData &record)
 
 ScriptData (uint64 date)
 
 ScriptData (const IDFile &file)
 
virtual ScriptData::ScriptDataType GetType () const
 
void SetBoolean (bool16 boolean)
 
ErrorCode GetBoolean (bool16 *const boolean) const
 
void SetInt16 (int16 integer)
 
ErrorCode GetInt16 (int16 *const integer) const
 
void SetInt32 (int32 integer)
 
ErrorCode GetInt32 (int32 *const integer) const
 
void SetInt64 (int64 integer)
 
ErrorCode GetInt64 (int64 *const integer) const
 
void SetEnumeration (ScriptID enumeration)
 
ErrorCode GetEnumeration (ScriptID *const enumeration) const
 
void SetPMReal (PMReal real)
 
ErrorCode GetPMReal (PMReal *const real) const
 
void SetPMString (const PMString &string)
 
ErrorCode GetPMString (PMString &string) const
 
virtual void SetWideString (const WideString &string)
 
virtual ErrorCode GetWideString (WideString &string) const
 
void SetObject (IScript *object)
 
IScriptQueryObject () const
 
void SetObjectList (const ScriptList &objectList)
 
ErrorCode GetObjectList (ScriptList &objectList) const
 
void SetStream (IPMStream *stream)
 
IPMStreamQueryStream () const
 
void SetFunction (IScriptCoreFunctor *func)
 
IScriptCoreFunctorQueryFunction () const
 
void SetList (const ScriptListData &list)
 
ErrorCode GetList (ScriptListData &list) const
 
void SetRecord (const ScriptRecordData &record)
 
ErrorCode GetRecord (ScriptRecordData &record) const
 
void SetDate (uint64 date)
 
ErrorCode GetDate (uint64 *const date) const
 
void SetFile (const IDFile &file)
 
ErrorCode GetFile (IDFile *const file, const RequestContext &context, bool16 validateFolder=kTrue) const
 
ErrorCode GetFileIfFile (IDFile &file, bool16 validateFolder=kTrue) const
 
void SetUnit (const PMReal &unit, UnitType unitType, const IScript *script, const EngineContext &context)
 
void SetUnit (const PMReal &unit, IUnitOfMeasure *unitOfMeasure)
 
ErrorCode GetUnit (PMReal *const unit, UnitType unitType, const IScript *script, const EngineContext &context, bool16 allowNaN=kFalse) const
 
ErrorCode RetrieveUnit (PMReal *const unit) const
 
ErrorCode ParseUnit (PMReal *const unit, IUnitOfMeasure *unitOfMeasure) const
 
ErrorCode ConvertUnit (PMReal *const real, const ScriptID &unitType, const RequestContext &context) const
 
ErrorCode ConvertUnit (PMString &string) const
 
bool16 IsEqual (const ScriptData &scriptData, const RequestContext &context) const
 
bool16 operator== (const ScriptData &scriptData) const
 
 ScriptData (adobe::move_from< ScriptData > other)
 
ScriptDataoperator= (ScriptData other)
 
virtual void Reset ()
 
virtual void ReadWrite (IPMStream *s, bool16 doPlatformReadWrite=kTrue)
 
PMString GetTypeAsString (const RequestContext &context) const
 
PMString GetValueAsString (const RequestContext &context) const
 
adobe::vector< PMStringGetValueAsVectorOfString (const RequestContext &context) const
 

Friends

void swap (DOMAttributeValue &lhs, DOMAttributeValue &rhs)
 

Detailed Description

Extends ScriptData to provide additional functionality for working with INX. An instance of this class represents the value of a single DOM attribute.

Author
Steve Pellegrin
See Also
IDOMElement

Constructor & Destructor Documentation

DOMAttributeValue::DOMAttributeValue ()

Constructs an empty value

DOMAttributeValue::DOMAttributeValue (const WideStringvalue)

Constructs a WideString value.

Parameters
valueIN The string value.
DOMAttributeValue::DOMAttributeValue (int32 value)

Constructs an int32 value.

Parameters
valueIN The int32 value.
DOMAttributeValue::DOMAttributeValue (IPMStreamvalue)

Constructs a stream value.

Parameters
valueIN The stream value.
DOMAttributeValue::DOMAttributeValue (const DOMAttributeValueother)

Constructs a value that is a copy of another

Parameters
otherIN the value to copy.
DOMAttributeValue::DOMAttributeValue (bool16 readOnly,
ScriptData sd 
)
inline

Constructs a value that is a copy of a ScriptData. Note: if sd is a temporary ScriptData it will be moved in place, eliminating extra copying

Parameters
readOnlyIN Whether the value is read-only.
sdIN The ScriptData to copy.
See Also
ScriptData
DOMAttributeValue::DOMAttributeValue (adobe::move_from< DOMAttributeValueother)
inline

Movable constructor - assumes ownership of the remote part

virtual DOMAttributeValue::~DOMAttributeValue ()
inlinevirtual

Destructor

Member Function Documentation

bool16 DOMAttributeValue::IsEmpty () const
virtual

Determines whether the value is empty or not.

Returns
kTrue if the value is empty, kFalse otherwise.

Reimplemented from ScriptData.

bool16 DOMAttributeValue::IsReadOnly () const
inline

Determine whether the value is read-only.

Returns
kTrue if this value is read-only, kFalse otherwise.
bool16 DOMAttributeValue::operator!= (const DOMAttributeValueother) const
inline

Tests the value for inequality with another.

Parameters
otherIN Another value.
DOMAttributeValue& DOMAttributeValue::operator= (DOMAttributeValue other)
inline

Operator assignment on a movable type takes the parameter by value and consumes it.

Parameters
otherIN another value
DOMAttributeValue& DOMAttributeValue::operator= (ScriptData other)
inline

Assign ScriptData to this one.

Parameters
otherIN ScriptData value. Note that the parameter is passed by value.
bool16 DOMAttributeValue::operator== (const DOMAttributeValueother) const
inline

Tests the value for equality with another.

Parameters
otherIN Another value.
void DOMAttributeValue::SetReadOnly (bool16 readOnly)
inline

Sets the value's read-only attribute.

Parameters
readOnlyIN Whether the value is read-only or not.

Friends And Related Function Documentation

void swap (DOMAttributeValuelhs,
DOMAttributeValuerhs 
)
friend

Swaps two DOMAttributeValue objects efficiently.