clikmods.h

Go to the documentation of this file.
00001 // $Id: clikmods.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 // Implements the ClickModifiers class
00099 
00100 #ifndef INC_CLICKMODS
00101 #define INC_CLICKMODS
00102 
00103 #include "binds.h"
00104 
00105 /*
00106  * Key state Masks for Mouse messages
00107  */
00108 #if !defined(MK_LBUTTON)
00109 #define MK_LBUTTON      0x0001
00110 #define MK_RBUTTON      0x0002
00111 #define MK_SHIFT        0x0004
00112 #define MK_CONTROL      0x0008
00113 #define MK_MBUTTON      0x0010
00114 #define MK_ALT          0x1000  // Added during LX port...
00115 #endif
00116 
00117 /*******************************************************************************************
00118 >   Class ClickModifiers : public CC_CLASS_MEMDUMP
00119     Author:     Phil_Martin (Xara Group Ltd) <camelotdev@xara.com>
00120     Created:    07/03/95 (from original ClickModifiers struct)
00121     Purpose:    To provide platform-indy click modifiers to the kernel and to construct
00122                 such objects from the state of the keyboard, mouse and preferences on
00123                 request.
00124     Comment:    When a click event occurs various other input devices (Shift keys, other
00125                 mouse buttons, etc.) are tested and their states are used to modify the
00126                 meaning of the click.  The input devices which modify the meaning of a click
00127                 are not named but their meaning inside the kernel is given so that the OIL
00128                 layer can best decide which devices to test to perform which modifications.
00129 
00130                 Notice that combinations of these modifiers may be TRUE at any time, although
00131                 some combinations may be illegal.
00132 
00133                 Note that the "Menu" modifier is just added for consistency with dialogue
00134                 handling - click events on the document views will NEVER receive clicks with
00135                 the "Menu" modifier.
00136 
00137 public:
00138     BOOL Adjust         : 1;    // Shift key (Also configurable to a mouse button)
00139     BOOL Menu           : 1;    // User wants a context sensitive menu (Configurable)
00140     BOOL Constrain      : 1;    // Control key (Also configurable to a mouse button)
00141     BOOL Alternative1   : 1;    // Left-Alt key (Also configurable to a mouse button)
00142     BOOL Alternative2   : 1;    // Right-Alt key ???
00143 
00144     BOOL EditObject     : 1;    // User wants the best editor for this object (Configurable)
00145     BOOL FullScreen     : 1;    // User wants to toggle full-screen mode (Configurable)
00146     BOOL ZoomIn         : 1;    // User wants to zoom in one stage (Configurable)
00147 
00148     UINT32 Pressure;                // Pen Pressure
00149 
00150 
00151     SeeAlso:    ClickType; DocView::OnClick; Tool_v1::OnClick
00152 
00153 ********************************************************************************************/ 
00154 
00155 class ClickModifiers : public CC_CLASS_MEMDUMP
00156 {
00157     CC_DECLARE_MEMDUMP(ClickModifiers);
00158 
00159 public:
00160 // Member variables...
00161     //   Modifier name             Default meaning on Windows (RISC OS and the Mac may differ)
00162     BOOL Adjust         : 1;    // Shift key (Also configurable to a mouse button)
00163     BOOL Menu           : 1;    // User wants a context sensitive menu (Configurable)
00164     BOOL Constrain      : 1;    // Control key (Also configurable to a mouse button)
00165     BOOL Alternative1   : 1;    // Left-Alt key (Also configurable to a mouse button)
00166     BOOL Alternative2   : 1;    // Right-Alt key ???
00167 
00168     BOOL EditObject     : 1;    // User wants the best editor for this object (Configurable)
00169     BOOL FullScreen     : 1;    // User wants to toggle full-screen mode (Configurable)
00170     BOOL ZoomIn         : 1;    // User wants to zoom in one stage (Configurable)
00171 
00172     //Graham 18/6/96: New click modifier ClickWhileDrag
00173     //Set to TRUE if the present click was made while a drag was in progress
00174     //e.g. right mouse button clicks while left button is dragging
00175     BOOL ClickWhileDrag : 1;
00176 
00177     // Matt 16/11/00 - New ClickModifier added - 
00178     // Push tool activation / Auto-centre screen - when true the user can move the mouse to pan the view
00179     // or if just a single click, will cause view to centre about the mouse cursor
00180     BOOL PushCentreTool : 1;
00181 
00182     UINT32 Pressure;                // Pen Pressure
00183     // More of these may be added when they are needed...
00184 
00185 // Member functions...
00186     ClickModifiers();               // Constructor
00187     ClickModifiers(const ClickModifiers& CopyMods);
00188     ClickModifiers& operator=(const ClickModifiers& CopyMods);
00189 
00190     BOOL IsHandledByTool();         // Determines whether modifier should be handled by tool
00191 
00192     static ClickModifiers GetClickModifiers();
00193     static ClickModifiers GetClickModifiers(wxMouseEvent &event);
00194     static ClickModifiers GetClickModifiers(UINT32 nFlags);
00195                                     // Creates a ClickMod based on keys, mouse buttons and user
00196                                     // preferences.
00197     static UINT32 SynthesizeMouseEventFlags();
00198     static UINT32 SynthesizeMouseEventFlags(wxMouseEvent &event);
00199                                     // Create an nFlags bitfield by reading key/button states
00200                                     // from the OS.
00201 
00202 private:
00203     void GetModsFromPrefs(ButtonFunction buttfunc);
00204                                     // Set modifier flags according to the button function
00205 
00206 // Preferences
00207 public:
00208     static BOOL DeclarePrefs();                             // Declare prefs to the system
00209     static void GetButtonFuncName(ButtonFunction bf, String_32* pString);   
00210                                                             // Get the name of a button function
00211     static void RestoreDefaults();                          // Restore to default preferences
00212     static ButtonFunction GetButtonFunc(UINT32 ButtonID);       // Read the preference for a given button
00213     static void SetButtonFunc(UINT32 ButtonID, ButtonFunction bf);
00214                                                             // Read the preference for a given button
00215 
00216 private:
00217     static ButtonFunction LeftButtonFunction;               // Functions assigned to left,mid,right buttons
00218     static ButtonFunction MiddleButtonFunction;
00219     static ButtonFunction RightButtonFunction;
00220 
00221     static UINT32 ButtFuncNames[BUTTFUNC_LAST];             // Array of user-level function names
00222 
00223 };
00224 
00225 #endif // INC_CLICKMODS
00226 
00227 

Generated on Sat Nov 10 03:48:15 2007 for Camelot by  doxygen 1.4.4