class CCL::DocumentManager
Overview
#include <documentmanager.h> class DocumentManager: public CCL::Component, public CCL::IDocumentManager, public CCL::CommandDispatcher, public CCL::ComponentSingleton { public: // structs struct DirtySuspender; struct DocumentUsageSuspender; // classes class DocumentLoader; class DocumentSaver; class PreviewLoader; // fields ExternalFormatsEnabled SaveDisabled SkipDirtyCheck DirtySuspended AsyncLoadMode menuBar; ExternalFormatsEnabled SaveDisabled SkipDirtyCheck DirtySuspended AsyncLoadMode MenuBar bool isDefault = false); IDocumentManager; // methods DECLARE_CLASS (DocumentManager, Component); PROPERTY_BOOL (multipleDocuments, MultipleDocuments); ExternalFormatsEnabled PROPERTY_BOOL (previewEnabled, PreviewEnabled); ExternalFormatsEnabled SaveDisabled PROPERTY_BOOL (newDisabled, NewDisabled); ExternalFormatsEnabled SaveDisabled SkipDirtyCheck PROPERTY_BOOL ( skipAskSave, SkipAskSave ); ExternalFormatsEnabled SaveDisabled SkipDirtyCheck DirtySuspended PROPERTY_BOOL ( asyncAlertMode, AsyncAlertMode ); ExternalFormatsEnabled SaveDisabled SkipDirtyCheck DirtySuspended AsyncLoadMode PROPERTY_BOOL ( delayOpenDeferred, DelayOpenDeferred ); ExternalFormatsEnabled SaveDisabled SkipDirtyCheck DirtySuspended AsyncLoadMode MenuBar PROPERTY_POINTER ( IMenu, convertMenu, ConvertMenu ); bool addDocumentClass (UIDRef cid, bool isDefault = false); DocumentClass* findDocumentClass (const FileType& fileType) const; void findDocumentClasses (Container& result, const FileType& fileType) const; const Container& getDocumentClasses () const; void setViewFactory (IDocumentViewFactory* viewFactory); IDocumentViewFactory& getViewFactory (); Document* getDocument (int index) const; Document* getActiveDocument () const; bool setActiveDocument (Document* doc); Document* findDocument (UrlRef path) const; void addDocument (Document* doc); bool showDocument (Document* doc); void deferOpenDocument (UrlRef path, bool checkUpdates = false); bool canOpenDocument (UrlRef path) const; void signalDocumentEvent (Document& doc, int eventCode); bool closeAll (); void setDocumentFolder (UrlRef folder); void getDefaultDocumentFile (Url& path, const FileType& fileType) const; Url* findDocumentInFolder (UrlRef folder) const; bool renameDocument (UrlRef path, const String* newName = nullptr); bool renameDocument (Document* document, bool checkOnly = false); bool renameDocument (Document* doc, StringRef newName); bool deleteDocument (UrlRef path); bool saveDocument (Document* doc); RecentDocuments& getRecentPaths (); void updateDirtyState (const Document* document = nullptr); void updateApplicationTitle (); IDragHandler* createDragHandler (const DragEvent& event, IView* view); Document* openPreviewDocument (UrlRef path, StringID previewMode); Document* openPreviewTemplate ( UrlRef path, StringID previewMode, const FileType& docFileType ); Document* openPreviewTemplate ( const DocumentTemplate& docTemplate, StringID previewMode, const FileType& docFileType ); void closePreviewDocument (Document* doc); IAsyncOperation* openDocumentAsync (UrlRef path, int mode = 0); UrlRef CCL_API getDocumentFolder () const; virtual IDocument*CCL_API openDocument ( UrlRef path, int mode = 0, const IAttributeList* args = nullptr ); virtual IDocument*CCL_API createDocument ( const FileType* fileType = nullptr, int mode = 0, const IAttributeList* args = nullptr ); virtual tbool CCL_API closeDocument (IDocument* document, int mode = 0); virtual int CCL_API countDocuments () const; virtual void CCL_API addHandler (IDocumentEventHandler* handler); virtual void CCL_API removeHandler (IDocumentEventHandler* handler); virtual bool onFileOpen (CmdArgs args); virtual bool onFileNew (CmdArgs args); virtual bool onFileClose (CmdArgs args); virtual bool onFileCloseAll (CmdArgs args); virtual bool onFileSave (CmdArgs args); virtual bool onFileSaveAs (CmdArgs args); virtual bool onFileSaveAs (CmdArgs args, VariantRef data); virtual bool onFileSaveToNewFolder (CmdArgs args); virtual bool onFileSaveNewVersion (CmdArgs args); virtual bool onFileRestoreVersion (CmdArgs args); virtual bool onFileRename (CmdArgs args); virtual bool onFileRevert (CmdArgs args); virtual bool onEditUndo (CmdArgs args); virtual bool onEditRedo (CmdArgs args); virtual bool onEditDeleteHistory (CmdArgs args); virtual bool onEditShowHistory (CmdArgs args); virtual bool onOpenRecent (CmdArgs args); virtual bool onClearRecent (CmdArgs args); DECLARE_COMMANDS (DocumentManager) const; virtual tresult CCL_API initialize (IUnknown* context = nullptr); virtual tresult CCL_API terminate (); virtual tbool CCL_API canTerminate () const; virtual tbool CCL_API paramChanged (IParameter* param); virtual void CCL_API notify (ISubject* subject, MessageRef msg); virtual IObjectNode*CCL_API findChild (StringRef id) const; virtual tbool CCL_API getChildDelegates (IMutableArray& delegates) const; };
Inherited Members
public: // typedefs typedef CStringRef MemberID; // enums enum Flags; enum Modes; // structs struct ObjectEntry; // fields IObjectNode; StringRef title = nullptr); kMutable; UIDRef classID override; CLASS_INTERFACES (ObjectNode) protected String title; ParamContainer paramList; SignalSlotList signalSlots; LinkedList <ObjectEntry> objects; // 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 StringRef CCL_API getObjectID () const = 0; virtual UIDRef CCL_API getObjectUID () const = 0; virtual UIDRef CCL_API getClassUID () const = 0; virtual IObjectNode*CCL_API getParent () const = 0; virtual IObjectNode*CCL_API getRoot () const = 0; virtual int CCL_API countChildren () const = 0; virtual IObjectNode*CCL_API getChild (int index) const = 0; virtual IObjectNode*CCL_API findChild (StringRef id) const = 0; virtual tbool CCL_API getChildDelegates (IMutableArray& delegates) const = 0; virtual tbool CCL_API getChildPath (String& path) const = 0; virtual IObjectNode*CCL_API lookupChild (StringRef path) const = 0; virtual StringRef CCL_API getObjectID () const; virtual UIDRef CCL_API getObjectUID () const; virtual UIDRef CCL_API getClassUID () const; virtual IObjectNode*CCL_API getParent () const; virtual IObjectNode*CCL_API getRoot () const; virtual int CCL_API countChildren () const; virtual IObjectNode*CCL_API getChild (int index) const; virtual IObjectNode*CCL_API findChild (StringRef id) const; virtual tbool CCL_API getChildDelegates (IMutableArray& delegates) const; virtual tbool CCL_API getChildPath (String& path) const; virtual IObjectNode*CCL_API lookupChild (StringRef path) const; DECLARE_CLASS (ObjectNode, Object); void setName (StringRef name); bool setUniqueName (StringRef name); StringRef getName () const; virtual Iterator* newIterator () const; virtual bool addChild (ObjectNode* child); virtual bool insertChild (int index, ObjectNode* child); virtual bool addChildSorted (ObjectNode* child); virtual bool removeChild (ObjectNode* child); virtual void removeAll (); virtual ObjectNode* findChildNode (StringRef id) const; virtual ObjectNode* findChildNode (MetaClassRef typeID) const; template <class T> T* findChildNode (StringRef id) const; template <class T> T* findChildNode () const; template <class T> T* getChildNode (int index) const; template <class I> I* findChildByInterface (bool deep = false) const; ObjectNode* getChildNode (int index) const; int getChildIndex (const ObjectNode* child) const; virtual StringRef getChildID (const ObjectNode* child) const; ObjectNode* getParentNode () const; template <class T> T* getParentNode () const; bool getRelativePath (String& path, ObjectNode* subNode) const; void signalDeep (MessageRef msg, bool recursive = false); virtual void notifyChildren ( ISubject* subject, MessageRef msg, bool recursive = false ); tresult queryChildInterface (UIDRef iid, void** ptr, bool recursive = false); template <class Lambda> bool visitChildren ( const Lambda& visitLambda, bool recursive ) const; void dump (int level = 0); virtual StringRef CCL_API getObjectID () const; virtual UIDRef CCL_API getObjectUID () const; virtual UIDRef CCL_API getClassUID () const; virtual IObjectNode*CCL_API getParent () const; virtual IObjectNode*CCL_API getRoot () const; virtual int CCL_API countChildren () const; virtual IObjectNode*CCL_API getChild (int index) const; virtual IObjectNode*CCL_API findChild (StringRef id) const; virtual tresult CCL_API initialize (IUnknown* context = nullptr) = 0; virtual tresult CCL_API terminate () = 0; virtual tbool CCL_API canTerminate () const = 0; virtual IUnknown*CCL_API getExtension (StringID id) = 0; template <typename IFace> IFace* getExtensionI (); template <typename IFace> static IFace* getExtensionI (IUnknown* unk); virtual int CCL_API countParameters () const = 0; virtual IParameter*CCL_API getParameterAt (int index) const = 0; virtual IParameter*CCL_API findParameter (StringID name) const = 0; virtual IParameter*CCL_API getParameterByTag (int tag) const = 0; virtual IUnknown*CCL_API getObject (StringID name, UIDRef classID) = 0; virtual tbool CCL_API paramChanged (IParameter* param) = 0; virtual void CCL_API paramEdit (IParameter* param, tbool begin) = 0; virtual IView*CCL_API createView ( StringID name, VariantRef data, const Rect& bounds ) = 0; virtual tbool CCL_API checkCommandCategory (CStringRef category) const = 0; virtual tbool CCL_API interpretCommand (const CommandMsg& msg) = 0; virtual tresult CCL_API appendContextMenu (IContextMenu& contextMenu) = 0; DECLARE_CLASS (Component, ObjectNode); PROPERTY_FLAG (flags, kStorable, isStorable); isMutable StringRef getTitle () const; void setTitle (StringRef title); bool hasTitle () const; IUnknown* getContext () const; Component* getComponent (StringRef name) const; template <class C> C* getComponent (StringRef name) const; bool addComponent (Component* c); bool addIComponent (IComponent* c); void signalHasChild (Component* c); Component* lookupComponent (StringRef path) const; template <class C> C* lookupComponent (StringRef path) const; virtual tresult CCL_API initialize (IUnknown* context = nullptr); virtual tresult CCL_API terminate (); virtual tbool CCL_API canTerminate () const; virtual IUnknown*CCL_API getExtension (StringID id); DECLARE_PARAMETER_LOOKUP (paramList); virtual tbool CCL_API paramChanged (IParameter* param); virtual void CCL_API paramEdit (IParameter* param, tbool begin); virtual IView*CCL_API createView ( StringID name, VariantRef data, const Rect& bounds ); virtual tbool CCL_API checkCommandCategory (CStringRef category) const; virtual tbool CCL_API interpretCommand (const CommandMsg& msg); virtual tresult CCL_API appendContextMenu (IContextMenu& contextMenu); virtual ITheme* getTheme () const; virtual bool load (const Storage& storage); virtual bool save (const Storage& storage) const; virtual bool toString (String& string, int flags) const; void addObject (StringID name, IUnknown* object); void addObject (StringID name, Object* object); bool loadIdentity (const Storage& storage); bool saveIdentity (const Storage& storage) const; bool loadChild (const Storage& storage, Component& child); bool saveChild (const Storage& storage, const Component& child) const; bool loadChildren ( const Storage& storage, bool loadEmpty = false, bool onlyStorable = false ); bool saveChildren (const Storage& storage, bool onlyStorable = false) const; void signalHasChild (StringRef name); void signalPropertyChanged (StringID propertyID, bool deferred = false); void propertyChanged (StringID propertyID); IUnknown* resolveToOriginalContext (IUnknown* context); virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const; virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg); virtual DECLARE_STRINGID_MEMBER (kEventHandler) const = 0; virtual IDocument*CCL_API openDocument ( UrlRef path, int mode = 0, const IAttributeList* args = nullptr ) = 0; virtual IDocument*CCL_API createDocument ( const FileType* fileType = nullptr, int mode = 0, const IAttributeList* args = nullptr ) = 0; virtual tbool CCL_API closeDocument (IDocument* document, int mode = 0) = 0; virtual int CCL_API countDocuments () const = 0; virtual IDocument*CCL_API getIDocument (int index) const = 0; virtual IDocument*CCL_API getActiveIDocument () const = 0; virtual void CCL_API addHandler (IDocumentEventHandler* handler) = 0; virtual void CCL_API removeHandler (IDocumentEventHandler* handler) = 0; virtual IUnknownIterator*CCL_API newDocumentClassIterator () const = 0; virtual IDocumentClass*CCL_API findIDocumentClass (const FileType& fileType) const = 0; virtual void CCL_API listRecentDocuments (IUnknownList& urls) const = 0; DECLARE_STRINGID_MEMBER (kComponentName); bool dispatchCommand (const CommandMsg& msg); bool dispatchCommand ( const CommandMsg& msg, CommandDispatchEntry <T> dispatchTable [] ); bool dispatchCommandWithAliases (const CommandMsg& msg); static T& instance (); static T* peekInstance (); static Object* __createSingleton ();
Detailed Documentation
Fields
ExternalFormatsEnabled SaveDisabled SkipDirtyCheck DirtySuspended AsyncLoadMode MenuBar bool isDefault = false)
add internal document class
Methods
ExternalFormatsEnabled PROPERTY_BOOL (previewEnabled, PreviewEnabled)
< allow external document formats?
ExternalFormatsEnabled SaveDisabled PROPERTY_BOOL (newDisabled, NewDisabled)
< saving documents disabled?
ExternalFormatsEnabled SaveDisabled SkipDirtyCheck PROPERTY_BOOL ( skipAskSave, SkipAskSave )
< save document even if it is not dirty?
ExternalFormatsEnabled SaveDisabled SkipDirtyCheck DirtySuspended PROPERTY_BOOL ( asyncAlertMode, AsyncAlertMode )
< document dirty suspended (e.g. during load)?
ExternalFormatsEnabled SaveDisabled SkipDirtyCheck DirtySuspended AsyncLoadMode PROPERTY_BOOL ( delayOpenDeferred, DelayOpenDeferred )
< use async load mode
bool addDocumentClass (UIDRef cid, bool isDefault = false)
add external document class
Url* findDocumentInFolder (UrlRef folder) const
creates url of found document
bool renameDocument (UrlRef path, const String* newName = nullptr)
shows rename dialog if newName == 0
bool renameDocument (Document* document, bool checkOnly = false)
shows rename dialog
bool renameDocument (Document* doc, StringRef newName)
no dialog
virtual tresult CCL_API initialize (IUnknown* context = nullptr)
Initialize plug-in component within specified context.
virtual tresult CCL_API terminate ()
Terminate plug-in component.
virtual tbool CCL_API canTerminate () const
Check if plug-in component can be terminated.
virtual tbool CCL_API paramChanged (IParameter* param)
The given parameter changed its value, usually caused by user interaction.
virtual void CCL_API notify (ISubject* subject, MessageRef msg)
Receive notification from subject.
virtual IObjectNode*CCL_API findChild (StringRef id) const
Find child by string identifier.
virtual tbool CCL_API getChildDelegates (IMutableArray& delegates) const
Get identifiers of child delegates, i.e.
accessible via findChild(), but no direct descendants.