idomoutline.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2025 Global Graphics Software Ltd. All rights reserved.
 */
 
#ifndef __EDLIDOMOUTLINE_H__
#define __EDLIDOMOUTLINE_H__
 
#include <edl/edltypes.h>
#include <edl/iedltree.h>
#include <edl/idomnode.h>
#include <edl/idomtarget.h>
#include <edl/idomcolor.h>
 
_BEGIN_EDL_DOM_NAMESPACE
 
class IDOMOutlineEntry;
DECL_SMART_PTR(IDOMOutlineEntry);
 
#define IDOMOutlineTreeNodeClassID 0xc50ff402, 0xeb5146bd, 0xb71cb56d, 0xb2917eb8
typedef IEDLTreeNode<IDOMOutlineEntryPtr>   IDOMOutlineTreeNode;
DECL_SMART_PTR(IDOMOutlineTreeNode);
#define edlobj2IDOMOutlineTreeNode(src) edl_cast((IDOMOutlineTreeNode *)NULL, src)
 
#define IDOMOutlineTreeClassID 0xe506e704, 0x6e2a44ac, 0x90492ec9, 0xf0030b95
typedef IEDLTree<IDOMOutlineEntryPtr>   IDOMOutlineTree;
DECL_SMART_PTR(IDOMOutlineTree);
#define edlobj2IDOMOutlineTree(src) edl_cast((IDOMOutlineTree *)NULL, src)
 
class IDOMOutline;
DECL_SMART_PTR(IDOMOutline);

class IDOMOutlineEntry : public IEDLObject
{
#define IDOMOutlineEntryClassID 0x8779c348, 0x5b8647ad, 0x998a9ac5, 0xf917346d
  public:

    typedef enum
    {
        eTextStyleNone       = 0x00,    
        eTextStyleItalic     = 0x01,    
        eTextStyleBold       = 0x02,    
#ifdef SWIG
        eTextStyleBoldItalic = 0x01 | 0x02  
#else
        eTextStyleBoldItalic = eTextStyleItalic | eTextStyleBold     
#endif
    } eTextStyle;
 
    DECLARE_CLASS_ID(IDOMOutlineEntryClassID);

    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"));

    class Data : public CClassParams
    {
      public:
        Data()
        {}
        EDLString language;
        EDLString description;
        IDOMTargetPtr ptrTarget;
        IDOMColorPtr ptrTextColor;
        eTextStyle textStyle;
        bool expanded;
        IEDLObjectPtr ptrStructureElement;
    };

    virtual bool getLanguage (EDLString &strLanguage) const = 0;

    virtual bool setLanguage (const EDLString &strLanguage) = 0;

    virtual bool getDescription(EDLString &strDescription) const = 0;

    virtual bool setDescription (const EDLString &strDescription) = 0;

    virtual bool getTarget(IDOMTargetPtr &ptrTarget) const = 0;

    virtual bool setTarget(const IDOMTargetPtr &ptrTarget) = 0;

    virtual bool getTextColor(IDOMColorPtr &ptrColor) const = 0;

    virtual bool setTextColor(const IDOMColorPtr &ptrColor) = 0;

    virtual eTextStyle getTextStyle() const = 0;

    virtual void setTextStyle(eTextStyle style) = 0;

    virtual bool getExpanded() const = 0;

    virtual void setExpanded(bool expanded) = 0;

    virtual bool getStructureElement(IEDLObjectPtr &ptrSE) const = 0;

    virtual bool setStructureElement(const IEDLObjectPtr &ptrSE) = 0;
};
 
#define edlobj2IDOMOutlineEntry(src) edl_cast((IDOMOutlineEntry *)NULL, src)

class IDOMOutline : public IEDLObject
{
#define IDOMOutlineClassID 0x236225f5, 0xf0ab4443, 0xa0f0b200, 0x138611e3
 
public:
 
    DECLARE_CLASS_ID(IDOMOutlineClassID);

    static EDL_API IDOMOutlinePtr create(IEDLClassFactory *pFactory, const EDLString &language = EDLString(L"und"));

    class Data : public CClassParams
    {
      public:
        Data()
        {}
        EDLString language;
    };

    virtual bool getLanguage (EDLString &strLanguage) const = 0;

    virtual bool setLanguage (const EDLString &strLanguage) = 0;

    virtual IDOMOutlineTreePtr getOutlineTree() = 0;
};
 
#define edlobj2IDOMOutline(src) edl_cast((IDOMOutline *)NULL, src)
 
_END_EDL_DOM_NAMESPACE
 
#endif // __EDLIDOMOUTLINE_H__