00001 // $Id: dragtool.h 1282 2006-06-09 09:46:49Z alex $ 00002 // Header for the drag tool implementation. 00003 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE 00004 ================================XARAHEADERSTART=========================== 00005 00006 Xara LX, a vector drawing and manipulation program. 00007 Copyright (C) 1993-2006 Xara Group Ltd. 00008 Copyright on certain contributions may be held in joint with their 00009 respective authors. See AUTHORS file for details. 00010 00011 LICENSE TO USE AND MODIFY SOFTWARE 00012 ---------------------------------- 00013 00014 This file is part of Xara LX. 00015 00016 Xara LX is free software; you can redistribute it and/or modify it 00017 under the terms of the GNU General Public License version 2 as published 00018 by the Free Software Foundation. 00019 00020 Xara LX and its component source files are distributed in the hope 00021 that it will be useful, but WITHOUT ANY WARRANTY; without even the 00022 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 00023 See the GNU General Public License for more details. 00024 00025 You should have received a copy of the GNU General Public License along 00026 with Xara LX (see the file GPL in the root directory of the 00027 distribution); if not, write to the Free Software Foundation, Inc., 51 00028 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00029 00030 00031 ADDITIONAL RIGHTS 00032 ----------------- 00033 00034 Conditional upon your continuing compliance with the GNU General Public 00035 License described above, Xara Group Ltd grants to you certain additional 00036 rights. 00037 00038 The additional rights are to use, modify, and distribute the software 00039 together with the wxWidgets library, the wxXtra library, and the "CDraw" 00040 library and any other such library that any version of Xara LX relased 00041 by Xara Group Ltd requires in order to compile and execute, including 00042 the static linking of that library to XaraLX. In the case of the 00043 "CDraw" library, you may satisfy obligation under the GNU General Public 00044 License to provide source code by providing a binary copy of the library 00045 concerned and a copy of the license accompanying it. 00046 00047 Nothing in this section restricts any of the rights you have under 00048 the GNU General Public License. 00049 00050 00051 SCOPE OF LICENSE 00052 ---------------- 00053 00054 This license applies to this program (XaraLX) and its constituent source 00055 files only, and does not necessarily apply to other Xara products which may 00056 in part share the same code base, and are subject to their own licensing 00057 terms. 00058 00059 This license does not apply to files in the wxXtra directory, which 00060 are built into a separate library, and are subject to the wxWindows 00061 license contained within that directory in the file "WXXTRA-LICENSE". 00062 00063 This license does not apply to the binary libraries (if any) within 00064 the "libs" directory, which are subject to a separate license contained 00065 within that directory in the file "LIBS-LICENSE". 00066 00067 00068 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS 00069 ---------------------------------------------- 00070 00071 Subject to the terms of the GNU Public License (see above), you are 00072 free to do whatever you like with your modifications. However, you may 00073 (at your option) wish contribute them to Xara's source tree. You can 00074 find details of how to do this at: 00075 http://www.xaraxtreme.org/developers/ 00076 00077 Prior to contributing your modifications, you will need to complete our 00078 contributor agreement. This can be found at: 00079 http://www.xaraxtreme.org/developers/contribute/ 00080 00081 Please note that Xara will not accept modifications which modify any of 00082 the text between the start and end of this header (marked 00083 XARAHEADERSTART and XARAHEADEREND). 00084 00085 00086 MARKS 00087 ----- 00088 00089 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara 00090 designs are registered or unregistered trademarks, design-marks, and/or 00091 service marks of Xara Group Ltd. All rights in these marks are reserved. 00092 00093 00094 Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK. 00095 http://www.xara.com/ 00096 00097 =================================XARAHEADEREND============================ 00098 */ 00099 00100 #ifndef INC_DRAGTOOL 00101 #define INC_DRAGTOOL 00102 00103 //#include "tool.h" - in camtypes.h [AUTOMATICALLY REMOVED] 00104 #include "transop.h" 00105 00106 /******************************************************************************************** 00107 > class DragTool : public Tool_v1 00108 00109 Author: Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com> 00110 Created: 13/10/1999 00111 Purpose: The Drag tool is a base class for the Selector and Slice tools. 00112 It acts to give these tools a common heritage, so that TransOperation, 00113 which handles dragging of objects, can maintain a pointer to them and inform 00114 them of various events during a drag. At some point in the future (ie maybe 00115 never, but we can hope...) it may be useful to pull common drag functionality 00116 up from these two tools, into a base implementation in this class. 00117 00118 Currently, all the function definitions in this class are purely to allow 00119 TransOperation's pSelTool data member to be changed from a SelectorTool* 00120 to a DragTool*. Default implementation in this class is simply to do nothing. 00121 00122 CGS: 00123 00124 The DragTool is also the base class for all tools which require selection 00125 ability. A single interface is provided for this pupose: OnClick (). 00126 OnClick () actually serves as a wrapper for our selection tool - thereby 00127 allowing all derived tools to harness the power of our selection tool. 00128 00129 ********************************************************************************************/ 00130 00131 class CCAPI DragTool : public Tool_v1 00132 { 00133 // own up in memory dumps 00134 CC_DECLARE_MEMDUMP(DragTool); 00135 00137 // Tool interface 00138 00139 public: 00140 // Function that allows the transform to tell the tool how things are going. 00141 virtual void DragMove(TransformBoundingData* pBoundingData); 00142 00143 // This function returns TRUE if the given floating-point value exceeds the range 00144 // that FIXED16 numbers can represent. 00145 // *What* it is doing inside a Tool class, I don't know. 00146 static BOOL BeyondFixedRange(double fpFixedVal); 00147 00148 // Notify the current tool of click events on the document... 00149 virtual void OnClick(DocCoord PointerPos, ClickType cType, ClickModifiers cMods, Spread* pSpread); 00150 00151 private: 00152 // Standard tool static vars 00153 static TCHAR *FamilyName; // The Tools Family Name 00154 static TCHAR *ToolName; // The Tool Name 00155 static TCHAR *Purpose; // What the tool is for 00156 static TCHAR *Author; // Who wrote it 00157 }; 00158 00159 #endif // INC_DRAGTOOL