wxOil/oilruler.h

   1 // $Id: oilruler.h 1459 2006-07-17 17:35:57Z phil $
   2 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
   3 ================================XARAHEADERSTART===========================
   4
   5                Xara LX, a vector drawing and manipulation program.
   6                     Copyright (C) 1993-2006 Xara Group Ltd.
   7        Copyright on certain contributions may be held in joint with their
   8               respective authors. See AUTHORS file for details.
   9
  10 LICENSE TO USE AND MODIFY SOFTWARE
  11 ----------------------------------
  12
  13 This file is part of Xara LX.
  14
  15 Xara LX is free software; you can redistribute it and/or modify it
  16 under the terms of the GNU General Public License version 2 as published
  17 by the Free Software Foundation.
  18
  19 Xara LX and its component source files are distributed in the hope
  20 that it will be useful, but WITHOUT ANY WARRANTY; without even the
  21 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  22 See the GNU General Public License for more details.
  23
  24 You should have received a copy of the GNU General Public License along
  25 with Xara LX (see the file GPL in the root directory of the
  26 distribution); if not, write to the Free Software Foundation, Inc., 51
  27 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  28
  29
  30 ADDITIONAL RIGHTS
  31 -----------------
  32
  33 Conditional upon your continuing compliance with the GNU General Public
  34 License described above, Xara Group Ltd grants to you certain additional
  35 rights.
  36
  37 The additional rights are to use, modify, and distribute the software
  38 together with the wxWidgets library, the wxXtra library, and the "CDraw"
  39 library and any other such library that any version of Xara LX relased
  40 by Xara Group Ltd requires in order to compile and execute, including
  41 the static linking of that library to XaraLX. In the case of the
  42 "CDraw" library, you may satisfy obligation under the GNU General Public
  43 License to provide source code by providing a binary copy of the library
  44 concerned and a copy of the license accompanying it.
  45
  46 Nothing in this section restricts any of the rights you have under
  47 the GNU General Public License.
  48
  49
  50 SCOPE OF LICENSE
  51 ----------------
  52
  53 This license applies to this program (XaraLX) and its constituent source
  54 files only, and does not necessarily apply to other Xara products which may
  55 in part share the same code base, and are subject to their own licensing
  56 terms.
  57
  58 This license does not apply to files in the wxXtra directory, which
  59 are built into a separate library, and are subject to the wxWindows
  60 license contained within that directory in the file "WXXTRA-LICENSE".
  61
  62 This license does not apply to the binary libraries (if any) within
  63 the "libs" directory, which are subject to a separate license contained
  64 within that directory in the file "LIBS-LICENSE".
  65
  66
  67 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
  68 ----------------------------------------------
  69
  70 Subject to the terms of the GNU Public License (see above), you are
  71 free to do whatever you like with your modifications. However, you may
  72 (at your option) wish contribute them to Xara's source tree. You can
  73 find details of how to do this at:
  74   http://www.xaraxtreme.org/developers/
  75
  76 Prior to contributing your modifications, you will need to complete our
  77 contributor agreement. This can be found at:
  78   http://www.xaraxtreme.org/developers/contribute/
  79
  80 Please note that Xara will not accept modifications which modify any of
  81 the text between the start and end of this header (marked
  82 XARAHEADERSTART and XARAHEADEREND).
  83
  84
  85 MARKS
  86 -----
  87
  88 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
  89 designs are registered or unregistered trademarks, design-marks, and/or
  90 service marks of Xara Group Ltd. All rights in these marks are reserved.
  91
  92
  93       Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
  94                         http://www.xara.com/
  95
  96 =================================XARAHEADEREND============================
  97  */
  98 // oil ruler class
  99
 100 #ifndef INC_OILRULERS
 101 #define INC_OILRULERS
 102
 103 #include "guides.h"
 104 #include "camview.h"
 105
 106 class WinCoord;
 107 class WinRect;
 108 class DovView;
 109 class RulerBase;
 110 class OILHorizontalRuler;
 111 class CRenderWnd;
 112
 113 #define MAX_RULER_DIGITS 3
 114
 115 enum MouseFollowerRenderType { RenderOn, RenderOff };
 116
 117 // WEBSTER - markn 15/1/97
 118 // No rulers in Webster
 119 #ifndef WEBSTER
 120 #ifndef EXCLUDE_FROM_RALPH
 121
 122 /********************************************************************************************
 123 >       class LegendLabel : public wxWindow
 124
 125         Author:         Chris_Parks (Xara Group Ltd) <camelotdev@xara.com>
 126         Created:        4/3/94
 127         Purpose:        This is the class for the "set origin" gadget,
 128 ********************************************************************************************/
 129
 130 class LegendLabel : public wxWindow
 131 {
 132         friend class  OILHorizontalRuler;
 133         DECLARE_DYNAMIC_CLASS(LegendLabel)
 134
 135 public:
 136         LegendLabel();
 137         virtual ~LegendLabel();
 138         BOOL Create(OILHorizontalRuler* pHorzRuler, wxWindow* pParentWindow, INT32 id);
 139
 140         void ShowLabel(BOOL show);
 141         BOOL PositionLegend();
 142
 143         wxPoint ClientToParentClient(wxPoint point);
 144
 145         BOOL GetStatusLineText(String_256* pText, WinCoord MousePos, CWindowID hWnd);
 146
 147 protected:
 148         BOOL SetLegendText(StringBase* pText);
 149         BOOL SetLegendSize();
 150
 151 protected:
 152         // wxWindows OIL message handlers and related functions
 153         void DoPaint(wxDC* pDC);
 154
 155         void OnPaint(wxPaintEvent &event);
 156
 157         void OnSize(wxSizeEvent &event);
 158         void OnLButtonDown(wxMouseEvent& event);
 159         void OnLButtonDblClk(wxMouseEvent& event);
 160         void OnRButtonUp(wxMouseEvent& event);
 161         void OnMouseMove(wxMouseEvent& event);
 162
 163 protected:
 164         UINT32 LegendWidth;
 165         UINT32 LegendHeight;
 166         String_256 LegendText;
 167         OILHorizontalRuler* m_pHorzRuler;
 168
 169         DECLARE_EVENT_TABLE()
 170 };
 171
 172
 173 /********************************************************************************************
 174 >       class OILRuler : public wxWindow
 175
 176         Author:         Chris_Parks (Xara Group Ltd) <camelotdev@xara.com>
 177         Created:        4/3/94
 178         Purpose:        This is the base class for Horizontal and Vertical rulers,
 179                                 It looks after the basic's - creating windows etc..
 180                                 and handles all mouse events fo the rulers
 181 *********************************************************************************************/
 182
 183 class OILRuler : public wxWindow
 184 {
 185         DECLARE_DYNAMIC_CLASS(OILRuler)
 186
 187 public:
 188         OILRuler();
 189         virtual ~OILRuler();
 190         virtual BOOL PostCreate() {return FALSE;}
 191         BOOL Create(CCamView* pOwnerView, INT32 id);
 192         void LinkToKernel(RulerBase* pKRuler) { pKernelRuler=pKRuler; }
 193
 194         static BOOL GetMinGraticuleSpacing(OilRect* pSpacing, DocView* pDocView);
 195         static BOOL GetTextSize(OilRect* pTextSize, LPCTSTR str, DocView* pDocView);
 196         static BOOL GetTextSize(WinRect* pTextSize, LPCTSTR str);
 197         static void PatB(wxDC* pDC, INT32 x, INT32 y, INT32 dx, INT32 dy, wxColour rgb);
 198
 199         wxPoint  ClientToOtherClient(wxWindow* pOtherCWnd, wxPoint point);
 200         WinRect ClientToOtherClient(wxWindow* pOtherCWnd, WinRect  WR);
 201
 202         OilCoord ClientToOil(DocView* pDocView, wxPoint point);
 203         OilRect  ClientToOil(DocView* pDocView, WinRect  WR);
 204
 205         virtual BOOL DrawMajorGraticule(OilCoord GratOilPos, LPCTSTR str) {return FALSE;}
 206         virtual BOOL DrawMinorGraticule(OilCoord GratOilPos, INT32 ExtraSize=0);
 207         BOOL HighlightSection(OilCoord Lo, OilCoord Hi);
 208         BOOL DrawBitmap(OilCoord Pos, ResourceID BitmapID);
 209         BOOL StartToolDrag(ClickModifiers Mods, OilCoord point, String_256* OpToken, OpParam* Param);
 210
 211         BOOL PaintMouseFollower(OilCoord OilPos, DocView* pDocView, MouseFollowerRenderType RenderType);
 212         BOOL  DrawMouseFollower(OilCoord OilPos, DocView* pDocView, MouseFollowerRenderType RenderType, wxDC* pDC);
 213
 214         BOOL GetStatusLineText(String_256* pText, WinCoord MousePos, CWindowID hWnd);
 215
 216         virtual void ShowRuler(BOOL show);
 217         void UpdateRuler();
 218
 219         static BOOL Init();
 220         static void Deinit();
 221         static INT32 GetRenderWidth() { return RenderWidth; }
 222         static UINT32 GetWidth()       { return RulerWidth; }
 223         static wxFont GetRulerFont();
 224
 225 protected:
 226         virtual BOOL IsHorizontal() {return FALSE;}
 227         virtual BOOL StartDrag(UINT32 nFlags, wxPoint point);
 228         virtual BOOL HandleRulerDragEvent(UINT32 Button, UINT32 nFlags, WinCoord point, ClickType t);
 229         virtual BOOL HandleRulerUpEvent(UINT32 Button, WinCoord point);
 230
 231         CRenderWnd* GetRenderWindow() {return m_pOwnerView ? m_pOwnerView->GetRenderWindow() : NULL;}
 232         void SetCurrentStates();
 233
 234 protected:
 235         // wxWindows OIL message handlers and related functions
 236         void DoPaint(wxDC* pDC);
 237
 238         void OnPaint(wxPaintEvent &event);
 239
 240 //      void OnLButtonDown(wxMouseEvent& event);
 241 //      void OnLButtonDblClk(wxMouseEvent& event);
 242 //      void OnRButtonUp(wxMouseEvent& event);
 243         void OnMouseMove(wxMouseEvent& event);
 244
 245         void    OnLButtonDown( wxMouseEvent &event );
 246         void    OnLButtonDblClk( wxMouseEvent &event );
 247         void    OnLButtonUp( wxMouseEvent &event );
 248         void    OnMButtonDown( wxMouseEvent &event );
 249         void    OnMButtonDblClk( wxMouseEvent &event );
 250         void    OnMButtonUp( wxMouseEvent &event );
 251         void    OnRButtonDown( wxMouseEvent &event );
 252         void    OnRButtonDblClk( wxMouseEvent &event );
 253         void    OnRButtonUp( wxMouseEvent &event );
 254
 255         void    OnFocus( wxFocusEvent& event );
 256
 257 public:
 258         static String_256*      FontName;               // read from .ini file
 259         static INT32        FontSize;
 260
 261 protected:
 262         static INT32            RenderWidth;    // renderable width of ruler, determined by the font specified in the .ini
 263         static UINT32           RulerWidth;             // offset to next bar - NOT NECESSARILY THE PHYSICAL OR LOGICAL WIDTH OF THE RULER!
 264         static INT32            CharHeight;
 265         static INT32            CharWidth;
 266
 267         // vars to pass info from OIL OnPaint() to low level OIL render funtions, transparent to intermediate kernel code
 268         // This is a bit NASTY!
 269         static wxDC*            pPaintDC;
 270         static DocView*         pPaintDocView;
 271         static wxSize           RulerToDocOffset;
 272
 273         static OpGuidelineParam NewGuidelineParam;
 274
 275         CCamView*                       m_pOwnerView;
 276         RulerBase*                      pKernelRuler;
 277
 278         ClickType                       m_LastClickType;                // click type of last START_DRAG
 279         UINT32                          m_LastClickButton;              // buttons down on last START_DRAG
 280         wxPoint                         m_LastClickPoint;               // mouse position of last START_DRAG
 281         ClickModifiers          m_LastClickMods;                // ClickMods on last mouse event (NOT modified by button-up events!)
 282         UINT32                          m_FirstClickButton;             // Which button started the drag (if dragging).
 283
 284         BOOL InDrag;
 285
 286         DECLARE_EVENT_TABLE()
 287 };
 288
 289
 290 /********************************************************************************************
 291 >       class OILHorizontalRuler : public OILRuler
 292         Author:         Chris_Parks (Xara Group Ltd) <camelotdev@xara.com>
 293         Created:        29/3/94
 294         Purpose:        This class handles the OIL-specific parts of Horizontal rulers.
 295 ********************************************************************************************/
 296
 297 class OILHorizontalRuler : public OILRuler
 298 {
 299         friend class LegendLabel;
 300         DECLARE_DYNAMIC_CLASS(OILHorizontalRuler)
 301
 302 public:
 303         OILHorizontalRuler();
 304         ~OILHorizontalRuler();
 305         virtual BOOL PostCreate();
 306
 307         void CalcPosFromParentClient(WinRect* lpRect);
 308         void ScrollRuler(INT32 amount);
 309
 310         virtual void ShowRuler(BOOL show);
 311         virtual BOOL DrawMajorGraticule(OilCoord GratOilPos, LPCTSTR str);
 312
 313         BOOL PositionLegend();
 314         BOOL SetLegendText(StringBase* pText);
 315
 316         LegendLabel* GetpLegendLabel() { return pLegend; }
 317
 318 protected:
 319         virtual BOOL StartDrag(UINT32 nFlags, wxPoint point);
 320         virtual BOOL IsHorizontal(){ return TRUE ;};
 321
 322 private:
 323         LegendLabel* pLegend;
 324 };
 325
 326
 327 /********************************************************************************************
 328 >       class OILVerticalRuler : public OILRuler
 329         Author:         Chris_Parks (Xara Group Ltd) <camelotdev@xara.com>
 330         Created:        29/3/94
 331         Purpose:        This class handles the OIL-specific parts of Horizontal rulers.
 332 ********************************************************************************************/
 333
 334 class OILVerticalRuler : public OILRuler
 335 {
 336         DECLARE_DYNAMIC_CLASS(OILVerticalRuler)
 337
 338 public:
 339         OILVerticalRuler();
 340         virtual BOOL PostCreate();
 341
 342         void CalcPosFromParentClient(WinRect* lpRect);
 343         void ScrollRuler(INT32 amount);
 344
 345         virtual BOOL DrawMajorGraticule(OilCoord GratOilPos, LPCTSTR str);
 346
 347 protected:
 348         virtual BOOL StartDrag(UINT32 nFlags, wxPoint point);
 349         virtual BOOL IsHorizontal(){ return FALSE ;};
 350
 351 };
 352
 353
 354 /********************************************************************************************
 355 >       class OriginGadget : public wxWindow
 356
 357         Author:         Chris_Parks (Xara Group Ltd) <camelotdev@xara.com>
 358         Created:        4/3/94
 359         Purpose:        This is the class for the "set origin" gadget,
 360 ********************************************************************************************/
 361
 362 class OriginGadget : public wxWindow
 363 {
 364         DECLARE_DYNAMIC_CLASS(OriginGadget)
 365
 366 public:
 367         OriginGadget();
 368         virtual ~OriginGadget();
 369         BOOL Create(CCamView* pOwnerView, INT32 id);
 370
 371         void ShowGadget(BOOL show);
 372         void CalcPosFromParentClient(WinRect* lpRect);
 373
 374         BOOL GetStatusLineText(String_256* pText, WinCoord MousePos, CWindowID hWnd);
 375 #if !defined(EXCLUDE_FROM_XARALX)
 376         static TCHAR* BubbleHelpCallBack(CWindowID hWnd, UINT32 PaneIndex, void* UserData);
 377 #endif
 378
 379 protected:
 380         // Windows OIL message handlers and related functions
 381         void DoPaint(wxDC* pDC);
 382
 383         void OnPaint(wxPaintEvent &event);
 384
 385         void OnLButtonDown(wxMouseEvent& event);
 386         void OnLButtonDblClk(wxMouseEvent& event);
 387         void OnRButtonUp(wxMouseEvent& event);
 388         void OnMouseMove(wxMouseEvent& event);
 389
 390 protected:
 391         CCamView* m_pOwnerView;
 392
 393         wxBitmap* pGlyph;
 394
 395         DECLARE_EVENT_TABLE()
 396 };
 397
 398 #endif
 399 #endif  // WEBSTER
 400 #endif  // INC_OILRULERS