include/wx/gtk/dc.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dc.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Created:     01/02/97
   6 // Id:
   7 // Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11
  12 #ifndef __GTKDCH__
  13 #define __GTKDCH__
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "wx/defs.h"
  20 #include "wx/object.h"
  21 #include "wx/gdicmn.h"
  22 #include "wx/pen.h"
  23 #include "wx/brush.h"
  24 #include "wx/icon.h"
  25 #include "wx/font.h"
  26 #include "wx/gdicmn.h"
  27
  28 //-----------------------------------------------------------------------------
  29 // classes
  30 //-----------------------------------------------------------------------------
  31
  32 class wxDC;
  33
  34 //-----------------------------------------------------------------------------
  35 // constants
  36 //-----------------------------------------------------------------------------
  37
  38 #define MM_TEXT                 0
  39 #define MM_ISOTROPIC            1
  40 #define MM_ANISOTROPIC          2
  41 #define MM_LOMETRIC             3
  42 #define MM_HIMETRIC             4
  43 #define MM_TWIPS                5
  44 #define MM_POINTS               6
  45 #define MM_METRIC               7
  46
  47 //-----------------------------------------------------------------------------
  48 // global variables
  49 //-----------------------------------------------------------------------------
  50
  51 extern int wxPageNumber;
  52
  53 //-----------------------------------------------------------------------------
  54 // wxDC
  55 //-----------------------------------------------------------------------------
  56
  57 class wxDC: public wxObject
  58 {
  59   DECLARE_ABSTRACT_CLASS(wxDC)
  60
  61   public:
  62
  63     wxDC(void);
  64     ~wxDC(void);
  65
  66     void BeginDrawing(void) {};
  67     void EndDrawing(void) {};
  68
  69     virtual bool Ok(void) const { return m_ok; };
  70
  71     virtual void FloodFill( long x1, long y1, wxColour *col, int style=wxFLOOD_SURFACE ) = 0;
  72     virtual bool GetPixel( long x1, long y1, wxColour *col ) const = 0;
  73
  74     virtual void DrawLine( long x1, long y1, long x2, long y2 ) = 0;
  75     virtual void CrossHair( long x, long y ) = 0;
  76     virtual void DrawArc( long x1, long y1, long x2, long y2, double xc, double yc );
  77     virtual void DrawEllipticArc( long x, long y, long width, long height, double sa, double ea ) = 0;
  78     virtual void DrawPoint( long x, long y ) = 0;
  79     virtual void DrawPoint( wxPoint& point );
  80
  81     virtual void DrawLines( int n, wxPoint points[], long xoffset = 0, long yoffset = 0 ) = 0;
  82     virtual void DrawLines( wxList *points, long xoffset = 0, long yoffset = 0 );
  83     virtual void DrawPolygon( int n, wxPoint points[], long xoffset = 0, long yoffset = 0,
  84                               int fillStyle=wxODDEVEN_RULE ) = 0;
  85     virtual void DrawPolygon( wxList *lines, long xoffset = 0, long yoffset = 0,
  86                               int fillStyle=wxODDEVEN_RULE );
  87
  88     virtual void DrawRectangle( long x, long y, long width, long height ) = 0;
  89     virtual void DrawRoundedRectangle( long x, long y, long width, long height, double radius = 20.0 ) = 0;
  90     virtual void DrawEllipse( long x, long y, long width, long height ) = 0;
  91
  92     virtual void DrawSpline( long x1, long y1, long x2, long y2, long x3, long y3 );
  93     virtual void DrawSpline( wxList *points );
  94     virtual void DrawSpline( int n, wxPoint points[] );
  95
  96     virtual bool CanDrawBitmap(void) const = 0;
  97     virtual void DrawIcon( const wxIcon &icon, long x, long y )
  98       { DrawIcon( icon, x, y, TRUE ); }
  99     virtual void DrawIcon( const wxIcon &icon, long x, long y, bool useMask );
 100             void DrawBitmap( const wxBitmap &bmp, long x, long y, bool useMask=FALSE )
 101             { DrawIcon( *((wxIcon*)(&bmp)), x, y, useMask ); }
 102     virtual bool Blit( long xdest, long ydest, long width, long height,
 103        wxDC *source, long xsrc, long ysrc, int logical_func = wxCOPY, bool useMask=FALSE ) = 0;
 104
 105     virtual void DrawText( const wxString &text, long x, long y, bool use16 = FALSE ) = 0;
 106     virtual bool CanGetTextExtent(void) const = 0;
 107     virtual void GetTextExtent( const wxString &string, long *width, long *height,
 108                      long *descent = NULL, long *externalLeading = NULL,
 109                      wxFont *theFont = NULL, bool use16 = FALSE ) = 0;
 110     virtual long GetCharWidth(void) = 0;
 111     virtual long GetCharHeight(void) = 0;
 112
 113     virtual void Clear(void) = 0;
 114
 115     virtual void SetFont( const wxFont &font ) = 0;
 116     virtual wxFont *GetFont(void) { return &m_font; };
 117
 118     virtual void SetPen( const wxPen &pen ) = 0;
 119     virtual wxPen *GetPen(void) { return &m_pen; };
 120
 121     virtual void SetBrush( const wxBrush &brush ) = 0;
 122     virtual wxBrush *GetBrush(void) { return &m_brush; };
 123
 124     virtual void SetBackground( const wxBrush &brush ) = 0;
 125     virtual wxBrush *GetBackground(void) { return &m_backgroundBrush; };
 126
 127     virtual void SetLogicalFunction( int function ) = 0;
 128     virtual int GetLogicalFunction(void) { return m_logicalFunction; };
 129
 130     virtual void SetTextForeground( const wxColour &col );
 131     virtual void SetTextBackground( const wxColour &col );
 132     virtual wxColour& GetTextBackground(void) const { return (wxColour&)m_textBackgroundColour; };
 133     virtual wxColour& GetTextForeground(void) const { return (wxColour&)m_textForegroundColour; };
 134
 135     virtual void SetBackgroundMode( int mode ) = 0;
 136     virtual int GetBackgroundMode(void) { return m_backgroundMode; };
 137
 138     virtual void SetPalette( const wxPalette& palette ) = 0;
 139       void SetColourMap( const wxPalette& palette ) { SetPalette(palette); };
 140
 141     // the first two must be overridden and called
 142     virtual void SetClippingRegion( long x, long y, long width, long height );
 143     virtual void DestroyClippingRegion(void);
 144     virtual void GetClippingBox( long *x, long *y, long *width, long *height ) const;
 145
 146     virtual inline long MinX(void) const { return m_minX; }
 147     virtual inline long MaxX(void) const { return m_maxX; }
 148     virtual inline long MinY(void) const { return m_minY; }
 149     virtual inline long MaxY(void) const { return m_maxY; }
 150
 151     virtual void GetSize( int* width, int* height ) const;
 152     inline wxSize GetSize(void) const { int w, h; GetSize(&w, &h); return wxSize(w, h); }
 153     virtual void GetSizeMM( long* width, long* height ) const;
 154
 155     virtual bool StartDoc( const wxString& WXUNUSED(message) ) { return TRUE; };
 156     virtual void EndDoc(void) {};
 157     virtual void StartPage(void) {};
 158     virtual void EndPage(void) {};
 159
 160     virtual void SetMapMode( int mode );
 161     virtual int GetMapMode(void) const { return m_mappingMode; };
 162
 163     virtual void SetUserScale( double x, double y );
 164     virtual void GetUserScale( double *x, double *y );
 165     virtual void SetLogicalScale( double x, double y );
 166     virtual void GetLogicalScale( double *x, double *y );
 167
 168     virtual void SetLogicalOrigin( long x, long y );
 169     virtual void GetLogicalOrigin( long *x, long *y );
 170     virtual void SetDeviceOrigin( long x, long y );
 171     virtual void GetDeviceOrigin( long *x, long *y );
 172     virtual void SetInternalDeviceOrigin( long x, long y );
 173     virtual void GetInternalDeviceOrigin( long *x, long *y );
 174
 175     virtual void SetAxisOrientation( bool xLeftRight, bool yBottomUp );
 176
 177     virtual void SetOptimization( bool WXUNUSED(optimize) ) {};
 178     virtual bool GetOptimization(void) { return m_optimize; };
 179
 180     virtual long DeviceToLogicalX(long x) const;
 181     virtual long DeviceToLogicalY(long y) const;
 182     virtual long DeviceToLogicalXRel(long x) const;
 183     virtual long DeviceToLogicalYRel(long y) const;
 184     virtual long LogicalToDeviceX(long x) const;
 185     virtual long LogicalToDeviceY(long y) const;
 186     virtual long LogicalToDeviceXRel(long x) const;
 187     virtual long LogicalToDeviceYRel(long y) const;
 188
 189   public:
 190
 191     void CalcBoundingBox( long x, long y );
 192     void ComputeScaleAndOrigin(void);
 193
 194     long XDEV2LOG(long x) const
 195         {
 196           long new_x = x - m_deviceOriginX;
 197           if (new_x > 0)
 198             return (long)((double)(new_x) / m_scaleX + 0.5) * m_signX + m_logicalOriginX;
 199           else
 200             return (long)((double)(new_x) / m_scaleX - 0.5) * m_signX + m_logicalOriginX;
 201         }
 202     long XDEV2LOGREL(long x) const
 203         {
 204           if (x > 0)
 205             return (long)((double)(x) / m_scaleX + 0.5);
 206           else
 207             return (long)((double)(x) / m_scaleX - 0.5);
 208         }
 209     long YDEV2LOG(long y) const
 210         {
 211           long new_y = y - m_deviceOriginY;
 212           if (new_y > 0)
 213             return (long)((double)(new_y) / m_scaleY + 0.5) * m_signY + m_logicalOriginY;
 214           else
 215             return (long)((double)(new_y) / m_scaleY - 0.5) * m_signY + m_logicalOriginY;
 216         }
 217     long YDEV2LOGREL(long y) const
 218         {
 219           if (y > 0)
 220             return (long)((double)(y) / m_scaleY + 0.5);
 221           else
 222             return (long)((double)(y) / m_scaleY - 0.5);
 223         }
 224     long XLOG2DEV(long x) const
 225         {
 226           long new_x = x - m_logicalOriginX;
 227           if (new_x > 0)
 228             return (long)((double)(new_x) * m_scaleX + 0.5) * m_signX + m_deviceOriginX;
 229           else
 230             return (long)((double)(new_x) * m_scaleX - 0.5) * m_signX + m_deviceOriginX;
 231         }
 232     long XLOG2DEVREL(long x) const
 233         {
 234           if (x > 0)
 235             return (long)((double)(x) * m_scaleX + 0.5);
 236           else
 237             return (long)((double)(x) * m_scaleX - 0.5);
 238         }
 239     long YLOG2DEV(long y) const
 240         {
 241           long new_y = y - m_logicalOriginY;
 242           if (new_y > 0)
 243             return (long)((double)(new_y) * m_scaleY + 0.5) * m_signY + m_deviceOriginY;
 244           else
 245             return (long)((double)(new_y) * m_scaleY - 0.5) * m_signY + m_deviceOriginY;
 246         }
 247     long YLOG2DEVREL(long y) const
 248         {
 249           if (y > 0)
 250             return (long)((double)(y) * m_scaleY + 0.5);
 251           else
 252             return (long)((double)(y) * m_scaleY - 0.5);
 253         }
 254
 255     virtual void DrawOpenSpline( wxList *points ) = 0;
 256
 257   public:
 258
 259     bool         m_ok;
 260     bool         m_colour;
 261
 262     // not sure, what these mean
 263     bool         m_clipping;      // Is clipping on right now ?
 264     bool         m_isInteractive; // Is GetPixel possible ?
 265     bool         m_autoSetting;   // wxMSW only ?
 266     bool         m_dontDelete;    // wxMSW only ?
 267     bool         m_optimize;      // wxMSW only ?
 268     wxString     m_filename;      // Not sure where this belongs.
 269
 270     wxPen        m_pen;
 271     wxBrush      m_brush;
 272     wxBrush      m_backgroundBrush;
 273     wxColour     m_textForegroundColour;
 274     wxColour     m_textBackgroundColour;
 275     wxFont       m_font;
 276
 277     int          m_logicalFunction;
 278     int          m_backgroundMode;
 279     int          m_textAlignment;    // gone in wxWin 2.0 ?
 280
 281     int          m_mappingMode;
 282
 283     // not sure what for, but what is a mm on a screen you don't know the size of?
 284     double       m_mm_to_pix_x,m_mm_to_pix_y;
 285
 286     long         m_internalDeviceOriginX,m_internalDeviceOriginY;   // If un-scrolled is non-zero or
 287                                                                     // d.o. changes with scrolling.
 288                                                                     // Set using SetInternalDeviceOrigin().
 289
 290     long         m_externalDeviceOriginX,m_externalDeviceOriginY;   // To be set by external classes
 291                                                                     // such as wxScrolledWindow
 292                                                                     // using SetDeviceOrigin()
 293
 294     long         m_deviceOriginX,m_deviceOriginY;                   // Sum of the two above.
 295
 296     long         m_logicalOriginX,m_logicalOriginY;                 // User defined.
 297
 298     double       m_scaleX,m_scaleY;
 299     double       m_logicalScaleX,m_logicalScaleY;
 300     double       m_userScaleX,m_userScaleY;
 301     long         m_signX,m_signY;
 302
 303     bool         m_needComputeScaleX,m_needComputeScaleY;         // not yet used
 304
 305     float        m_scaleFactor;  // wxPSDC wants to have this. Will disappear.
 306
 307     long         m_clipX1,m_clipY1,m_clipX2,m_clipY2;
 308     long         m_minX,m_maxX,m_minY,m_maxY;
 309 };
 310
 311 #endif // __GTKDCH__