00001 // $Id: binds.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 This file binds various platform-indy identifiers to run-time constant numbers. 00101 It includes things like the identifiers describing different types of click, different 00102 types of modifiers, etc... 00103 00104 You should only add things to this file if you know they are not going to change 00105 frequently. What I mean is don't put anything in here which is allocated on request from 00106 thrid-parties - things like Tool IDs should NOT go in this file. 00107 00108 */ 00109 00110 /* 00111 * */ 00112 00113 #ifndef INC_BINDS 00114 #define INC_BINDS 00115 00116 /******************************************************************************************* 00117 00118 < ClickType 00119 00120 Comment: The kernel only understands pointing-devices with ONE button! DON'T PANIC! 00121 If a pointing- device has more than one button then the functions of 00122 the other buttons are encoded as "modifiers" of the simple click state (See 00123 Modifiers below). The reason for doing things this way is not to be ready for 00124 the Mac but simply because functions which want to treat all clicks in the 00125 same way don't have to do any special tests. 00126 00127 The model of clicking that the kernel expects is that it always receives a 00128 single-click whether or not further testing decides that a double-click or a 00129 drag follows. The kernel expects that it will always have received a 00130 single-click when dealing with a double-click or a drag. It is up to the OIL 00131 layer to guarantee this! 00132 00133 MonoOn 00134 enum ClickType { CLICKTYPE_NONE, 00135 CLICKTYPE_SINGLE, 00136 CLICKTYPE_DOUBLE, 00137 CLICKTYPE_DRAG 00138 }; 00139 MonoOff 00140 00141 SeeAlso: ClickModifiers; DocView::OnClick; Tool_v1::OnClick 00142 00143 ********************************************************************************************/ 00144 00145 enum ClickType 00146 { 00147 CLICKTYPE_NONE, // what's this then? 00148 CLICKTYPE_SINGLE, // single click, any button 00149 CLICKTYPE_DOUBLE, // double click, any button 00150 CLICKTYPE_DRAG, // mouse move 00151 CLICKTYPE_UP // button up, any button 00152 }; 00153 00154 00155 00156 00157 /******************************************************************************************* 00158 00159 < ButtonFunction 00160 00161 Comment: This enum lists the possible functions that can be assigned to each of the 00162 mouse buttons via the preferences system. 00163 MonoOn 00164 enum ButtonFunction { 00165 BUTTFUNC_NORMAL, 00166 BUTTFUNC_SHIFT, 00167 BUTTFUNC_CONSTRAIN, 00168 BUTTFUNC_ALTERNATIVE, 00169 BUTTFUNC_MENU, 00170 BUTTFUNC_EDITOBJECT, 00171 BUTTFUNC_FULLSCREEN, 00172 BUTTFUNC_ZOOMIN 00173 }; 00174 MonoOff 00175 00176 ********************************************************************************************/ 00177 00178 enum ButtonFunction { 00179 BUTTFUNC_NORMAL, 00180 BUTTFUNC_SHIFT, 00181 BUTTFUNC_CONSTRAIN, 00182 BUTTFUNC_ALTERNATIVE, 00183 BUTTFUNC_MENU, 00184 // BUTTFUNC_EDITOBJECT, 00185 BUTTFUNC_FULLSCREEN, 00186 BUTTFUNC_ZOOMIN, 00187 BUTTFUNC_PUSHCENTRE, 00188 00189 BUTTFUNC_LAST 00190 }; 00191 00192 00193 00194 00195 /******************************************************************************************* 00196 00197 < DragType 00198 00199 Comment: When a drag is started there are various options which control the way 00200 scrolling occurs when the pointer moves outside the client area. 00201 00202 MonoOn 00203 enum DragType { DRAGTYPE_NOSCROLL, 00204 DRAGTYPE_AUTOSCROLL, 00205 DRAGTYPE_DEFERSCROLL, 00206 DRAGTYPE_OLESCROLL 00207 }; 00208 MonoOff 00209 00210 SeeAlso: CCamView::StartDrag 00211 00212 ********************************************************************************************/ 00213 00214 enum DragType { DRAGTYPE_NOSCROLL, 00215 DRAGTYPE_AUTOSCROLL, 00216 DRAGTYPE_DEFERSCROLL, 00217 DRAGTYPE_OLESCROLL 00218 }; 00219 00220 00221 00222 00223 /******************************************************************************************* 00224 00225 < ToolKeyClaimDetails 00226 00227 Comment: When a tool claims a modifier key combination for temporary tool selection 00228 (e.g. ALT for the selector tool), it uses this structure to indicate the 00229 modifier key combination it wishes to claim. For example, it can claim the 00230 "right shift and right control key" combination, or the "left ALT key" 00231 combination. 00232 Note that while control and shift are fairly constant, the "Alternative" 00233 fields may not always map onto ALT keys, e.g on the Mac, Alternative2 00234 might be the 'splat' key etc. 00235 00236 MonoOn 00237 union ToolKeyClaimDetails 00238 { 00239 struct 00240 { 00241 BOOL Alternative1 : 1; 00242 BOOL Alternative2 : 1; 00243 BOOL LeftShift : 1; 00244 BOOL RightShift : 1; 00245 BOOL LeftControl : 1; 00246 BOOL RightControl : 1; 00247 } Keys; 00248 00249 // Used for direct comparisons 00250 UINT32 Value; 00251 }; 00252 MonoOff 00253 00254 SeeAlso: Tool::ClaimToolKey 00255 00256 ********************************************************************************************/ 00257 /* 00258 union ToolKeyClaimDetails 00259 { 00260 struct 00261 { 00262 BOOL LeftShift : 1; 00263 BOOL RightShift : 1; 00264 BOOL LeftControl : 1; // > how you distinguish between 00265 BOOL RightControl : 1; // > these is anyone's guess 00266 BOOL Alternative1 : 1; 00267 BOOL Alternative2 : 1; 00268 } Keys; 00269 00270 // Used for direct comparisons 00271 UINT32 Value; 00272 }; 00273 */ 00274 #endif
1.4.4