sgbase.h

Go to the documentation of this file.

// $Id: sgbase.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============================
 */
// SGTEMPLATE.h - the TEMPLATESGallery (TEMPLATE SuperGallery) class


// You must do the following things:
//  1 Copy this file into your own header file, and screw that up, not this! ;-)
//  2 Strip back the topmost line to say '// #Header#' (where # is a dollar sign)
//  3 Change the INC_SGBASE lines below to relevant names
//  4 Do a GLOBAL, CASE SENSITIVE replace of 'TEMPLATE' with your gallery name (eg 'Bitmap')
//  5 Do a CASE SENSITIVE replace of 'DATATYPE' with your gallery type (eg 'KernelBitmap')
//    (This means a DisplayItem will hold a (KernelBitmap *) pointer, etc - search for
//    DATATYPE before replacing to see what I mean)
//  6 Do a global CASE SENSITIVE replace of 'AUTHOR' with your name
//  7 Delete these instructional comment lines
// Remember to add this new file to all.lst and kernel.mak

#ifndef INC_SGBASE
#define INC_SGBASE


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


class TEMPLATE;     // TO DO: You may or not need this
class DATATYPE;


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

>   class SGDisplayDATATYPE : public SGDisplayItem

    Author:     Unattributed (Xara Group Ltd) <camelotdev@xara.com> (Based on template code by Jason)
    Created:    27/01/95
    Purpose:    This DisplayTree node is used by the TEMPLATE SuperGallery
                It is responsible for providing the ability to handle/redraw one DATATYPE
                displayed in said gallery.

    SeeAlso:    TEMPLATESGallery; SuperGallery; SGDisplayItem

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

class CCAPI SGDisplayDATATYPE : public SGDisplayItem
{
    CC_DECLARE_DYNAMIC(SGDisplayDATATYPE);

public:
    SGDisplayDATATYPE();
    SGDisplayDATATYPE(DATATYPE *DATATYPEToDisplay);

    virtual BOOL HandleEvent(SGEventType EventType, void *EventInfo,
                             SGMiscInfo *MiscInfo);

    virtual void GetNameText(String_256 *Result);
            // Returns the name text for this item


protected:  // Internal handlers
    virtual void CalculateMyRect(SGFormatInfo *FormatInfo, SGMiscInfo *MiscInfo);
            // Determines item size for the current DisplayMode and calculates FormatRect

    virtual void HandleRedraw(SGRedrawInfo *RedrawInfo, SGMiscInfo *MiscInfo);
            // Redraws the item into the current FormatRect


public:     // Specialisations of this class
    inline DATATYPE *GetDisplayedDATATYPE(void);


private:        // Special member variables
    DATATYPE *TheDATATYPE;
};



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

>   inline DATATYPE *SGDisplayDATATYPE::GetDisplayedDATATYPE(void)

    Author:     Unattributed (Xara Group Ltd) <camelotdev@xara.com> (Based on template code by Jason)
    Created:    27/1/95

    Returns:    A pointer to the DATATYPE which this Display Item is used to display.
            
    Purpose:    To find out the DATATYPE this object is responsible for displaying

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

DATATYPE *SGDisplayDATATYPE::GetDisplayedDATATYPE(void)
{
    return(TheDATATYPE);
}






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

>   class TEMPLATESGallery : public SuperGallery

    Author:     Unattributed (Xara Group Ltd) <camelotdev@xara.com> (Based on template code by Jason)
    Created:    27/1/95 (Based on the Colour SGallery code)
    Purpose:    The TEMPLATE SuperGallery class

    Notes:      SuperGalleries are specced in a number of docs including
                    specs\sgallery.doc ("super" gallery extensions)
                    specs\propui.doc  (gallery basic ui)
                There is also howtouse\sgallery.doc which describes creating a supergallery

    SeeAlso:    SuperGallery; SGDisplayTEMPLATE

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

class TEMPLATESGallery : public SuperGallery
{
    CC_DECLARE_DYNCREATE(TEMPLATESGallery)

public:
    TEMPLATESGallery();
    ~TEMPLATESGallery();

    virtual MsgResult Message(Msg* Message);


protected:              // Overridden upcall methods
    virtual BOOL PreCreate(void);

    virtual BOOL ApplyAction(SGActionType Action);


protected:              // Personal/Internal methods
    void CreateNewSubtree(Document *ParentDoc, SGDisplayGroup *ExistingGroup = NULL);
            // Creates a new subtree group to display the TEMPLATEs for the given document
            // If ExistingGroup != NULL, that group will be re-cached for the given doc
};





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

>   class OpDisplayTEMPLATEGallery: public Operation

    Author:     Unattributed (Xara Group Ltd) <camelotdev@xara.com>
    Created:    9/2/95 (Based on the Colour SGallery code)

    Purpose:    Displays the TEMPLATE gallery.
                This op can be attached to a menu, button or keypress
    SeeAlso:    TEMPLATESGallery

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

#define OPTOKEN_DISPLAYTEMPLATEGALLERY _T("DisplayTEMPLATEGallery")

class CCAPI OpDisplayTEMPLATEGallery: public Operation
{         
    CC_DECLARE_DYNCREATE( OpDisplayTEMPLATEGallery );

public:
    static BOOL     Init();             
    static OpState  GetState(String_256*, OpDescriptor*);       
    void            Do(OpDescriptor*);

private:
    static DialogBarOp *FindGallery(void);
            // Finds the TEMPLATE gallery class instance
};  


#endif

---