Represents the outline of the document, which is the collection of bookmarks for the document.
More...
#include <idomoutline.h>
|
| virtual bool | getLanguage (EDLString &strLanguage) const =0 |
| | Retrieves the default language of the outline node.
|
| |
| virtual bool | setLanguage (const EDLString &strLanguage)=0 |
| | the default language of the outline node.
|
| |
| virtual IDOMOutlineTreePtr | getOutlineTree ()=0 |
| | Retrieves the outline tree.
|
| |
| 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.
|
| |
|
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 EDL_API IDOMOutlinePtr | create (IEDLClassFactory *pFactory, const EDLString &language=EDLString(L"und")) |
| | Simplified creator to create an outline.
|
| |
|
|
virtual | ~IRCObject () |
| | Virtual destructor.
|
| |
Represents the outline of the document, which is the collection of bookmarks for the document.
- See also
- IDOMOutlineEntry
IDOMOutline is similar to the table of contents in a book. Each entry into the outline is represented by an IDOMOutlineEntry object. IDOMOutlineEntry inherits from the IDOMNode and these outline entries are organized into a tree-like structure. IDOMOutline holds the reference to the root node of that tree.
◆ create()
| static EDL_API IDOMOutlinePtr IDOMOutline::create |
( |
IEDLClassFactory * | pFactory, |
|
|
const EDLString & | language = EDLString(L"und") ) |
|
static |
Simplified creator to create an outline.
- Parameters
-
| pFactory | The EDL factory to use |
| language | The language code to use (see setLanguage below) |
◆ getLanguage()
| virtual bool IDOMOutline::getLanguage |
( |
EDLString & | strLanguage | ) |
const |
|
pure virtual |
Retrieves the default language of the outline 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 | Reference parameter to receive the default language. |
- Returns
- bool Returns true on success, false if the call fails.
◆ getOutlineTree()
| virtual IDOMOutlineTreePtr IDOMOutline::getOutlineTree |
( |
| ) |
|
|
pure virtual |
Retrieves the outline tree.
- Returns
- IDOMOutlineTreePtr. Returns a smart pointer to the outline tree.
◆ setLanguage()
| virtual bool IDOMOutline::setLanguage |
( |
const EDLString & | strLanguage | ) |
|
|
pure virtual |
the default language of the outline 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 | The new default language |
- Returns
- bool Returns true on success, false if the call fails.
The documentation for this class was generated from the following file:
Public Member Functions inherited from IEDLObject