camdoc.h

Go to the documentation of this file.

// $Id: camdoc.h 1009 2006-05-11 15:52:04Z phil $
/* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
================================XARAHEADERSTART===========================
 
               Xara LX, a vector drawing and manipulation program.
                    Copyright (C) 1993-2006 Xara Group Ltd.
       Copyright on certain contributions may be held in joint with their
              respective authors. See AUTHORS file for details.

LICENSE TO USE AND MODIFY SOFTWARE
----------------------------------

This file is part of Xara LX.

Xara LX is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as published
by the Free Software Foundation.

Xara LX and its component source files are distributed in the hope
that it will be useful, but WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with Xara LX (see the file GPL in the root directory of the
distribution); if not, write to the Free Software Foundation, Inc., 51
Franklin St, Fifth Floor, Boston, MA  02110-1301 USA


ADDITIONAL RIGHTS
-----------------

Conditional upon your continuing compliance with the GNU General Public
License described above, Xara Group Ltd grants to you certain additional
rights. 

The additional rights are to use, modify, and distribute the software
together with the wxWidgets library, the wxXtra library, and the "CDraw"
library and any other such library that any version of Xara LX relased
by Xara Group Ltd requires in order to compile and execute, including
the static linking of that library to XaraLX. In the case of the
"CDraw" library, you may satisfy obligation under the GNU General Public
License to provide source code by providing a binary copy of the library
concerned and a copy of the license accompanying it.

Nothing in this section restricts any of the rights you have under
the GNU General Public License.


SCOPE OF LICENSE
----------------

This license applies to this program (XaraLX) and its constituent source
files only, and does not necessarily apply to other Xara products which may
in part share the same code base, and are subject to their own licensing
terms.

This license does not apply to files in the wxXtra directory, which
are built into a separate library, and are subject to the wxWindows
license contained within that directory in the file "WXXTRA-LICENSE".

This license does not apply to the binary libraries (if any) within
the "libs" directory, which are subject to a separate license contained
within that directory in the file "LIBS-LICENSE".


ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
----------------------------------------------

Subject to the terms of the GNU Public License (see above), you are
free to do whatever you like with your modifications. However, you may
(at your option) wish contribute them to Xara's source tree. You can
find details of how to do this at:
  http://www.xaraxtreme.org/developers/

Prior to contributing your modifications, you will need to complete our
contributor agreement. This can be found at:
  http://www.xaraxtreme.org/developers/contribute/

Please note that Xara will not accept modifications which modify any of
the text between the start and end of this header (marked
XARAHEADERSTART and XARAHEADEREND).


MARKS
-----

Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
designs are registered or unregistered trademarks, design-marks, and/or
service marks of Xara Group Ltd. All rights in these marks are reserved.


      Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
                        http://www.xara.com/

=================================XARAHEADEREND============================
 */

/*
    camdoc.h : interface of the CCamDoc class
*/

#ifndef INC_CAMDOC_H
#define INC_CAMDOC_H

// Forward references.
class Document;
class DocRect;
class PathName;
class CCamApp;
class CCLexFile;

/**********************************************************************************
>   class CCamDoc : public COleServerDoc (MFC 2.5)

    Author:     Luke_Hart (Xara Group Ltd) <camelotdev@xara.com> (originally from samples\docvwmdi) with mods.
    Created:    01/07/05
    
    Purpose:    This is the wxWidgets class for a document type object in the OIL (it was
                originally part of wxWidgets example app. docvwmdi).  It is very simple - 
                its main use is getting hold of the relevant Document object from the kernel
                layer.  wxWidgets calls various member functions when processing commands
                from the File menu.  This class calls down into the kernel to do
                the actual work.
    
    SeeAlso:    Document
***********************************************************************************/

class CCamDoc :
    public wxDocument
{
public:
    CCamDoc( Document *pKernelDoc = NULL );
    ~CCamDoc();

    // Returns a pointer to the kernel document associated with this.
    Document *GetKernelDoc() const;

    // Serialization support
    virtual bool OnNewDocument();
    virtual bool OnSaveDocument(const wxString& filename);
    virtual bool OnOpenDocument(const wxString& filename);

    // override wxDocument::SaveAs
    virtual bool SaveAs();

    // Some CDocument emulation stuff
    void SetModifiedFlag( BOOL fMod = TRUE ) { Modify( FALSE != fMod ); }

    // Framwwork titles, paths, & filenames.
    virtual void SetTitle(LPCTSTR lpszTitle);
    virtual void SetPathName(LPCTSTR lpszPathName, BOOL bAddToMRU = TRUE);
    void SetPathNameEmpty();
    void SetDocName(LPCTSTR lpszTitle);

    // Kernel titles, paths, and filenames.
    String_256 GetKernelTitle();
    String_256 GetKernelPathName(UINT32 MaxSize = 0);
    String_256 GetKernelDocName(BOOL IncludeFileType = TRUE);
    String_256 GetKernelLocation(UINT32 MaxSize = 0);

    // The original file that this Camelot doc was based on, if they still correspond.
    String_256 GetOriginalPath() const;
    void SetOriginalPath(const String_256& strPath);

    // Sets or clears the document's flags.
    void SetModified(bool fState);
    void SetReadOnly(bool fState);
    void SetCopy(bool fState);

    // Test the above flags (note that MFC defines the IsModified() function).
    bool IsReadOnly() const;
    bool IsACopy() const;
    bool IsUntouched() const;
    bool IsModifiable() const;

    // Call this to set the document flags MFC uses to decide if a save is Save, Save As,
    // or Save Copy As.
    void SetSaveFlags(BOOL fSameAsLoad, BOOL fRememberName)
    {
    #if (_OLE_VER >= 0x200)
        m_bSameAsLoad = fSameAsLoad; m_bRemember = fRememberName;
    #endif
    }

    // This returns the file-name of the template document for this kind of
    // document (normally 'template.xar', for embedded documents it's 'embedded.xar'
    //virtual void GetTemplateFilename(String_256* pstr) const;

    //Graham 21/10/97: New template stuff
public:
    PathName GetTemplate() const;
    void SetTemplate( const PathName &pathToSet = PathName() );

    static PathName GetNextTemplateToUse();
    static void SetNextTemplateToUse(const PathName& pathToSet=PathName());
    
protected:
    PathName m_pathTemplate;
    static PathName ms_pathNextTemplateToUse;

protected:
    // This creates a CCOleStream or a CCDiskFile for OnOpenDocument and
    // OnSaveDocument, according to their role (server doc or normal doc).
    virtual CCLexFile* CreateCCFile(LPCTSTR lpcszPath, INT32 nOpenMode);

    // Useful helper functions.
    // Functions to help with the opening of documents
    virtual bool DefaultDocumentRequired(CCLexFile* pFile, UINT32 nPrefFilter);
    virtual bool LoadDefaultDocument();
    virtual bool GeneralOpenDocument(CCLexFile* pFile, UINT32 nPrefFilter);
    virtual bool OnSaveModified();
    virtual bool DoSave(LPCTSTR lpszPathName, BOOL bReplace = TRUE);
    virtual bool DeleteContents();

    BOOL RemoveExistingDocs();

    // These perform the actual loading and saving of the document, without
    // touching the doc's flags etc.
    virtual bool DoNewDocument();
    virtual bool DoOpenDocument( const wxString &strFilename );
    virtual bool DoSaveDocument( const wxString &strFilename );

// Implementation.

public:

    // Public so that Document can get at it (?)
    static BOOL s_RemoveExistingOnNewDoc;

    // Don't want or need a stinking wxCommandProcessor, we do our own undo\redo handling
    virtual wxCommandProcessor *OnCreateCommandProcessor() { return NULL; }

    static BOOL EnableRemoveUntouchedDocs();
//  static BOOL RemoveUntouchedDocs();
//  static BOOL IdleDocumentProcess();
//  static BOOL MarkAllDocsUntouched(CWinApp* pApp);

private:
    // Helpers.
    void UpdateTitle();
//  BOOL AnotherIsMaximised();          // TRUE is a view onto another doc is maximised.

    // Data members.
    Document          *m_pKernelDoc;            // points to this object's alter-ego
    bool                m_fIsReadOnly;          // "is modified" flag and functions.
    bool                m_fIsACopy;
    bool                m_fIsUntouched;         // ...by human hand.
    String_256          m_TitlePrefix;          // essentially the document name
    String_256          m_strOriginalPath;      // the file that this doc was loaded from if
                                                // it wasn't from a .ART file or the default document,
                                                // empty if this doc is new or no longer corresponds
    bool                m_bIsModifiable;        // Is this doc modifiable?
    LPTSTR              m_lpszInitialZoomOp;    // the initial zoom Op to perform, if any
    bool                m_fDoneNewDoc;          // bodge-flag to stop OLE calling OnNewDoc twice (??)

//  static BOOL         s_fRunIdleProcessing;   // Do some Document work on next idle event
    static Document    *s_pForceDocument;

public:
    // Originaly OLE related, hardcoded to true now
    bool IsVisible() const  { return true; }

private:
    DECLARE_DYNAMIC_CLASS(CCamDoc)
};

#endif

---