class CCL::DocumentClass

Overview

#include <document.h>

class DocumentClass:
    public CCL::Object,
    public CCL::IDocumentClass
{
public:
    // fields

     templateType;
    TemplateType kCanLoad;
    TemplateType canLoad kNeedsFolder;
     IDocumentClass;

    // construction

    DocumentClass (int flags = kCanLoad|kCanSave);

    // methods

    DECLARE_CLASS_ABSTRACT (DocumentClass, Object);
    void setFileType (const FileType& fileType);
    virtual const FileType&CCL_API getFileType () const;
    virtual tbool CCL_API isNative () const;
    PROPERTY_VARIABLE (int, formatVersion, FormatVersion);
    TemplateType PROPERTY_VARIABLE (int, flags, Flags);
    TemplateType canLoad PROPERTY_FLAG (flags, kCanSave, canSave);
    TemplateType canLoad needsFolder PROPERTY_FLAG (flags, kIsPrivate, isPrivate);

    TemplateType canLoad needsFolder SubFolder PROPERTY_STRING (
        defaultTitle,
        DefaultTitle
    );

    virtual TemplateType canLoad needsFolder SubFolder virtual MenuVariant String makeTitle () const;
    virtual Document* createDocument () = 0;
    virtual DocumentTemplate* createDefaultTemplate ();
    virtual void getUserTemplateFolders (StringList& folderNames);
    virtual Component* createNewDialog (Document& document, StringID contextId);
    virtual DocumentClass* getTargetClass ();
    virtual void installFile (Url& path);
    virtual bool canImportFile (UrlRef path) const;
    virtual bool loadDocument (Document& document);
    virtual bool saveDocument (Document& document);
    virtual bool canSaveDocument (Document& document) const;
    virtual bool saveDocumentAs (Document& document, UrlRef path);
    virtual bool finalizeSaveDocumentAs (Document& document, UrlRef path);
    virtual bool canMergeDocuments (Document& target, UrlRef sourcePath);
    virtual bool mergeDocuments (Document& target, Document& source);
};

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 tbool CCL_API isNative () const = 0;
    virtual const FileType&CCL_API getFileType () const = 0;
    virtual StringRef CCL_API getSubFolderName () const = 0;
    virtual tbool CCL_API isPrivateClass () const = 0;

Detailed Documentation

Methods

virtual const FileType&CCL_API getFileType () const

[IDocumentClass]

virtual tbool CCL_API isNative () const

[IDocumentClass]

TemplateType PROPERTY_VARIABLE (int, flags, Flags)

< associated template file type (optional)

TemplateType canLoad needsFolder PROPERTY_FLAG (flags, kIsPrivate, isPrivate)

< document needs an own folder

TemplateType canLoad needsFolder SubFolder PROPERTY_STRING (
    defaultTitle,
    DefaultTitle
)

< subfolder in document folder

virtual TemplateType canLoad needsFolder SubFolder virtual MenuVariant String makeTitle () const

< menubar variant

make title for new document

virtual Component* createNewDialog (Document& document, StringID contextId)

create new document dialog component (optional)

virtual DocumentClass* getTargetClass ()

specify the document to be created for import (optional, override default class)