backgrnd.h

Go to the documentation of this file.

// $Id: backgrnd.h 1282 2006-06-09 09:46:49Z 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============================
 */
// Defines the OpBackground class

#ifndef INC_BACKGROUND_H
#define INC_BACKGROUND_H

//#include "undoop.h" - in camtypes.h [AUTOMATICALLY REMOVED]

#if !defined(EXCLUDE_FROM_RALPH)

class Document;
class Spread;
class Layer;
class DocRect;
class KernelBitmap;
class DocColour;
class NodeRegularShape;

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

>   class OpBackgroundParam : public OpParam

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    26/3/97
    Purpose:    Param passed to OpBackground::DoWithParams()

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

class OpBackgroundParam : public OpParam
{
    CC_DECLARE_MEMDUMP(OpBackgroundParam)

public:
    OpBackgroundParam() { pDoc = NULL; pSpread = NULL; pDocColour = NULL; pBitmap = NULL; } 

public:
    Document *  pDoc;
    Spread *    pSpread;

    DocColour * pDocColour;
    KernelBitmap * pBitmap;
};

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

>   class OpBackground : public UndoableOperation

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    26/3/97
    Purpose:    Allows the background layer to be set up and changed

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

class OpBackground : public UndoableOperation
{

CC_DECLARE_DYNCREATE(OpBackground);

public:
    #define OPTOKEN_BACKGROUND _T("Background") 

    // Construction/Destruction
    OpBackground();
    ~OpBackground();

    virtual void DoWithParam(OpDescriptor* pOpDesc,OpParam* pParam);

//  virtual BOOL Undo();
//  virtual BOOL Redo();
    
    // These functions required for the OpDescriptor class
    static BOOL Init();
    static OpState GetState(String_256* Description, OpDescriptor*);
    void GetOpName(String_256* OpName);

    static BOOL FixBackgroundLayer(Layer * pLayer, const DocRect& NewPagesRect, const DocRect& OldPagesRect);

    // These should be useable by outside ops 
    static BOOL MakePageBackground(UndoableOperation * pOp, Spread * pSpread, DocColour * pDocColour);
    static BOOL MakePageBackground(UndoableOperation * pOp, Spread * pSpread, KernelBitmap * pBitmap);
    static BOOL GetPageColour(Spread *pSpread, KernelBitmap **pOutBitmap, DocColour **pOutColour);

protected:
    // The all important Do functions

    // This is the main workhorse
    static BOOL DoMakePageBackground(UndoableOperation * pOp, Spread * pSpread, KernelBitmap * pBitmap,
                                     DocColour * pDocColour = NULL);
    
    // Creating the special page background layer
    static Layer* CreateBackgroundLayer();
    static Layer* DoCreateBackgroundLayer(UndoableOperation * pOp, Spread * pSpread);

    // Finding and creating the page covering retangle
    static NodeRegularShape * DoFindPageRectangle(Spread * pSpread, Layer* pBackgroundLayer);
    static NodeRegularShape * DoCreateRectangle(Spread * pSpread);
    static NodeRegularShape * FindPageRectangle(Layer* pBackgroundLayer, const DocRect& PagesRect);

    // Applying the attributes to the rectangle
    static BOOL ApplyDocColour(DocColour * pColourToApply, NodeRegularShape * pShape);
    static BOOL ApplyBitmap(KernelBitmap * pBitmapToApply, NodeRegularShape * pShape);
    static BOOL ApplyDefaultAttributes(NodeRegularShape * pShape);

private:
    // The member variables
//  Document *      m_pDoc;
//  Spread *        m_pSpread;
//  DocColour *     m_pDocColour;
//  KernelBitmap *  m_pBitmap;

    // Versions of the parameters used in the drag and drop process
//  KernelBitmap *  m_pDroppedBitmap;
//  DocColour *     m_pDroppedDocColour;
};

#endif
#endif // INC_BACKGROUND_H

---