Represents an index to a specific location in the document or a specific location external to the document. More...

#include <idomoutline.h>

Inheritance diagram for IDOMOutlineEntry:

[legend]

Classes
class	Data
	Initialization data. More...

Public Types
enum	eTextStyle { eTextStyleNone = 0x00 , eTextStyleItalic = 0x01 , eTextStyleBold = 0x02 , eTextStyleBoldItalic = eTextStyleItalic \| eTextStyleBold }
	Specifies an outline text style. More...

Public Member Functions
virtual bool	getLanguage (EDLString &strLanguage) const =0
	Retrieves the default language of the outline entry node.

virtual bool	setLanguage (const EDLString &strLanguage)=0
	Retrieves the default language of the outline entry node.

virtual bool	getDescription (EDLString &strDescription) const =0
	Retrieves the description of the outline entry node.

virtual bool	setDescription (const EDLString &strDescription)=0
	Sets the description of the outline entry node.

virtual bool	getTarget (IDOMTargetPtr &ptrTarget) const =0
	Retrieves the target of the outline entry node. If outline entry doesn't have target then ptrTarget will be set to NULL.

virtual bool	setTarget (const IDOMTargetPtr &ptrTarget)=0
	Sets the target of the outline entry node. NULL is a valid value of ptrTarget parameter.

virtual bool	getTextColor (IDOMColorPtr &ptrColor) const =0
	Retrieves the color to be used for the outline entry's text.

virtual bool	setTextColor (const IDOMColorPtr &ptrColor)=0
	Sets the color to be used for the outline entry's text.

virtual eTextStyle	getTextStyle () const =0
	Retrieves the style to be used for the outline entry's text.

virtual void	setTextStyle (eTextStyle style)=0
	Sets the outline entry's text style.

virtual bool	getExpanded () const =0
	Retrieves "expanded" flag value.

virtual void	setExpanded (bool expanded)=0
	Sets the outline entry's "expanded" flag.

virtual bool	getStructureElement (IEDLObjectPtr &ptrSE) const =0
	Retrieves the structure element.

virtual bool	setStructureElement (const IEDLObjectPtr &ptrSE)=0
	Sets the structure element.

Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.

virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.

virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.

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.

Static Public Member Functions
static EDL_API IDOMOutlineTreeNodePtr	createNode (IEDLClassFactory *pFactory, const EDLString &description, bool expanded=true, const IDOMTargetPtr &target=IDOMTargetPtr(), const IDOMColorPtr &textColor=IDOMColorPtr(), eTextStyle style=eTextStyleNone, EDLString language=EDLString(L"und"))
	Simplified creator to create an outline tree entry with a new outline tree node.

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

Detailed Description

Represents an index to a specific location in the document or a specific location external to the document.

See also: IDOMOutline

IDOMOutlineEntry objects are used for the individual components of the IDOMOutline. You can use the document outline information to support interactive functionality.

Every outline entry associates a text description of the bookmark with certain location within the document (represented as an IDOMInternalTarget or an IDOMPageTarget) or with an external location (represented as an IDOMExternalTarget). IDOMOutlineEntry inherits from IDOMNode and the outline entries are organized into a tree-like structure. There is no limit set on number of outline entries, so there can be as many as the available memory allows.

Using this information it is possible to create a navigation pane that uses the Unicode value of the description attribute of the outline entry node. The corresponding location is specified by the Target attribute.

Member Function Documentation

◆ createNode()

static EDL_API IDOMOutlineTreeNodePtr IDOMOutlineEntry::createNode	(	IEDLClassFactory *	pFactory,
		const EDLString &	description,
		bool	expanded = true,
		const IDOMTargetPtr &	target = IDOMTargetPtr(),
		const IDOMColorPtr &	textColor = IDOMColorPtr(),
		eTextStyle	style = eTextStyleNone,
		EDLString	language = EDLString(L"und") )

static

Simplified creator to create an outline tree entry with a new outline tree node.

Parameters

pFactory	The EDL factory to use
description	The description of the outline entry
expanded	If the outline entry's children should be shown by default
target	The destination for the outline entry, or NULL for no target.
textColor	The color for the outline entry, or NULL for default. If provided, it must use the DeviceRGB color space.
style	The desired text style
language	The language code to use (see setLanguage below)

◆ getDescription()

virtual bool IDOMOutlineEntry::getDescription ( EDLString & strDescription ) const

pure virtual

Retrieves the description of the outline entry node.

Parameters

strDescription Reference parameter to receive the outline entry node descipriton.

Returns: bool Returns true on success, false if the call fails.

◆ getExpanded()

virtual bool IDOMOutlineEntry::getExpanded ( ) const

pure virtual

Retrieves "expanded" flag value.

Returns: bool Returns true if the outline entry is expanded, false otherwise.

◆ getLanguage()

virtual bool IDOMOutlineEntry::getLanguage ( EDLString & strLanguage ) const

pure virtual

Retrieves the default language of the outline entry node.

English is defined as en_GB and American English as en_US. There is no default setting. If the language is not known it is set to "und" (undetermined). For further information see http://www.w3.org/International/articles/language-tags/. The language is specified according to RFC 3066.

Parameters

strLanguage Default language

Returns: bool Returns true on success, false if the call fails.

◆ getStructureElement()

virtual bool IDOMOutlineEntry::getStructureElement ( IEDLObjectPtr & ptrSE ) const

pure virtual

Retrieves the structure element.

Parameters

ptrSE Smart pointer to receive the structure element

Returns: bool Returns true on success, false if the call fails.

◆ getTarget()

virtual bool IDOMOutlineEntry::getTarget ( IDOMTargetPtr & ptrTarget ) const

pure virtual

Retrieves the target of the outline entry node. If outline entry doesn't have target then ptrTarget will be set to NULL.

Parameters

ptrTarget Smart pointer to receive the target of the outline entry node.

Returns: bool Returns true on success, false if the call fails.

◆ getTextColor()

virtual bool IDOMOutlineEntry::getTextColor ( IDOMColorPtr & ptrColor ) const

pure virtual

Retrieves the color to be used for the outline entry's text.

Parameters

ptrColor Smart pointer to the outline entry text's color.

Returns: bool Returns true on success, false if the call fails.

◆ getTextStyle()

virtual eTextStyle IDOMOutlineEntry::getTextStyle ( ) const

pure virtual

Retrieves the style to be used for the outline entry's text.

See also: eTextStyle

Returns: eTextStyle. Returns the style value for the outline entry's text.

◆ setDescription()

virtual bool IDOMOutlineEntry::setDescription ( const EDLString & strDescription )

pure virtual

Sets the description of the outline entry node.

Parameters

strDescription The new descripton for the outline entry node.

Returns: bool Returns true on success, false if the call fails.

◆ setExpanded()

virtual void IDOMOutlineEntry::setExpanded ( bool expanded )

pure virtual

Sets the outline entry's "expanded" flag.

Parameters

expanded New value for the outline entry's "expanded" flag.

◆ setLanguage()

virtual bool IDOMOutlineEntry::setLanguage ( const EDLString & strLanguage )

pure virtual

Retrieves the default language of the outline entry node.

English is defined as en_GB and American English as en_US. There is no default setting. If the language is not known it is set to "und" (undetermined). For further information see http://www.w3.org/International/articles/language-tags/. The language is specified according to RFC 3066.

Parameters

strLanguage Default language

Returns: bool Returns true on success, false if the call fails.

◆ setStructureElement()

virtual bool IDOMOutlineEntry::setStructureElement ( const IEDLObjectPtr & ptrSE )

pure virtual

Sets the structure element.

Parameters

ptrSE Smart pointer to the new structure element.

Returns: bool Returns true on success, false if the call fails.

◆ setTarget()

virtual bool IDOMOutlineEntry::setTarget ( const IDOMTargetPtr & ptrTarget )

pure virtual

Sets the target of the outline entry node. NULL is a valid value of ptrTarget parameter.

Parameters

ptrTarget Smart pointer to the new target of the outline entry node.

Returns: bool Returns true on success, false if the call fails.

◆ setTextColor()

virtual bool IDOMOutlineEntry::setTextColor ( const IDOMColorPtr & ptrColor )

pure virtual

Sets the color to be used for the outline entry's text.

Parameters

ptrColor Smart pointer to the new outline entry text color.

Returns: bool Returns true on success, false if the call fails.

◆ setTextStyle()

virtual void IDOMOutlineEntry::setTextStyle ( eTextStyle style )

pure virtual

Sets the outline entry's text style.

See also: eTextStyle

Parameters

style The new value for the outline entry's text style.

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

idomoutline.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createNode()

◆ getDescription()

◆ getExpanded()

◆ getLanguage()

◆ getStructureElement()

◆ getTarget()

◆ getTextColor()

◆ getTextStyle()

◆ setDescription()

◆ setExpanded()

◆ setLanguage()

◆ setStructureElement()

◆ setTarget()

◆ setTextColor()

◆ setTextStyle()