idomtarget.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2025 Global Graphics Software Ltd. All rights reserved.
 */
 
#ifndef __EDLIDOMTARGET_H__
#define __EDLIDOMTARGET_H__
 
#include <assert.h>
#include <edl/iedlobject.h>
#include <edl/edltypes.h>
#include <edl/iedlenum.h>
#include <edl/edlstring.h>
#include <edl/idomid.h>
 
_BEGIN_EDL_DOM_NAMESPACE
 

class IDOMTarget : public IEDLObject
{
  public:

    typedef enum
    {
        eExternal,              
        eInternal,              
        ePage,                  
        ePageRect,              
        eActionGoToR,           
        eActionGoToE,           
        eActionLaunch,          
        eActionThread,          
        eActionSound,           
        eActionMovie,           
        eActionHide,            
        eActionNamed,           
        eActionSubmitForm,      
        eActionResetForm,       
        eActionImportData,      
        eActionJavaScript,      
        eActionSetOCGState,     
        eActionRendition,       
        eActionTrans,           
        eActionGoTo3DView,      
        eActionArray            
    } eTargetType;

    virtual eTargetType getTargetType() const = 0;
 
};
 
DECL_SMART_PTR(IDOMTarget);
#define edlobj2IDOMTarget(src) edl_cast((IDOMTarget *)NULL, src)
 

class IDOMExternalTarget : public IDOMTarget
{
#define IDOMExternalTargetClassID 0x45192b05, 0xa73c447f, 0xbd0ac312, 0x882e6a7d
  public:
 
    DECLARE_CLASS_ID(IDOMExternalTargetClassID);

    virtual EDLSysString getTargetUri() const = 0;

    virtual void setTargetUri(const EDLSysString &uri) = 0;

    virtual bool getIsMap() const = 0;

    virtual void setIsMap(bool isMap) = 0;

    virtual eTargetType getTargetType() const
    {
        return eExternal;
    }
 
};
 
DECL_SMART_PTR(IDOMExternalTarget);
#define edlobj2IDOMExternalTarget(src) edl_cast((IDOMExternalTarget *)NULL, src)
 

class IDOMInternalTarget : public IDOMTarget
{
#define IDOMInternalTargetClassID 0xfcf28aeb, 0xf977476b, 0x884a1ab2, 0xfac79443
  public:
 
    DECLARE_CLASS_ID(IDOMInternalTargetClassID);

    virtual DOMid getTargetId() const = 0;

    virtual void setTargetId(DOMid domId) = 0;

    virtual eTargetType getTargetType() const
    {
        return eInternal;
    }
 
};
 
DECL_SMART_PTR(IDOMInternalTarget);
#define edlobj2IDOMInternalTarget(src) edl_cast((IDOMInternalTarget *)NULL, src)
 
template <typename basetype>
class TypeWithNull
{
  public:
 
    TypeWithNull() : m_isNull(true)
    {}
 
    TypeWithNull(basetype value) : m_value(value), m_isNull(false)
    {}
 
    TypeWithNull(const TypeWithNull<basetype>& that) : m_isNull(that.m_isNull), m_value(that.m_value)
    {}
 
    basetype getValue() const
    {
        assert(! m_isNull);
        return m_value;
    }
 
    basetype getValueOrDefault(basetype defaultVal = basetype())
    {
        if (m_isNull)
        {
            return defaultVal;
        }
        else
        {
            return m_value;
        }
    }
 
    bool isNull() const
    {
        return m_isNull;
    }
 
    void setValue(basetype value)
    {
        m_value = value;
        m_isNull = false;
    }
 
    void setNull()
    {
        m_isNull = true;
    }
 
    const TypeWithNull & operator =(const TypeWithNull &another)
    {
        m_isNull = another.m_isNull;
        if (!m_isNull)
            m_value = another.m_value;
        return *this;
    }
 
    bool equals(const TypeWithNull &another)
    {
        if (m_isNull != another.m_isNull)
        {
            return false;
        }
        if (!m_isNull)
        {
            if (m_value != another.m_value)
            {
                return false;
            }
        }
        return true;
    }
 
private:
    basetype m_value;
    bool m_isNull;
};
 
typedef TypeWithNull<double> doubleWithNull;
 

class IDOMPageTarget : public IDOMTarget
{
#define IDOMPageTargetClassID 0x2cb17446, 0xac5741d3, 0xb9ba405e, 0x616c7cee
  public:
 
    DECLARE_CLASS_ID(IDOMPageTargetClassID);

    virtual uint32 getTargetPage() const = 0;

    virtual void setTargetPage(uint32 page) = 0;

    virtual eTargetType getTargetType() const
    {
        return ePage;
    }
 
};
 
DECL_SMART_PTR(IDOMPageTarget);
#define edlobj2IDOMPageTarget(src) edl_cast((IDOMPageTarget *)NULL, src)
 
class IDOMPageRectTarget;
DECL_SMART_PTR(IDOMPageRectTarget);

class IDOMPageRectTarget : public IDOMTarget
{
#define IDOMPageRectTargetClassID 0xd21f80cf, 0x124c495b, 0x9eb05a87, 0x2fa73ef6
  public:
 
    DECLARE_CLASS_ID(IDOMPageRectTargetClassID);

    typedef enum
    {
        eFTInvalid,
        eFTXyz,
        eFTFit,
        eFTFitH,
        eFTFitV,
        eFTFitR,
        eFTFitB,
        eFTFitBH,
        eFTFitBV
    } eFitType;

    static EDL_API IDOMPageRectTargetPtr create(IEDLClassFactory *pFactory,
                                                DOMid pageId,
                                                eFitType fitType = eFTFit,
                                                double zoom = 0.0,
                                                const doubleWithNull &left = doubleWithNull(),
                                                const doubleWithNull &top = doubleWithNull(),
                                                const doubleWithNull &right = doubleWithNull(),
                                                const doubleWithNull &bottom = doubleWithNull());

    virtual DOMid getPageId() const = 0;

    virtual void setPageId(DOMid domId) = 0;

    virtual eFitType getFitType() const = 0;

    virtual void setFitType(eFitType fitType) = 0;

    virtual double getZoom() const = 0;

    virtual void setZoom(double zoom) = 0;

    virtual doubleWithNull getLeft() const = 0;

    virtual void setLeft(const doubleWithNull &left) = 0;

    virtual doubleWithNull getTop() const = 0;

    virtual void setTop(const doubleWithNull &top) = 0;

    virtual doubleWithNull getRight() const = 0;

    virtual void setRight(const doubleWithNull &right) = 0;

    virtual doubleWithNull getBottom() const = 0;

    virtual void setBottom(const doubleWithNull &bottom) = 0;

    virtual eTargetType getTargetType() const
    {
        return ePageRect;
    }
 
};
 
#define edlobj2IDOMPageRectTarget(src) edl_cast((IDOMPageRectTarget *)NULL, src)

class IDOMActionLaunch : public IDOMTarget
{
#define IDOMActionLaunchClassID 0x877b883f, 0x5dcf4c04, 0xa469d7f5, 0xf637b394
  public:
 
    DECLARE_CLASS_ID(IDOMActionLaunchClassID);

    virtual EDLString getFile() const = 0;

    virtual void setFile(const EDLString &file) = 0;

    virtual EDLString getWinParameters() const = 0;

    virtual void setWinParameters(const EDLString &params) = 0;

    virtual EDLString getMacParameters() const = 0;

    virtual void setMacParameters(const EDLString &params) = 0;

    virtual EDLString getUnixParameters() const = 0;

    virtual void setUnixParameters(const EDLString &params) = 0;

    virtual bool getNewWindow() const = 0;

    virtual void setNewWindow(bool bNewWindow) = 0;

    virtual eTargetType getTargetType() const
    {
        return eActionLaunch;
    }
 
};
 
DECL_SMART_PTR(IDOMActionLaunch);
#define edlobj2IDOMActionLaunch(src) edl_cast((IDOMActionLaunch *)NULL, src)
 
typedef IInputEnumRC<IDOMTargetPtr> IDOMTargetCollectionEnum;
DECL_SMART_PTR(IDOMTargetCollectionEnum);

class IDOMActionArray : public IDOMTarget
{
#define IDOMActionArrayClassID 0x52205412, 0xfaf74a65, 0x9d1d5e19, 0x9d15ece6
  public:
 
    DECLARE_CLASS_ID(IDOMActionArrayClassID);

    virtual IDOMTargetCollectionEnumPtr getActionsEnum() = 0;

    virtual uint32 getActionsCount() = 0;

    virtual void clearActions() = 0;

    virtual bool addAction(const IDOMTargetPtr &ptrAction) = 0;

    virtual eTargetType getTargetType() const
    {
        return eActionArray;
    }
 
};
 
DECL_SMART_PTR(IDOMActionArray);
#define edlobj2IDOMActionArray(src) edl_cast((IDOMActionArray *)NULL, src)
 
_END_EDL_DOM_NAMESPACE
 
#endif // EDLIDOMTARGET_H