drawctl.h

Go to the documentation of this file.
00001 // $Id: drawctl.h 1243 2006-06-04 19:41:37Z 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 #ifndef INC_DRAWCTL
00100 #define INC_DRAWCTL
00101 
00102 #include "ctrllist.h"
00103 
00104 enum wxCamDrawControlStyle
00105 {
00106     // Caching flags start here - the art provider may have a different bitmap depending on the
00107     // state of these flags...
00108 
00109     wxCDCS_DEFAULT          = 0,
00110     wxCDCS_SETCLIPRECT      = 1<<0
00111 };
00112 
00113 /*******************************************************************************************
00114 
00115 >   class wxCamDrawControlEvent : public wxEvent
00116 
00117     Author:     Alex_Bligh <alex@alex.org.uk>
00118     Created:    19/12/2005
00119     Purpose:    A derived event to allow for postprocessing of autorepeat on buttons
00120     Notes:      In the OIL
00121     See Also:   
00122 
00123 ********************************************************************************************/
00124 
00125 class wxCamDrawControlEvent : public wxEvent
00126 {
00127 public:
00128     // Aargh note wxEvent's constructor has paramaters the otherway around from this - designed to match wxCommandEvent
00129     wxCamDrawControlEvent(wxEventType commandType = wxEVT_NULL, INT32 id=0 ) : wxEvent(id, commandType) {}
00130 
00131     wxCamDrawControlEvent(const wxCamDrawControlEvent& event) : wxEvent(event) {}
00132 
00133     virtual wxEvent *Clone() const {return new wxCamDrawControlEvent(*this); }
00134 
00135     DECLARE_DYNAMIC_CLASS(wxCamDrawControlEvent);
00136 
00137 };
00138 
00139 typedef void (wxEvtHandler::*wxCamDrawControlEventFunction)(wxCamDrawControlEvent &);
00140 
00141 DECLARE_EVENT_TYPE(wxEVT_CAMDRAWCONTROL_INVOKE, -1);
00142 
00143 #define EVT_CAMDRAWCONTROL_INVOKE(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_CAMDRAWCONTROL_INVOKE, id, -1, \
00144     (wxObjectEventFunction)(wxEventFunction)(wxCamDrawControlEventFunction) &fn, (wxObject *) NULL),
00145 
00146 /*******************************************************************************************
00147 
00148 >   class wxCamDrawControl : public wxEvtHandler
00149 
00150     Author:     Alex_Bligh <alex@alex.org.uk>
00151     Created:    19/12/2005
00152     Purpose:    A base class for controls using the CamDrawProvider to paint themselves
00153     Notes:      In the OIL
00154     See Also:   
00155 
00156 This class is specificly written so it will provided cached vector-drawn art.
00157 
00158 ********************************************************************************************/
00159 
00160 class wxCamDrawControl : public wxControl
00161 {
00162     DECLARE_DYNAMIC_CLASS(wxControl)
00163     DECLARE_EVENT_TABLE()
00164 public:
00165     // Creation
00166     BOOL Create( wxWindow * parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
00167                      /*TYPENOTE: Correct*/ long style = 0, const wxValidator& validator = wxDefaultValidator,
00168                      wxCamDrawControlStyle cacstyle = wxCDCS_DEFAULT,
00169                      wxString opdesc = wxString(_T("")));
00170 
00171     // Common init
00172     void Init() {
00173                     m_CamDrawControlStyle=wxCDCS_DEFAULT;
00174                     m_OpDesc=wxString(_T(""));
00175                     m_Frozen=0;
00176                 }
00177 
00178     // Constructors
00179     wxCamDrawControl() { Init(); }
00180     wxCamDrawControl( wxWindow * parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
00181                      /*TYPENOTE: Correct*/ long style = 0, const wxValidator& validator = wxDefaultValidator,
00182                      wxCamDrawControlStyle cacstyle = wxCDCS_DEFAULT,
00183                      wxString opdesc = wxString(_T("")))
00184                     {
00185                         Init();
00186                         ControlList::Get()->NewControl(this);
00187                         Create(parent, id, pos, size, style, validator, cacstyle, opdesc);
00188                     }
00189     ~wxCamDrawControl() {  }
00190 
00191     // EventHandlers
00192     void OnPaint(wxPaintEvent & event);
00193     void OnSize(wxSizeEvent & event);
00194     void OnMouseEvent(wxMouseEvent & event);
00195     void OnInvoke(wxCamDrawControlEvent& event);
00196 
00197     virtual void Freeze() {m_Frozen++;}
00198     virtual void Thaw() {if (m_Frozen) m_Frozen--;}
00199 
00200     virtual void SetStyle(wxCamDrawControlStyle style) { m_CamDrawControlStyle=style; }
00201     virtual wxCamDrawControlStyle GetStyle() { return m_CamDrawControlStyle;}
00202 
00203     wxString GetOpDesc() {return m_OpDesc;}
00204     
00205 protected:
00206     wxCamDrawControlStyle m_CamDrawControlStyle;
00207 
00208     wxString m_OpDesc;
00209 
00210     INT32 m_Frozen;
00211 
00212     void Invoke();
00213 
00214 };
00215 
00216 /*******************************************************************************************
00217 
00218 >   class wxCamDrawControlXmlHandler : public wxXmlResourceHandler
00219 
00220     Author:     Alex_Bligh <alex@alex.org.uk>
00221     Created:    19/12/2005
00222     Purpose:    A resource handler to enable wxCamDrawControl items to be loaded from XML
00223     Notes:      In the OIL
00224     See Also:   
00225 
00226 ********************************************************************************************/
00227 
00228 class wxCamDrawControlXmlHandler : public wxXmlResourceHandler
00229 {
00230 DECLARE_DYNAMIC_CLASS(wxCamDrawControlXmlHandler)
00231 public:
00232     wxCamDrawControlXmlHandler();
00233     virtual wxObject *DoCreateResource();
00234     virtual bool /*TYPENOTE: Correct*/ CanHandle(wxXmlNode *node);
00235 };
00236 
00237 
00238 #endif
00239 

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