doccomp.h

Go to the documentation of this file.

// $Id: doccomp.h 1302 2006-06-12 21:02:01Z 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============================
 */

// Declaration of the Document Component objects

#ifndef INC_DOCCOMP
#define INC_DOCCOMP

#include "listitem.h"
#include "document.h"

class BaseDocument;
class EPSFilter;
class BaseCamelotFilter;

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

>   class DocComponentClass : public ListItem

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    01/08/94
    Purpose:    This provides a class of objects which implement an interface to a particular 
                kind of document component - for example a colour table, or a list of
                arrowheads.
                Each kind of object should register with the application on startup, and
                then when a document is created, each of these objects is asked to add
                an instance of a DocumentComponent object to it.  The DocumentComponent
                objects are the actual implemtations of the components.  For example, they
                contain the colours for a colour list, and so on.  This class, the
                DocumentComponentClass, is merely for registering the existence of a new
                kind of document component, and providing a mechanism for inserting them
                into new documents.
    SeeAlso:    DocumentComponent

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

class DocComponentClass : public ListItem
{
    CC_DECLARE_DYNAMIC(DocComponentClass)

public:
    virtual BOOL AddComponent(BaseDocument *) = 0;
};



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

>   class DocComponent : public ListItem

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    01/08/94
    Purpose:    An implementation of an instance of a document component, such as a colour
                table, or a list of arrowheads.  These are the objects that are 
                instantiated for each Document object that exists, and are held in a list
                in each Document object.
    SeeAlso:    DocumentComponentClass

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

class DocComponent : public ListItem
{
    CC_DECLARE_DYNAMIC(DocComponent)

public:
    // These are the Camelot Version 2 Web and Native file related functions
    virtual BOOL StartImport(BaseCamelotFilter *pFilter);
    virtual BOOL EndImport(BaseCamelotFilter *pFilter, BOOL Success);

    virtual BOOL StartExport(BaseCamelotFilter *pFilter);               // Set up export data structures
    virtual BOOL StartExportBeforeComp(BaseCamelotFilter *pFilter);
    virtual BOOL EndExport(BaseCamelotFilter *pFilter, BOOL Success);   // Write out pending data
    virtual void CleanUpAfterExport(BOOL Success);                      // Destroy export data structures

    // -------------------------------
    
    // These are the EPS related functions - covers from simple EPS to the old native EPS formats
    virtual BOOL EPSStartImport(EPSFilter *);
    virtual void EPSEndImport(EPSFilter *, BOOL);
    virtual BOOL EPSStartExport(EPSFilter *);
    virtual void EPSEndExport(EPSFilter *);

    virtual BOOL WriteEPSProlog(EPSFilter *);
    virtual BOOL WriteEPSSetup(EPSFilter *);
    virtual BOOL WriteEPSComments(EPSFilter *);
    virtual BOOL WriteScript(EPSFilter*);

    virtual ProcessEPSResult ProcessEPSComment(EPSFilter *, const TCHAR *);
    virtual void EndOfEPSComment(EPSFilter *);

    // More general function to control progress display.
    virtual INT32 GetSizeOfExport(Filter*);

    // Methods called before and after a tree copy
    virtual BOOL StartComponentCopy();
    virtual BOOL EndComponentCopy(); 
    virtual void AbortComponentCopy();  
};



#endif  // INC_DOCCOMP

---