class CCL::DocumentPerspective

Overview

#include <documentperspective.h>

class DocumentPerspective:
    public CCL::Object,
    public CCL::IDocumentView,
    public CCL::IPerspectiveActivator
{
public:
    // fields

    IPerspective* perspective;
    IPerspective StringID viewID;
    IPerspective StringID StringID altPerspectiveID;
    CLASS_INTERFACE2 (IDocumentView, IPerspectiveActivator, Object) protected IWorkspace* workspace;
    MutableCString viewID;
    MutableCString altPerspectiveID;
    IImage* icon;
    bool closing;

    // methods

    DECLARE_CLASS_ABSTRACT (DocumentPerspective, Object);
    virtual void activateDocumentView ();
    virtual void closeDocumentView ();
    virtual bool isDocumentVisible () const;
    virtual String CCL_API getPerspectiveTitle ();
    virtual String CCL_API getPerspectiveDescription ();
    virtual IImage*CCL_API getPerspectiveIcon ();
    virtual void CCL_API activatePerspective ();
    virtual void CCL_API notifyPerspectiveSelected ();
    virtual void CCL_API notify (ISubject* subject, MessageRef msg);
    void setPerspective (IPerspective* perspective, StringID viewID = nullptr);
    static IWorkspace* getWorkspace ();
    static IPerspective* createPerspective (StringID perspectiveID);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;
    Unknown& operator = (const Unknown&);
    unsigned int getRetainCount () const;
    virtual Object*CCL_API revealObject (const void* moduleAddress) = 0;
    virtual void CCL_API addObserver (IObserver* observer) = 0;
    virtual void CCL_API removeObserver (IObserver* observer) = 0;
    virtual void CCL_API signal (MessageRef msg) = 0;
    virtual void CCL_API deferSignal (IMessage* msg) = 0;
    static ISubject void addObserver (IUnknown* unknown, IObserver* observer);
    static void removeObserver (IUnknown* unknown, IObserver* observer);
    virtual void CCL_API notify (ISubject* subject, MessageRef msg) = 0;

    static IObserver void notify (
        IUnknown* unknown,
        ISubject* subject,
        MessageRef msg
    );

    virtual const ITypeInfo&CCL_API getTypeInfo () const = 0;
    virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const = 0;
    virtual tbool CCL_API setProperty (MemberID propertyId, const Variant& var) = 0;
    virtual tbool CCL_API getPropertyNames (IPropertyCollector& collector) const = 0;
    virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg) = 0;
    DECLARE_BASE_CLASS (Object);
    virtual void CCL_API removeObserver (IObserver* observer);
    virtual void CCL_API signal (MessageRef msg);
    virtual void CCL_API deferSignal (IMessage* msg);
    virtual void deferChanged ();
    virtual void CCL_API notify (ISubject* subject, MessageRef msg);
    virtual bool equals (const Object& obj) const;
    virtual int compare (const Object& obj) const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
    virtual bool save (const OutputStorage& storage) const;
    virtual bool toString (String& string, int flags = 0) const;
    virtual int getHashCode (int size) const;
    IUnknown* asUnknown ();
    static void addGarbageCollected (Object* obj, bool globalScope = true);
    static void deferDestruction (Object* obj);
    static const void* getModuleAddress ();
    virtual void activateDocumentView () = 0;
    virtual void closeDocumentView () = 0;
    virtual bool isDocumentVisible () const = 0;
    virtual String CCL_API getPerspectiveTitle () = 0;
    virtual String CCL_API getPerspectiveDescription () = 0;
    virtual IImage*CCL_API getPerspectiveIcon () = 0;
    virtual void CCL_API activatePerspective () = 0;
    virtual void CCL_API notifyPerspectiveSelected () = 0;

Detailed Documentation

Methods

virtual void closeDocumentView ()

should release object!

virtual String CCL_API getPerspectiveTitle ()

Get title for the perspective.

virtual String CCL_API getPerspectiveDescription ()

Get title for the perspective.

virtual IImage*CCL_API getPerspectiveIcon ()

Get icon for the perspective.

virtual void CCL_API activatePerspective ()

Active the perspective.

virtual void CCL_API notifyPerspectiveSelected ()

Notify before perspective selection is executed.

virtual void CCL_API notify (ISubject* subject, MessageRef msg)

Receive notification from subject.