X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/72cdf4c9b3ce92addf09cfb322f0c19bfb0f8744..85f138db83939ce7c59a942aaecca7fa98168db3:/include/wx/dc.h diff --git a/include/wx/dc.h b/include/wx/dc.h index 4fe6bda1a1..24899df0a0 100644 --- a/include/wx/dc.h +++ b/include/wx/dc.h @@ -5,14 +5,14 @@ // Modified by: // Created: 05/25/99 // RCS-ID: $Id$ -// Copyright: (c) wxWindows team +// Copyright: (c) wxWidgets team // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_DC_H_BASE_ #define _WX_DC_H_BASE_ -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "dcbase.h" #endif @@ -28,52 +28,112 @@ #include "wx/brush.h" #include "wx/pen.h" #include "wx/palette.h" - #include "wx/list.h" // we use wxList in inline functions +#include "wx/dynarray.h" -// --------------------------------------------------------------------------- -// global variables -// --------------------------------------------------------------------------- +class WXDLLEXPORT wxDC; +class WXDLLEXPORT wxDCBase; -WXDLLEXPORT_DATA(extern int) wxPageNumber; +class WXDLLEXPORT wxDrawObject +{ +public: -// --------------------------------------------------------------------------- -// wxDC is the device context - object on which any drawing is done -// --------------------------------------------------------------------------- + wxDrawObject() + : m_isBBoxValid(FALSE) + , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0) + { } -class WXDLLEXPORT wxDCBase : public wxObject -{ - DECLARE_ABSTRACT_CLASS(wxDCBase) + virtual ~wxDrawObject() { } -public: - wxDCBase() + virtual void Draw(wxDCBase&) const { } + + virtual void CalcBoundingBox(wxCoord x, wxCoord y) { - m_clipping = FALSE; - m_ok = TRUE; + if ( m_isBBoxValid ) + { + if ( x < m_minX ) m_minX = x; + if ( y < m_minY ) m_minY = y; + if ( x > m_maxX ) m_maxX = x; + if ( y > m_maxY ) m_maxY = y; + } + else + { + m_isBBoxValid = TRUE; + + m_minX = x; + m_minY = y; + m_maxX = x; + m_maxY = y; + } + } - m_minX = m_minY = m_maxX = m_maxY = 0; + void ResetBoundingBox() + { + m_isBBoxValid = FALSE; - m_signX = m_signY = 1; + m_minX = m_maxX = m_minY = m_maxY = 0; + } - m_logicalOriginX = m_logicalOriginY = - m_deviceOriginX = m_deviceOriginY = 0; + // Get the final bounding box of the PostScript or Metafile picture. - m_logicalScaleX = m_logicalScaleY = - m_userScaleX = m_userScaleY = - m_scaleX = m_scaleY = 1.0; + wxCoord MinX() const { return m_minX; } + wxCoord MaxX() const { return m_maxX; } + wxCoord MinY() const { return m_minY; } + wxCoord MaxY() const { return m_maxY; } - m_logicalFunction = -1; + //to define the type of object for derived objects + virtual int GetType()=0; - m_backgroundMode = wxTRANSPARENT; +protected: + //for boundingbox calculation + bool m_isBBoxValid:1; + //for boundingbox calculation + wxCoord m_minX, m_minY, m_maxX, m_maxY; +}; - m_mappingMode = wxMM_TEXT; +// --------------------------------------------------------------------------- +// global variables +// --------------------------------------------------------------------------- - m_backgroundBrush = *wxTRANSPARENT_BRUSH; +WXDLLEXPORT_DATA(extern int) wxPageNumber; - m_textForegroundColour = *wxBLACK; - m_textBackgroundColour = *wxWHITE; +// --------------------------------------------------------------------------- +// wxDC is the device context - object on which any drawing is done +// --------------------------------------------------------------------------- - m_colour = wxColourDisplay(); +class WXDLLEXPORT wxDCBase : public wxObject +{ +public: + wxDCBase() + : m_colour(wxColourDisplay()) + , m_ok(TRUE) + , m_clipping(FALSE) + , m_isInteractive(0) + , m_isBBoxValid(FALSE) + , m_logicalOriginX(0), m_logicalOriginY(0) + , m_deviceOriginX(0), m_deviceOriginY(0) + , m_logicalScaleX(1.0), m_logicalScaleY(1.0) + , m_userScaleX(1.0), m_userScaleY(1.0) + , m_scaleX(1.0), m_scaleY(1.0) + , m_signX(1), m_signY(1) + , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0) + , m_clipX1(0), m_clipY1(0), m_clipX2(0), m_clipY2(0) + , m_logicalFunction(wxCOPY) + , m_backgroundMode(wxTRANSPARENT) + , m_mappingMode(wxMM_TEXT) + , m_pen() + , m_brush() + , m_backgroundBrush(*wxTRANSPARENT_BRUSH) + , m_textForegroundColour(*wxBLACK) + , m_textBackgroundColour(*wxWHITE) + , m_font() +#if wxUSE_PALETTE + , m_palette() + , m_hasCustomPalette(FALSE) +#endif // wxUSE_PALETTE + { + ResetBoundingBox(); + ResetClipping(); } ~wxDCBase() { } @@ -84,12 +144,19 @@ public: // graphic primitives // ------------------ - void FloodFill(wxCoord x, wxCoord y, const wxColour& col, + virtual void DrawObject(wxDrawObject* drawobject) + { + drawobject->Draw(*this); + CalcBoundingBox(drawobject->MinX(),drawobject->MinY()); + CalcBoundingBox(drawobject->MaxX(),drawobject->MaxY()); + } + + bool FloodFill(wxCoord x, wxCoord y, const wxColour& col, int style = wxFLOOD_SURFACE) - { DoFloodFill(x, y, col, style); } - void FloodFill(const wxPoint& pt, const wxColour& col, + { return DoFloodFill(x, y, col, style); } + bool FloodFill(const wxPoint& pt, const wxColour& col, int style = wxFLOOD_SURFACE) - { DoFloodFill(pt.x, pt.y, col, style); } + { return DoFloodFill(pt.x, pt.y, col, style); } bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const { return DoGetPixel(x, y, col); } @@ -112,6 +179,12 @@ public: void DrawArc(const wxPoint& pt1, const wxPoint& pt2, const wxPoint& centre) { DoDrawArc(pt1.x, pt1.y, pt2.x, pt2.y, centre.x, centre.y); } + void DrawCheckMark(wxCoord x, wxCoord y, + wxCoord width, wxCoord height) + { DoDrawCheckMark(x, y, width, height); } + void DrawCheckMark(const wxRect& rect) + { DoDrawCheckMark(rect.x, rect.y, rect.width, rect.height); } + void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h, double sa, double ea) { DoDrawEllipticArc(x, y, w, h, sa, ea); } @@ -139,6 +212,11 @@ public: wxCoord xoffset = 0, wxCoord yoffset = 0, int fillStyle = wxODDEVEN_RULE); + void DrawPolyPolygon(int n, int count[], wxPoint points[], + wxCoord xoffset = 0, wxCoord yoffset = 0, + int fillStyle = wxODDEVEN_RULE) + { DoDrawPolyPolygon(n, count, points, xoffset, yoffset, fillStyle); } + void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { DoDrawRectangle(x, y, width, height); } void DrawRectangle(const wxPoint& pt, const wxSize& sz) @@ -157,6 +235,9 @@ public: void DrawCircle(wxCoord x, wxCoord y, wxCoord radius) { DoDrawEllipse(x - radius, y - radius, 2*radius, 2*radius); } + void DrawCircle(const wxPoint& pt, wxCoord radius) + { DrawCircle(pt.x, pt.y, radius); } + void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { DoDrawEllipse(x, y, width, height); } void DrawEllipse(const wxPoint& pt, const wxSize& sz) @@ -181,19 +262,40 @@ public: void DrawText(const wxString& text, const wxPoint& pt) { DoDrawText(text, pt.x, pt.y); } + void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle) + { DoDrawRotatedText(text, x, y, angle); } + void DrawRotatedText(const wxString& text, const wxPoint& pt, double angle) + { DoDrawRotatedText(text, pt.x, pt.y, angle); } + + // this version puts both optional bitmap and the text into the given + // rectangle and aligns is as specified by alignment parameter; it also + // will emphasize the character with the given index if it is != -1 and + // return the bounding rectangle if required + virtual void DrawLabel(const wxString& text, + const wxBitmap& image, + const wxRect& rect, + int alignment = wxALIGN_LEFT | wxALIGN_TOP, + int indexAccel = -1, + wxRect *rectBounding = NULL); + + void DrawLabel(const wxString& text, const wxRect& rect, + int alignment = wxALIGN_LEFT | wxALIGN_TOP, + int indexAccel = -1) + { DrawLabel(text, wxNullBitmap, rect, alignment, indexAccel); } + bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height, wxDC *source, wxCoord xsrc, wxCoord ysrc, - int rop = wxCOPY, bool useMask = FALSE) + int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1) { return DoBlit(xdest, ydest, width, height, - source, xsrc, ysrc, rop, useMask); + source, xsrc, ysrc, rop, useMask, xsrcMask, ysrcMask); } bool Blit(const wxPoint& destPt, const wxSize& sz, wxDC *source, const wxPoint& srcPt, - int rop = wxCOPY, bool useMask = FALSE) + int rop = wxCOPY, bool useMask = FALSE, const wxPoint& srcPtMask = wxPoint(-1, -1)) { return DoBlit(destPt.x, destPt.y, sz.x, sz.y, - source, srcPt.x, srcPt.y, rop, useMask); + source, srcPt.x, srcPt.y, rop, useMask, srcPtMask.x, srcPtMask.y); } #if wxUSE_SPLINES @@ -206,6 +308,54 @@ public: void DrawSpline(wxList *points) { DoDrawSpline(points); } #endif // wxUSE_SPLINES + // Eventually we will have wxUSE_GENERIC_DRAWELLIPSE +#ifdef __WXWINCE__ + //! Generic method to draw ellipses, circles and arcs with current pen and brush. + /*! \param x Upper left corner of bounding box. + * \param y Upper left corner of bounding box. + * \param w Width of bounding box. + * \param h Height of bounding box. + * \param sa Starting angle of arc + * (counterclockwise, start at 3 o'clock, 360 is full circle). + * \param ea Ending angle of arc. + * \param angle Rotation angle, the Arc will be rotated after + * calculating begin and end. + */ + void DrawEllipticArcRot( wxCoord x, wxCoord y, + wxCoord width, wxCoord height, + double sa = 0, double ea = 0, double angle = 0 ) + { DoDrawEllipticArcRot( x, y, width, height, sa, ea, angle ); } + + void DrawEllipticArcRot( const wxPoint& pt, + const wxSize& sz, + double sa = 0, double ea = 0, double angle = 0 ) + { DoDrawEllipticArcRot( pt.x, pt.y, sz.x, sz.y, sa, ea, angle ); } + + void DrawEllipticArcRot( const wxRect& rect, + double sa = 0, double ea = 0, double angle = 0 ) + { DoDrawEllipticArcRot( rect.x, rect.y, rect.width, rect.height, sa, ea, angle ); } + + virtual void DoDrawEllipticArcRot( wxCoord x, wxCoord y, + wxCoord w, wxCoord h, + double sa = 0, double ea = 0, double angle = 0 ); + + //! Rotates points around center. + /*! This is a quite straight method, it calculates in pixels + * and so it produces rounding errors. + * \param points The points inside will be rotated. + * \param angle Rotating angle (counterclockwise, start at 3 o'clock, 360 is full circle). + * \param center Center of rotation. + */ + void Rotate( wxList* points, double angle, wxPoint center = wxPoint() ); + + // used by DrawEllipticArcRot + // Careful: wxList gets filled with points you have to delete later. + void CalculateEllipticPoints( wxList* points, + wxCoord xStart, wxCoord yStart, + wxCoord w, wxCoord h, + double sa, double ea ); +#endif + // global DC operations // -------------------- @@ -225,7 +375,9 @@ public: virtual void SetBrush(const wxBrush& brush) = 0; virtual void SetBackground(const wxBrush& brush) = 0; virtual void SetBackgroundMode(int mode) = 0; +#if wxUSE_PALETTE virtual void SetPalette(const wxPalette& palette) = 0; +#endif // wxUSE_PALETTE // clipping region // --------------- @@ -239,18 +391,22 @@ public: void SetClippingRegion(const wxRegion& region) { DoSetClippingRegionAsRegion(region); } - virtual void DestroyClippingRegion() = 0; + virtual void DestroyClippingRegion() { ResetClipping(); } void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *w, wxCoord *h) const { DoGetClippingBox(x, y, w, h); } void GetClippingBox(wxRect& rect) const - { DoGetClippingBox(&rect.x, &rect.y, &rect.width, &rect.height); } + { + DoGetClippingBox(&rect.x, &rect.y, &rect.width, &rect.height); + } // text extent // ----------- virtual wxCoord GetCharHeight() const = 0; virtual wxCoord GetCharWidth() const = 0; + + // only works for single line strings void GetTextExtent(const wxString& string, wxCoord *x, wxCoord *y, wxCoord *descent = NULL, @@ -258,6 +414,18 @@ public: wxFont *theFont = NULL) const { DoGetTextExtent(string, x, y, descent, externalLeading, theFont); } + // works for single as well as multi-line strings + virtual void GetMultiLineTextExtent(const wxString& text, + wxCoord *width, + wxCoord *height, + wxCoord *heightLine = NULL, + wxFont *font = NULL); + + // Measure cumulative width of text after each character + bool GetPartialTextExtents(const wxString& text, wxArrayInt& widths) const + { return DoGetPartialTextExtents(text, widths); } + + // size and resolution // ------------------- @@ -311,25 +479,17 @@ public: virtual bool Ok() const { return m_ok; } - // accessors - // --------- + // accessors and setters + // --------------------- - // const... + int GetBackgroundMode() const { return m_backgroundMode; } const wxBrush& GetBackground() const { return m_backgroundBrush; } const wxBrush& GetBrush() const { return m_brush; } const wxFont& GetFont() const { return m_font; } const wxPen& GetPen() const { return m_pen; } - const wxColour& GetTextBackground() const { return m_textBackgroundColour; } - const wxColour& GetTextForeground() const { return m_textForegroundColour; } - - // ... and non const - wxBrush& GetBackground() { return m_backgroundBrush; } - wxBrush& GetBrush() { return m_brush; } - wxFont& GetFont() { return m_font; } - wxPen& GetPen() { return m_pen; } - wxColour& GetTextBackground() { return m_textBackgroundColour; } - wxColour& GetTextForeground() { return m_textForegroundColour; } + const wxColour& GetTextForeground() const { return m_textForegroundColour; } + const wxColour& GetTextBackground() const { return m_textBackgroundColour; } virtual void SetTextForeground(const wxColour& colour) { m_textForegroundColour = colour; } virtual void SetTextBackground(const wxColour& colour) @@ -385,10 +545,29 @@ public: virtual void CalcBoundingBox(wxCoord x, wxCoord y) { - if ( x < m_minX ) m_minX = x; - if ( y < m_minY ) m_minY = y; - if ( x > m_maxX ) m_maxX = x; - if ( y > m_maxY ) m_maxY = y; + if ( m_isBBoxValid ) + { + if ( x < m_minX ) m_minX = x; + if ( y < m_minY ) m_minY = y; + if ( x > m_maxX ) m_maxX = x; + if ( y > m_maxY ) m_maxY = y; + } + else + { + m_isBBoxValid = TRUE; + + m_minX = x; + m_minY = y; + m_maxX = x; + m_maxY = y; + } + } + + void ResetBoundingBox() + { + m_isBBoxValid = FALSE; + + m_minX = m_maxX = m_minY = m_maxY = 0; } // Get the final bounding box of the PostScript or Metafile picture. @@ -401,7 +580,6 @@ public: // ------------------ // for compatibility with the old code when wxCoord was long everywhere -#ifndef __WIN16__ void GetTextExtent(const wxString& string, long *x, long *y, long *descent = NULL, @@ -441,20 +619,19 @@ public: if ( y ) *y = y2; } -#endif // !Win16 - -#if WXWIN_COMPATIBILITY - virtual void SetColourMap(const wxPalette& palette) { SetPalette(palette); } - void GetTextExtent(const wxString& string, float *x, float *y, - float *descent = NULL, float *externalLeading = NULL, - wxFont *theFont = NULL, bool use16bit = FALSE) const ; - void GetSize(float* width, float* height) const { int w, h; GetSize(& w, & h); *width = w; *height = h; } - void GetSizeMM(float *width, float *height) const { long w, h; GetSizeMM(& w, & h); *width = (float) w; *height = (float) h; } -#endif // WXWIN_COMPATIBILITY + void GetClippingBox(long *x, long *y, long *w, long *h) const + { + wxCoord xx,yy,ww,hh; + DoGetClippingBox(&xx, &yy, &ww, &hh); + if (x) *x = xx; + if (y) *y = yy; + if (w) *w = ww; + if (h) *h = hh; + } protected: // the pure virtual functions which should be implemented by wxDC - virtual void DoFloodFill(wxCoord x, wxCoord y, const wxColour& col, + virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col, int style = wxFLOOD_SURFACE) = 0; virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0; @@ -465,6 +642,8 @@ protected: virtual void DoDrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2, wxCoord xc, wxCoord yc) = 0; + virtual void DoDrawCheckMark(wxCoord x, wxCoord y, + wxCoord width, wxCoord height); virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h, double sa, double ea) = 0; @@ -482,11 +661,13 @@ protected: bool useMask = FALSE) = 0; virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y) = 0; + virtual void DoDrawRotatedText(const wxString& text, + wxCoord x, wxCoord y, double angle) = 0; virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height, wxDC *source, wxCoord xsrc, wxCoord ysrc, - int rop = wxCOPY, bool useMask = FALSE) = 0; + int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1) = 0; virtual void DoGetSize(int *width, int *height) const = 0; virtual void DoGetSizeMM(int* width, int* height) const = 0; @@ -496,6 +677,9 @@ protected: virtual void DoDrawPolygon(int n, wxPoint points[], wxCoord xoffset, wxCoord yoffset, int fillStyle = wxODDEVEN_RULE) = 0; + virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[], + wxCoord xoffset, wxCoord yoffset, + int fillStyle); virtual void DoSetClippingRegionAsRegion(const wxRegion& region) = 0; virtual void DoSetClippingRegion(wxCoord x, wxCoord y, @@ -508,17 +692,14 @@ protected: virtual void DoGetClippingBox(wxCoord *x, wxCoord *y, wxCoord *w, wxCoord *h) const { - if ( m_clipping ) - { - if ( x ) *x = m_clipX1; - if ( y ) *y = m_clipY1; - if ( w ) *w = m_clipX2 - m_clipX1; - if ( h ) *h = m_clipY2 - m_clipY1; - } - else - { - *x = *y = *w = *h = 0; - } + if ( x ) + *x = m_clipX1; + if ( y ) + *y = m_clipY1; + if ( w ) + *w = m_clipX2 - m_clipX1; + if ( h ) + *h = m_clipY2 - m_clipY1; } virtual void DoGetLogicalOrigin(wxCoord *x, wxCoord *y) const @@ -539,16 +720,27 @@ protected: wxCoord *externalLeading = NULL, wxFont *theFont = NULL) const = 0; + virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const; + #if wxUSE_SPLINES - virtual void DoDrawSpline(wxList *points) = 0; + virtual void DoDrawSpline(wxList *points); #endif protected: + // unset clipping variables (after clipping region was destroyed) + void ResetClipping() + { + m_clipping = false; + + m_clipX1 = m_clipX2 = m_clipY1 = m_clipY2 = 0; + } + // flags bool m_colour:1; bool m_ok:1; bool m_clipping:1; bool m_isInteractive:1; + bool m_isBBoxValid:1; // coordinate system variables @@ -579,10 +771,15 @@ protected: wxColour m_textForegroundColour; wxColour m_textBackgroundColour; wxFont m_font; + +#if wxUSE_PALETTE wxPalette m_palette; + bool m_hasCustomPalette; +#endif // wxUSE_PALETTE private: - DECLARE_NO_COPY_CLASS(wxDCBase); + DECLARE_NO_COPY_CLASS(wxDCBase) + DECLARE_ABSTRACT_CLASS(wxDCBase) }; // ---------------------------------------------------------------------------- @@ -595,15 +792,69 @@ private: #include "wx/motif/dc.h" #elif defined(__WXGTK__) #include "wx/gtk/dc.h" -#elif defined(__WXQT__) - #include "wx/qt/dc.h" +#elif defined(__WXX11__) + #include "wx/x11/dc.h" +#elif defined(__WXMGL__) + #include "wx/mgl/dc.h" #elif defined(__WXMAC__) #include "wx/mac/dc.h" +#elif defined(__WXCOCOA__) + #include "wx/cocoa/dc.h" #elif defined(__WXPM__) #include "wx/os2/dc.h" -#elif defined(__WXSTUBS__) - #include "wx/stubs/dc.h" #endif +// ---------------------------------------------------------------------------- +// helper class: you can use it to temporarily change the DC text colour and +// restore it automatically when the object goes out of scope +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxDCTextColourChanger +{ +public: + wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { } + + ~wxDCTextColourChanger() + { + if ( m_colFgOld.Ok() ) + m_dc.SetTextForeground(m_colFgOld); + } + + void Set(const wxColour& col) + { + if ( !m_colFgOld.Ok() ) + m_colFgOld = m_dc.GetTextForeground(); + m_dc.SetTextForeground(col); + } + +private: + wxDC& m_dc; + + wxColour m_colFgOld; + + DECLARE_NO_COPY_CLASS(wxDCTextColourChanger) +}; + +// ---------------------------------------------------------------------------- +// another small helper class: sets the clipping region in its ctor and +// destroys it in the dtor +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxDCClipper +{ +public: + wxDCClipper(wxDC& dc, const wxRect& r) : m_dc(dc) + { dc.SetClippingRegion(r.x, r.y, r.width, r.height); } + wxDCClipper(wxDC& dc, wxCoord x, wxCoord y, wxCoord w, wxCoord h) : m_dc(dc) + { dc.SetClippingRegion(x, y, w, h); } + + ~wxDCClipper() { m_dc.DestroyClippingRegion(); } + +private: + wxDC& m_dc; + + DECLARE_NO_COPY_CLASS(wxDCClipper) +}; + #endif // _WX_DC_H_BASE_