lddirect.cpp

Go to the documentation of this file.

// $Id: lddirect.cpp 1320 2006-06-14 14:39:32Z alex $
/* @@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============================
 */

#include "camtypes.h"
#include "camdoc.h"
#include "camelot.h"
#include "lddirect.h"
//#include "document.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "docview.h" - in camtypes.h [AUTOMATICALLY REMOVED]

CC_IMPLEMENT_MEMDUMP(LoadDirect, CC_CLASS_MEMDUMP);

DECLARE_SOURCE("$Revision: 1320 $");


/*****************************************************************************************

>   BOOL LoadDirect::Execute(const TCHAR* lpszFilename)

    Author:     Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
    Created:    06/08/96
    Inputs:     lpszFilename = the filename of the document to load.
    Outputs:    -
    Returns:    TRUE if the document was loaded correctly
                FALSE if not
                either (1) theres no application present (unlikely)
                       (2) unable to find the named file to load
                       (3) unable to load the named file due to error
                       (4) there was no kernel document resulting from the load
                       (5) the users OnLoadDocument returned an error

    Purpose:    Execute the action of loading a named document, calling a subclass
                virtual function 'OnLoadDocument' and killing the loaded document.
                The selected document and view will be retained by this function
    
    Notes:      This all works via the MFC. It is impossible to load and format a 
                native document without such things as cam views, doc view, ruler, doc
                scaling objects, doc status objects etc. All format and rendering
                of objects requires this plethora of structures to be present. Hence
                we simulate an MFC OnLoadDocument without actually opening the created
                view in order to do this.


*****************************************************************************************/

BOOL LoadDirect::Execute(const TCHAR* lpszFilename)
{
    // find our main application object
    CCamApp *pApp = (CCamApp*)&AfxGetApp();
    if (!pApp)
        return FALSE;

    // Recode the currently selected document, view and spread
    Document    *OldSelDocument = Document::GetSelected();
    DocView     *OldSelView     = DocView::GetSelected();
    Spread      *OldSelSpread   = Document::GetSelectedSpread();

    // call the loader
    BOOL ok = ExecuteHelper(pApp, lpszFilename);

    // reset the previous selected state.
    if (OldSelDocument != NULL)
        Document::SetSelectedViewAndSpread(OldSelDocument,OldSelView,OldSelSpread);

    // return the user state.
    return ok;
}


/*****************************************************************************************

    BOOL LoadDirect::ExecuteHelper(CCamApp* pApp, const TCHAR* lpszFilename)

    Author:     Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
    Created:    07/08/96
    Inputs:     lpszFilename = the filename of the document to load.
    Outputs:    -
    Returns:    TRUE if the document was processed correctly
                FALSE if not
    Purpose:    Helps out by conditioning its parent. ie, by making the parent routine
                less complex in its condition paths.
    
*****************************************************************************************/

BOOL LoadDirect::ExecuteHelper(CCamApp* pApp, const TCHAR* lpszFilename)
{
    BOOL ok=TRUE;

    PORTNOTETRACE("other", "Disabled LoadDirect::ExecuteHelper");
#ifndef EXCLUDE_FROM_XARALX

    // now call the supporting open document function
    CDocument* pLoadDirectDoc = pApp->OpenHiddenDocument(lpszFilename);
    if (pLoadDirectDoc==NULL)
        return FALSE;

    // assume its a cam doc we have created, and find its kernel doc
    CCamDoc* pCamDoc = (CCamDoc*)pLoadDirectDoc;
    Document* pRealDoc = pCamDoc->GetKernelDoc();

    // call the user function for document decoding
    ok = (pRealDoc!=NULL);
    ok = ok && (OnLoadDocument(pRealDoc));

    // finally toast the loaded document. 
    pCamDoc->SetModified(FALSE);
    pCamDoc->OnCloseDocument();
#endif

    return ok;
}




/*****************************************************************************************

>   BOOL LoadDirect::OnLoadDocument(Document* pKernelDoc)

    Author:     Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
    Created:    06/08/96
    Inputs:     pKernelDoc = a pointer to the loaded kernel document
    Outputs:    -
    Returns:    TRUE if the document was processed correctly
                FALSE if not

    Purpose:    Having successfully loaded the document, this function will be called to
                process the loaded data. The kernel document can be used to scan the
                document tree and perform any actions necessary. On return from this
                function the calling framework will delete the document and all its
                associated structures.
    
*****************************************************************************************/

BOOL LoadDirect::OnLoadDocument(Document* pKernelDoc)
{
    ERROR3("The base class LoadDirect::OnLoadDocument() has been called, where's your derived class?");
    return FALSE;
}

---