colmsg.h

Go to the documentation of this file.
00001 // $Id: colmsg.h 751 2006-03-31 15:43:49Z alex $
00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
00003 ================================XARAHEADERSTART===========================
00004  
00005                Xara LX, a vector drawing and manipulation program.
00006                     Copyright (C) 1993-2006 Xara Group Ltd.
00007        Copyright on certain contributions may be held in joint with their
00008               respective authors. See AUTHORS file for details.
00009 
00010 LICENSE TO USE AND MODIFY SOFTWARE
00011 ----------------------------------
00012 
00013 This file is part of Xara LX.
00014 
00015 Xara LX is free software; you can redistribute it and/or modify it
00016 under the terms of the GNU General Public License version 2 as published
00017 by the Free Software Foundation.
00018 
00019 Xara LX and its component source files are distributed in the hope
00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the
00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00022 See the GNU General Public License for more details.
00023 
00024 You should have received a copy of the GNU General Public License along
00025 with Xara LX (see the file GPL in the root directory of the
00026 distribution); if not, write to the Free Software Foundation, Inc., 51
00027 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
00028 
00029 
00030 ADDITIONAL RIGHTS
00031 -----------------
00032 
00033 Conditional upon your continuing compliance with the GNU General Public
00034 License described above, Xara Group Ltd grants to you certain additional
00035 rights. 
00036 
00037 The additional rights are to use, modify, and distribute the software
00038 together with the wxWidgets library, the wxXtra library, and the "CDraw"
00039 library and any other such library that any version of Xara LX relased
00040 by Xara Group Ltd requires in order to compile and execute, including
00041 the static linking of that library to XaraLX. In the case of the
00042 "CDraw" library, you may satisfy obligation under the GNU General Public
00043 License to provide source code by providing a binary copy of the library
00044 concerned and a copy of the license accompanying it.
00045 
00046 Nothing in this section restricts any of the rights you have under
00047 the GNU General Public License.
00048 
00049 
00050 SCOPE OF LICENSE
00051 ----------------
00052 
00053 This license applies to this program (XaraLX) and its constituent source
00054 files only, and does not necessarily apply to other Xara products which may
00055 in part share the same code base, and are subject to their own licensing
00056 terms.
00057 
00058 This license does not apply to files in the wxXtra directory, which
00059 are built into a separate library, and are subject to the wxWindows
00060 license contained within that directory in the file "WXXTRA-LICENSE".
00061 
00062 This license does not apply to the binary libraries (if any) within
00063 the "libs" directory, which are subject to a separate license contained
00064 within that directory in the file "LIBS-LICENSE".
00065 
00066 
00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
00068 ----------------------------------------------
00069 
00070 Subject to the terms of the GNU Public License (see above), you are
00071 free to do whatever you like with your modifications. However, you may
00072 (at your option) wish contribute them to Xara's source tree. You can
00073 find details of how to do this at:
00074   http://www.xaraxtreme.org/developers/
00075 
00076 Prior to contributing your modifications, you will need to complete our
00077 contributor agreement. This can be found at:
00078   http://www.xaraxtreme.org/developers/contribute/
00079 
00080 Please note that Xara will not accept modifications which modify any of
00081 the text between the start and end of this header (marked
00082 XARAHEADERSTART and XARAHEADEREND).
00083 
00084 
00085 MARKS
00086 -----
00087 
00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
00089 designs are registered or unregistered trademarks, design-marks, and/or
00090 service marks of Xara Group Ltd. All rights in these marks are reserved.
00091 
00092 
00093       Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
00094                         http://www.xara.com/
00095 
00096 =================================XARAHEADEREND============================
00097  */
00098 /*
00099  * */
00100 
00101 // Definition of Colour messages
00102 
00103 #ifndef INC_COLMSG
00104 #define INC_COLMSG
00105 
00106 class Document; 
00107 class ColourList;
00108 class IndexedColour;
00109 
00110 
00111 
00112 /*********************************************************************************************
00113 
00114 >   class ColourChangingMessage : public Msg
00115 
00116     Author:     Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
00117     Created:    11/5/94
00118     Purpose:    This message is sent whenever certain events of importance happen in the
00119                 colour system. Most of these events relate to IndexedColour lists, or
00120                 individual IndexedColours.
00121                 See Develop:Camelot\Docs\howtouse\message.doc for details.
00122 
00123     SeeAlso:    ColourManager
00124 
00125 *********************************************************************************************/
00126 
00127 class ColourChangingMsg : public Msg
00128 {
00129     CC_DECLARE_DYNAMIC(ColourChangingMsg)
00130 
00131 public:
00132     // list messages are sent on these events.
00133     enum ColourState
00134     {
00135         LISTPAGED,                      // Sent when a different list is paged in
00136         LISTUPDATED,                    // Sent when the existing list is edited
00137         COLOURUPDATED,                  // Sent when a colour has changed (visibly - see below)
00138         COLOURUPDATEDINVISIBLE,         // Sent when a colour has changed (invisibly - see below)
00139         LISTDESELECTED,                 // Sent when there is now no selected list
00140         LISTDELETED,                    // Sent when a list has been deleted
00141 
00142         NEWLISTBORN,                    // Sent when a new list is created, so that
00143                                         // others can add sort modes to it.
00144 
00145         SELVIEWCONTEXTCHANGE            // Sent when the colour context attached to the
00146                                         // selected view changes (so the col editor, gallery,
00147                                         // line can redraw using new colour correction info)
00148     };
00149     
00150     Document *ScopeDoc;                 // Points to the document in which the change occurred
00151     ColourList *NewColourList;          // NULL, or points to the new/affected ColourList
00152     IndexedColour *ChangedColour;       // NULL, or pointer to the colour which has changed
00153     ColourState State;                  // The state, as defined above
00154 
00155                                         // Constructor
00156     ColourChangingMsg(Document *pScopeDocument, ColourList *pChangedList,
00157                         IndexedColour *pChangedColour, ColourState NewState)
00158         : ScopeDoc(pScopeDocument), NewColourList(pChangedList), ChangedColour(pChangedColour), State(NewState)
00159             { /* empty */ }
00160 };
00161 
00162 
00163 
00164 // **** SPECIAL NOTE ****
00165 // COLOURUPDATED and COLOURUPDATEDINVISIBLE are used in the following fashion:
00166 // If the definition of the colour chnages such that the actual dispalyed colour will change,
00167 // thus necessitating a redraw of the document, a COLOURUPDATED should be sent.
00168 // If part of the definition changes which will not need a redraw of coloured regions (e.g
00169 // the name, type, etc), then a COLOURUPDATEDINVISIBLE is sent. The latter is only used
00170 // by those entities which need to update on all colour changes (they sit on both messages)
00171 // while things like document redraws only occur if the visible colour has chnaged.
00172 // See ColourManager::ColourHasChanged and ColourHasChangedInvisible
00173 
00174 #endif

Generated on Sat Nov 10 03:44:52 2007 for Camelot by  doxygen 1.4.4