]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/os2/dc.h
added wxToolBar::SetToolClientData
[wxWidgets.git] / include / wx / os2 / dc.h
index ce3e9998d1d98aafbd63526c3501b9b95228ef6a..2df64604bc96fa668742c672bf7a218c3091efbd 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dc.h
 // Purpose:     wxDC class
-// Author:      AUTHOR
+// Author:      David Webster
 // Modified by:
-// Created:     ??/??/98
+// Created:     08/26/99
 // RCS-ID:      $Id$
-// Copyright:   (c) AUTHOR
-// Licence:    wxWindows licence
+// Copyright:   (c) David Webster
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DC_H_
 #define _WX_DC_H_
 
-#ifdef __GNUG__
-#pragma interface "dc.h"
-#endif
+#include "wx/defs.h"
+#include "wx/dc.h"
 
-#include "wx/pen.h"
-#include "wx/brush.h"
-#include "wx/icon.h"
-#include "wx/font.h"
-#include "wx/gdicmn.h"
-
-//-----------------------------------------------------------------------------
-// constants
-//-----------------------------------------------------------------------------
-
-#ifndef MM_TEXT
-#define MM_TEXT                        0
-#define MM_ISOTROPIC   1
-#define MM_ANISOTROPIC 2
-#define MM_LOMETRIC            3
-#define MM_HIMETRIC            4
-#define MM_TWIPS               5
-#define MM_POINTS              6
-#define MM_METRIC              7
-#endif
+// ---------------------------------------------------------------------------
+// macros
+// ---------------------------------------------------------------------------
 
-//-----------------------------------------------------------------------------
-// global variables
-//-----------------------------------------------------------------------------
+// Logical to device
+// Absolute
+#define XLOG2DEV(x) (x)
+#define YLOG2DEV(y) (y)
 
-extern int wxPageNumber;
+// Relative
+#define XLOG2DEVREL(x) (x)
+#define YLOG2DEVREL(y) (y)
 
-//-----------------------------------------------------------------------------
-// wxDC
-//-----------------------------------------------------------------------------
+// Device to logical
+// Absolute
+#define XDEV2LOG(x) (x)
 
-class WXDLLEXPORT wxDC: public wxObject
-{
-  DECLARE_ABSTRACT_CLASS(wxDC)
+#define YDEV2LOG(y) (y)
 
-  public:
+// Relative
+#define XDEV2LOGREL(x) (x)
+#define YDEV2LOGREL(y) (y)
 
-    wxDC(void);
-    ~wxDC(void);
-    
-    void BeginDrawing(void) {};
-    void EndDrawing(void) {};
-    
-    virtual bool Ok(void) const { return m_ok; };
+/*
+ * Have the same macros as for XView but not for every operation:
+ * just for calculating window/viewport extent (a better way of scaling).
+ */
 
-    virtual void FloodFill( long x1, long y1, const wxColour& col, int style=wxFLOOD_SURFACE ) = 0;
-    inline void FloodFill(const wxPoint& pt, const wxColour& col, int style=wxFLOOD_SURFACE)
-    {
-        FloodFill(pt.x, pt.y, col, style);
-    }
+// Logical to device
+// Absolute
+#define MS_XLOG2DEV(x) LogicalToDevice(x)
 
-    virtual bool GetPixel( long x1, long y1, wxColour *col ) const = 0;
-    inline bool GetPixel(const wxPoint& pt, wxColour *col) const
-    {
-        return GetPixel(pt.x, pt.y, col);
-    }
+#define MS_YLOG2DEV(y) LogicalToDevice(y)
 
-    virtual void DrawLine( long x1, long y1, long x2, long y2 ) = 0;
-    inline void DrawLine(const wxPoint& pt1, const wxPoint& pt2)
-    {
-        DrawLine(pt1.x, pt1.y, pt2.x, pt2.y);
-    }
+// Relative
+#define MS_XLOG2DEVREL(x) LogicalToDeviceXRel(x)
+#define MS_YLOG2DEVREL(y) LogicalToDeviceYRel(y)
 
-    virtual void CrossHair( long x, long y ) = 0;
-    inline void CrossHair(const wxPoint& pt)
-    {
-        CrossHair(pt.x, pt.y);
-    }
+// Device to logical
+// Absolute
+#define MS_XDEV2LOG(x) DeviceToLogicalX(x)
 
-    virtual void DrawArc( long x1, long y1, long x2, long y2, long xc, long yc ) = 0;
-    inline void DrawArc(const wxPoint& pt1, const wxPoint& pt2, const wxPoint& centre)
-    {
-        DrawArc(pt1.x, pt1.y, pt2.x, pt2.y, centre.x, centre.y);
-    }
+#define MS_YDEV2LOG(y) DeviceToLogicalY(y)
 
-    virtual void DrawEllipticArc( long x, long y, long width, long height, double sa, double ea ) = 0;
-    virtual void DrawEllipticArc (const wxPoint& pt, const wxSize& sz, double sa, double ea)
-    {
-        DrawEllipticArc(pt.x, pt.y, sz.x, sz.y, sa, ea);
-    }
+// Relative
+#define MS_XDEV2LOGREL(x) DeviceToLogicalXRel(x)
+#define MS_YDEV2LOGREL(y) DeviceToLogicalYRel(y)
 
-    virtual void DrawPoint( long x, long y ) = 0;
-    virtual void DrawPoint( wxPoint& point );
-    
-    virtual void DrawLines( int n, wxPoint points[], long xoffset = 0, long yoffset = 0 ) = 0;
-    virtual void DrawLines( wxList *points, long xoffset = 0, long yoffset = 0 );
-    virtual void DrawPolygon( int n, wxPoint points[], long xoffset = 0, long yoffset = 0, 
-                              int fillStyle=wxODDEVEN_RULE ) = 0;
-    virtual void DrawPolygon( wxList *lines, long xoffset = 0, long yoffset = 0, 
-                              int fillStyle=wxODDEVEN_RULE );
-    
-    virtual void DrawRectangle( long x, long y, long width, long height ) = 0;
-    inline void DrawRectangle(const wxPoint& pt, const wxSize& sz)
-    {
-        DrawRectangle(pt.x, pt.y, sz.x, sz.y);
-    }
-    inline void DrawRectangle(const wxRect& rect)
-    {
-        DrawRectangle(rect.x, rect.y, rect.width, rect.height);
-    }
-    virtual void DrawRoundedRectangle( long x, long y, long width, long height, double radius = 20.0 ) = 0;
-    inline void DrawRoundedRectangle(const wxPoint& pt, const wxSize& sz, double radius = 20.0)
-    {
-        DrawRoundedRectangle(pt.x, pt.y, sz.x, sz.y, radius);
-    }
-    inline void DrawRoundedRectangle(const wxRect& rect, double radius = 20.0)
-    {
-        DrawRoundedRectangle(rect.x, rect.y, rect.width, rect.height, radius);
-    }
+#define YSCALE(y) (yorigin - (y))
 
-    virtual void DrawEllipse( long x, long y, long width, long height ) = 0;
-    inline void DrawEllipse(const wxPoint& pt, const wxSize& sz)
-    {
-        DrawEllipse(pt.x, pt.y, sz.x, sz.y);
-    }
-    inline void DrawEllipse(const wxRect& rect)
+#define     wx_round(a)    (int)((a)+.5)
+
+class WXDLLEXPORT wxDC : public wxDCBase
+{
+    DECLARE_DYNAMIC_CLASS(wxDC)
+
+public:
+    wxDC();
+    ~wxDC();
+
+    // implement base class pure virtuals
+    // ----------------------------------
+
+    virtual void Clear();
+
+    virtual bool StartDoc(const wxString& message);
+    virtual void EndDoc();
+
+    virtual void StartPage();
+    virtual void EndPage();
+
+    virtual void SetFont(const wxFont& font);
+    virtual void SetPen(const wxPen& pen);
+    virtual void SetBrush(const wxBrush& brush);
+    virtual void SetBackground(const wxBrush& brush);
+    virtual void SetBackgroundMode(int mode);
+    virtual void SetPalette(const wxPalette& palette);
+
+    virtual void DestroyClippingRegion();
+
+    virtual wxCoord GetCharHeight() const;
+    virtual wxCoord GetCharWidth() const;
+    virtual void DoGetTextExtent(const wxString& string,
+                                 wxCoord *x, wxCoord *y,
+                                 wxCoord *descent = NULL,
+                                 wxCoord *externalLeading = NULL,
+                                 wxFont *theFont = NULL) const;
+
+    virtual bool CanDrawBitmap() const;
+    virtual bool CanGetTextExtent() const;
+    virtual int GetDepth() const;
+    virtual wxSize GetPPI() const;
+
+    virtual void SetMapMode(int mode);
+    virtual void SetUserScale(double x, double y);
+    virtual void SetSystemScale(double x, double y);
+    virtual void SetLogicalScale(double x, double y);
+    virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
+    virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
+    virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
+    virtual void SetLogicalFunction(int function);
+
+    // implementation from now on
+    // --------------------------
+
+    virtual void SetRop(WXHDC cdc);
+    virtual void DoClipping(WXHDC cdc);
+    virtual void SelectOldObjects(WXHDC dc);
+
+    wxWindow *GetWindow() const { return m_canvas; }
+    void SetWindow(wxWindow *win) { m_canvas = win; }
+
+    WXHDC GetHDC() const { return m_hDC; }
+    void SetHDC(WXHDC dc, bool bOwnsDC = FALSE)
     {
-        DrawEllipse(rect.x, rect.y, rect.width, rect.height);
+        m_hDC = dc;
+        m_bOwnsDC = bOwnsDC;
     }
 
-    virtual void DrawSpline( long x1, long y1, long x2, long y2, long x3, long y3 );
-    virtual void DrawSpline( wxList *points ) = 0;
-    virtual void DrawSpline( int n, wxPoint points[] );
-    
-    virtual bool CanDrawBitmap(void) const = 0;
+protected:
+    virtual void DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
+                             int style = wxFLOOD_SURFACE);
 
-    virtual void DrawIcon( const wxIcon &icon, long x, long y, bool useMask=FALSE );
-    inline void DrawIcon(const wxIcon& icon, const wxPoint& pt)
-    {
-        DrawIcon(icon, pt.x, pt.y);
-    }
+    virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
 
-    // TODO DrawBitmap is not always the same as DrawIcon, especially if bitmaps and
-    // icons are implemented differently.
-    void DrawBitmap( const wxBitmap &bmp, long x, long y, bool useMask=FALSE )
-             { DrawIcon( *((wxIcon*)(&bmp)), x, y, useMask ); }
+    virtual void DoDrawPoint(wxCoord x, wxCoord y);
+    virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 
-    virtual bool Blit( long xdest, long ydest, long width, long height,
-       wxDC *source, long xsrc, long ysrc, int logical_func = wxCOPY, bool useMask=FALSE ) = 0;
-    inline bool Blit(const wxPoint& destPt, const wxSize& sz,
-            wxDC *source, const wxPoint& srcPt, int rop = wxCOPY, bool useMask = FALSE)
-    {
-        return Blit(destPt.x, destPt.y, sz.x, sz.y, source, srcPt.x, srcPt.y, rop, useMask);
-    }
+    virtual void DoDrawArc(wxCoord x1, wxCoord y1,
+                           wxCoord x2, wxCoord y2,
+                           wxCoord xc, wxCoord yc);
+    virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
+                                   double sa, double ea);
+
+    virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
+    virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
+                                        wxCoord width, wxCoord height,
+                                        double radius);
+    virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
+
+    virtual void DoCrossHair(wxCoord x, wxCoord y);
+
+    virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
+    virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
+                              bool useMask = FALSE);
+
+    virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
+    virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
+                                   double angle);
 
-    virtual void DrawText( const wxString &text, long x, long y, bool use16 = FALSE ) = 0;
-    inline void DrawText(const wxString& text, const wxPoint& pt, bool use16bit = FALSE)
+    virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
+                        wxDC *source, wxCoord xsrc, wxCoord ysrc,
+                        int rop = wxCOPY, bool useMask = FALSE);
+
+    // this is gnarly - we can't even call this function DoSetClippingRegion()
+    // because of virtual function hiding
+    virtual void DoSetClippingRegionAsRegion(const wxRegion& region);
+    virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
+                                     wxCoord width, wxCoord height);
+    virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
+                                     wxCoord *width, wxCoord *height)
     {
-        DrawText(text, pt.x, pt.y, use16bit);
+        GetClippingBox(x, y, width, height);
     }
 
-    virtual bool CanGetTextExtent(void) const = 0;
-    virtual void GetTextExtent( const wxString &string, long *width, long *height,
-                     long *descent = NULL, long *externalLeading = NULL,
-                     wxFont *theFont = NULL, bool use16 = FALSE ) = 0;
-    virtual long GetCharWidth(void) = 0;
-    virtual long GetCharHeight(void) = 0;
-    
-    virtual void Clear(void) = 0;
-            
-    virtual void SetFont( const wxFont &font ) = 0;
-    virtual wxFont& GetFont(void) const { return (wxFont&) m_font; };
-    
-    virtual void SetPen( const wxPen &pen ) = 0;
-    virtual wxPen& GetPen(void) const { return (wxPen&) m_pen; };
-    
-    virtual void SetBrush( const wxBrush &brush ) = 0;
-    virtual wxBrush& GetBrush(void) const { return (wxBrush&) m_brush; };
-
-    virtual void SetBackground( const wxBrush &brush ) = 0;
-    virtual wxBrush& GetBackground(void) const { return (wxBrush&) m_backgroundBrush; };
-
-    virtual void SetLogicalFunction( int function ) = 0;
-    virtual int GetLogicalFunction(void) const { return m_logicalFunction; };
-    
-    virtual void SetTextForeground( const wxColour &col );
-    virtual void SetTextBackground( const wxColour &col );
-    virtual wxColour& GetTextBackground(void) const { return (wxColour&)m_textBackgroundColour; };
-    virtual wxColour& GetTextForeground(void) const { return (wxColour&)m_textForegroundColour; };
-    
-    virtual void SetBackgroundMode( int mode ) = 0;
-    virtual int GetBackgroundMode(void) const { return m_backgroundMode; };
-    
-    virtual void SetPalette( const wxPalette& palette ) = 0;
-    void SetColourMap( const wxPalette& palette ) { SetPalette(palette); };
-    
-    // the first two must be overridden and called
-    virtual void SetClippingRegion( long x, long y, long width, long height );
-    virtual void DestroyClippingRegion(void);
-    virtual void GetClippingBox( long *x, long *y, long *width, long *height ) const;
-    
-    virtual inline long MinX(void) const { return m_minX; }
-    virtual inline long MaxX(void) const { return m_maxX; }
-    virtual inline long MinY(void) const { return m_minY; }
-    virtual inline long MaxY(void) const { return m_maxY; }
-
-    virtual void GetSize( int* width, int* height ) const;
-    inline wxSize GetSize(void) const { int w, h; GetSize(&w, &h); return wxSize(w, h); }
-    virtual void GetSizeMM( long* width, long* height ) const;
-    
-    virtual bool StartDoc( const wxString& WXUNUSED(message) ) { return TRUE; };
-    virtual void EndDoc(void) {};
-    virtual void StartPage(void) {};
-    virtual void EndPage(void) {};
-    
-    virtual void SetMapMode( int mode );
-    virtual int GetMapMode(void) const { return m_mappingMode; };
-    
-    virtual void SetUserScale( double x, double y );
-    virtual void GetUserScale( double *x, double *y );
-    virtual void SetLogicalScale( double x, double y );
-    virtual void GetLogicalScale( double *x, double *y );
-    
-    virtual void SetLogicalOrigin( long x, long y );
-    virtual void GetLogicalOrigin( long *x, long *y );
-    virtual void SetDeviceOrigin( long x, long y );
-    virtual void GetDeviceOrigin( long *x, long *y );
-    virtual void SetInternalDeviceOrigin( long x, long y );
-    virtual void GetInternalDeviceOrigin( long *x, long *y );
-
-    virtual void SetAxisOrientation( bool xLeftRight, bool yBottomUp );
-    
-    virtual void SetOptimization( bool WXUNUSED(optimize) ) {};
-    virtual bool GetOptimization(void) { return m_optimize; };
-    
-    virtual long DeviceToLogicalX(long x) const;
-    virtual long DeviceToLogicalY(long y) const;
-    virtual long DeviceToLogicalXRel(long x) const;
-    virtual long DeviceToLogicalYRel(long y) const;
-    virtual long LogicalToDeviceX(long x) const;
-    virtual long LogicalToDeviceY(long y) const;
-    virtual long LogicalToDeviceXRel(long x) const;
-    virtual long LogicalToDeviceYRel(long y) const;
-
-  public:
-  
-    void CalcBoundingBox( long x, long y );
-    void ComputeScaleAndOrigin(void);
-    
-    long XDEV2LOG(long x) const
-       {
-         long new_x = x - m_deviceOriginX;
-         if (new_x > 0) 
-           return (long)((double)(new_x) / m_scaleX + 0.5) * m_signX + m_logicalOriginX;
-         else
-           return (long)((double)(new_x) / m_scaleX - 0.5) * m_signX + m_logicalOriginX;
-       }
-    long XDEV2LOGREL(long x) const
-       { 
-         if (x > 0) 
-           return (long)((double)(x) / m_scaleX + 0.5);
-         else
-           return (long)((double)(x) / m_scaleX - 0.5);
-       }
-    long YDEV2LOG(long y) const
-       {
-         long new_y = y - m_deviceOriginY;
-         if (new_y > 0)
-           return (long)((double)(new_y) / m_scaleY + 0.5) * m_signY + m_logicalOriginY;
-         else
-           return (long)((double)(new_y) / m_scaleY - 0.5) * m_signY + m_logicalOriginY;
-       }
-    long YDEV2LOGREL(long y) const
-       { 
-         if (y > 0)
-           return (long)((double)(y) / m_scaleY + 0.5);
-         else
-           return (long)((double)(y) / m_scaleY - 0.5);
-       }
-    long XLOG2DEV(long x) const
-       { 
-         long new_x = x - m_logicalOriginX;
-         if (new_x > 0)
-           return (long)((double)(new_x) * m_scaleX + 0.5) * m_signX + m_deviceOriginX;
-         else
-           return (long)((double)(new_x) * m_scaleX - 0.5) * m_signX + m_deviceOriginX;
-       }
-    long XLOG2DEVREL(long x) const
-       { 
-         if (x > 0)
-           return (long)((double)(x) * m_scaleX + 0.5);
-         else
-           return (long)((double)(x) * m_scaleX - 0.5);
-       }
-    long YLOG2DEV(long y) const
-       {
-         long new_y = y - m_logicalOriginY;
-         if (new_y > 0)
-           return (long)((double)(new_y) * m_scaleY + 0.5) * m_signY + m_deviceOriginY;
-         else
-           return (long)((double)(new_y) * m_scaleY - 0.5) * m_signY + m_deviceOriginY;
-       }
-    long YLOG2DEVREL(long y) const
-       { 
-         if (y > 0)
-           return (long)((double)(y) * m_scaleY + 0.5);
-         else
-           return (long)((double)(y) * m_scaleY - 0.5);
-       }
-  
-  public:
-    
-    bool         m_ok;
-    bool         m_colour;
-    
-    // not sure, what these mean
-    bool         m_clipping;      // Is clipping on right now ?
-    bool         m_isInteractive; // Is GetPixel possible ?
-    bool         m_autoSetting;   // wxMSW only ?
-    bool         m_dontDelete;    // wxMSW only ?
-    bool         m_optimize;      // wxMSW only ?
-    wxString     m_filename;      // Not sure where this belongs.
-    
-    wxPen        m_pen;
-    wxBrush      m_brush;
-    wxBrush      m_backgroundBrush;
-    wxColour     m_textForegroundColour;
-    wxColour     m_textBackgroundColour;
-    wxFont       m_font;
-    
-    int          m_logicalFunction;
-    int          m_backgroundMode;
-    int          m_textAlignment;    // gone in wxWin 2.0 ?
-    
-    int          m_mappingMode;
-    
-    // not sure what for, but what is a mm on a screen you don't know the size of?
-    double       m_mm_to_pix_x,m_mm_to_pix_y; 
-    
-    long         m_internalDeviceOriginX,m_internalDeviceOriginY;   // If un-scrolled is non-zero or
-                                                                   // d.o. changes with scrolling.
-                                                                   // Set using SetInternalDeviceOrigin().
-                                                                   
-    long         m_externalDeviceOriginX,m_externalDeviceOriginY;   // To be set by external classes
-                                                                    // such as wxScrolledWindow
-                                                                   // using SetDeviceOrigin()
-                                                                   
-    long         m_deviceOriginX,m_deviceOriginY;                   // Sum of the two above.
-    
-    long         m_logicalOriginX,m_logicalOriginY;                 // User defined.
-
-    double       m_scaleX,m_scaleY;
-    double       m_logicalScaleX,m_logicalScaleY;
-    double       m_userScaleX,m_userScaleY;
-    long         m_signX,m_signY;
-    
-    bool         m_needComputeScaleX,m_needComputeScaleY;         // not yet used
-    
-    float        m_scaleFactor;  // wxPSDC wants to have this. Will disappear.
-    
-    long         m_clipX1,m_clipY1,m_clipX2,m_clipY2;
-    long         m_minX,m_maxX,m_minY,m_maxY;
-};
+    virtual void DoGetSize(int *width, int *height) const;
+    virtual void DoGetSizeMM(int* width, int* height) const;
+
+    virtual void DoDrawLines(int n, wxPoint points[],
+                             wxCoord xoffset, wxCoord yoffset);
+    virtual void DoDrawPolygon(int n, wxPoint points[],
+                               wxCoord xoffset, wxCoord yoffset,
+                               int fillStyle = wxODDEVEN_RULE);
+
+#if wxUSE_SPLINES
+    virtual void DoDrawSpline(wxList *points);
+#endif // wxUSE_SPLINES
+
+    // OS2-specific member variables
+    int               m_windowExtX;
+    int               m_windowExtY;
+
+    // the window associated with this DC (may be NULL)
+    wxWindow         *m_canvas;
 
+    wxBitmap          m_selectedBitmap;
+
+    // TRUE => DeleteDC() in dtor, FALSE => only ReleaseDC() it
+    bool              m_bOwnsDC:1;
+
+    // our HDC and its usage count: we only free it when the usage count drops
+    // to 0
+    WXHDC             m_hDC;
+    int               m_hDCCount;
+
+    // Store all old GDI objects when do a SelectObject, so we can select them
+    // back in (this unselecting user's objects) so we can safely delete the
+    // DC.
+    WXHBITMAP         m_oldBitmap;
+    WXHPEN            m_oldPen;
+    WXHBRUSH          m_oldBrush;
+    WXHFONT           m_oldFont;
+    WXHPALETTE        m_oldPalette;
+
+    float             m_scaleFactor;  // wxPSDC wants to have this. Will disappear.
+};
 #endif
     // _WX_DC_H_