/////////////////////////////////////////////////////////////////////////////
-// Name: dc.h
+// Name: wx/dc.h
// Purpose: wxDC class
// Author: Vadim Zeitlin
// 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_
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma interface "dcbase.h"
-#endif
-
// ----------------------------------------------------------------------------
// headers which we must include here
// ----------------------------------------------------------------------------
#include "wx/cursor.h" // we have member variables of these classes
#include "wx/font.h" // so we can't do without them
#include "wx/colour.h"
+#include "wx/bitmap.h" // for wxNullBitmap
#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"
+#include "wx/math.h"
class WXDLLEXPORT wxDC;
class WXDLLEXPORT wxDCBase;
public:
wxDrawObject()
- : m_isBBoxValid(FALSE)
+ : m_isBBoxValid(false)
, m_minX(0), m_minY(0), m_maxX(0), m_maxY(0)
{ }
}
else
{
- m_isBBoxValid = TRUE;
+ m_isBBoxValid = true;
m_minX = x;
m_minY = y;
void ResetBoundingBox()
{
- m_isBBoxValid = FALSE;
+ m_isBBoxValid = false;
m_minX = m_maxX = m_minY = m_maxY = 0;
}
// global variables
// ---------------------------------------------------------------------------
-WXDLLEXPORT_DATA(extern int) wxPageNumber;
-
// ---------------------------------------------------------------------------
// wxDC is the device context - object on which any drawing is done
// ---------------------------------------------------------------------------
public:
wxDCBase()
: m_colour(wxColourDisplay())
- , m_ok(TRUE)
- , m_clipping(FALSE)
+ , m_ok(true)
+ , m_clipping(false)
, m_isInteractive(0)
- , m_isBBoxValid(FALSE)
+ , m_isBBoxValid(false)
, m_logicalOriginX(0), m_logicalOriginY(0)
, m_deviceOriginX(0), m_deviceOriginY(0)
, m_logicalScaleX(1.0), m_logicalScaleY(1.0)
, m_font()
#if wxUSE_PALETTE
, m_palette()
- , m_hasCustomPalette(FALSE)
+ , m_hasCustomPalette(false)
#endif // wxUSE_PALETTE
{
ResetBoundingBox();
+ ResetClipping();
}
- ~wxDCBase() { }
+ virtual ~wxDCBase() { }
- virtual void BeginDrawing() { }
- virtual void EndDrawing() { }
+#if WXWIN_COMPATIBILITY_2_6
+ wxDEPRECATED( virtual void BeginDrawing() );
+ wxDEPRECATED( virtual void EndDrawing() );
+#endif // WXWIN_COMPATIBILITY_2_6
// graphic primitives
// ------------------
int style = wxFLOOD_SURFACE)
{ return DoFloodFill(pt.x, pt.y, col, style); }
+ // fill the area specified by rect with a radial gradient, starting from
+ // initialColour in the centre of the cercle and fading to destColour.
+ void GradientFillConcentric(const wxRect& rect,
+ const wxColour& initialColour,
+ const wxColour& destColour)
+ { GradientFillConcentric(rect, initialColour, destColour,
+ wxPoint(rect.GetWidth() / 2,
+ rect.GetHeight() / 2)); }
+
+ void GradientFillConcentric(const wxRect& rect,
+ const wxColour& initialColour,
+ const wxColour& destColour,
+ const wxPoint& circleCenter);
+
+ // fill the area specified by rect with a linear gradient
+ void GradientFillLinear(const wxRect& rect,
+ const wxColour& initialColour,
+ const wxColour& destColour,
+ wxDirection nDirection = wxEAST)
+ { DoGradientFillLinear(rect, initialColour, destColour, nDirection); }
+
bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const
{ return DoGetPixel(x, y, col); }
bool GetPixel(const wxPoint& pt, wxColour *col) const
{ DoDrawIcon(icon, pt.x, pt.y); }
void DrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
- bool useMask = FALSE)
+ bool useMask = false)
{ DoDrawBitmap(bmp, x, y, useMask); }
void DrawBitmap(const wxBitmap &bmp, const wxPoint& pt,
- bool useMask = FALSE)
+ bool useMask = false)
{ DoDrawBitmap(bmp, pt.x, pt.y, useMask); }
void DrawText(const wxString& text, wxCoord x, wxCoord y)
bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
wxDC *source, wxCoord xsrc, wxCoord ysrc,
- int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1)
+ int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord)
{
return DoBlit(xdest, ydest, width, height,
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, const wxPoint& srcPtMask = wxPoint(-1, -1))
+ int rop = wxCOPY, bool useMask = false, const wxPoint& srcPtMask = wxDefaultPosition)
{
return DoBlit(destPt.x, destPt.y, sz.x, sz.y,
source, srcPt.x, srcPt.y, rop, useMask, srcPtMask.x, srcPtMask.y);
* \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
+ * \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
+ * \param angle Rotation angle, the Arc will be rotated after
* calculating begin and end.
*/
- void DrawEllipticArcRot( wxCoord x, wxCoord y,
- wxCoord width, wxCoord height,
+ 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,
+
+ 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 ); }
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,
+ 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() );
+ */
+ void Rotate( wxList* points, double angle, wxPoint center = wxPoint(0,0) );
// 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,
+ void CalculateEllipticPoints( wxList* points,
+ wxCoord xStart, wxCoord yStart,
+ wxCoord w, wxCoord h,
double sa, double ea );
#endif
-
+
// global DC operations
// --------------------
virtual void Clear() = 0;
- virtual bool StartDoc(const wxString& WXUNUSED(message)) { return TRUE; }
+ virtual bool StartDoc(const wxString& WXUNUSED(message)) { return true; }
virtual void EndDoc() { }
virtual void StartPage() { }
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
{
-#if 1
DoGetClippingBox(&rect.x, &rect.y, &rect.width, &rect.height);
-#else
- // Necessary to use intermediate variables for 16-bit compilation
- // REMOVE ME if the above is OK for all current platforms
- wxCoord x, y, w, h;
- DoGetClippingBox(&x, &y, &w, &h);
- rect.x = x; rect.y = y; rect.width = w; rect.height = h;
-#endif
}
// text extent
bool GetPartialTextExtents(const wxString& text, wxArrayInt& widths) const
{ return DoGetPartialTextExtents(text, widths); }
-
+
// size and resolution
// -------------------
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)
{ wxCoord x, y; DoGetDeviceOrigin(&x, &y); return wxPoint(x, y); }
virtual void SetDeviceOrigin(wxCoord x, wxCoord y) = 0;
+ virtual void ComputeScaleAndOrigin() {}
+
virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp) = 0;
int GetLogicalFunction() const { return m_logicalFunction; }
virtual void SetLogicalFunction(int function) = 0;
- // Sometimes we need to override optimization, e.g. if other software is
- // drawing onto our surface and we can't be sure of who's done what.
- //
- // FIXME: is this (still) used?
+#if WXWIN_COMPATIBILITY_2_4
virtual void SetOptimization(bool WXUNUSED(opt)) { }
- virtual bool GetOptimization() { return FALSE; }
+ virtual bool GetOptimization() { return false; }
+#endif
// bounding box
// ------------
}
else
{
- m_isBBoxValid = TRUE;
+ m_isBBoxValid = true;
m_minX = x;
m_minY = y;
void ResetBoundingBox()
{
- m_isBBoxValid = FALSE;
+ m_isBBoxValid = false;
m_minX = m_maxX = m_minY = m_maxY = 0;
}
// ------------------
// 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,
if (w) *w = ww;
if (h) *h = hh;
}
-#endif // !Win16
protected:
// the pure virtual functions which should be implemented by wxDC
virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
int style = wxFLOOD_SURFACE) = 0;
+ virtual void DoGradientFillLinear(const wxRect& rect,
+ const wxColour& initialColour,
+ const wxColour& destColour,
+ wxDirection nDirection = wxEAST);
+
virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0;
virtual void DoDrawPoint(wxCoord x, wxCoord y) = 0;
virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y) = 0;
virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
- bool useMask = FALSE) = 0;
+ bool useMask = false) = 0;
virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y) = 0;
virtual void DoDrawRotatedText(const wxString& text,
virtual bool DoBlit(wxCoord xdest, wxCoord ydest,
wxCoord width, wxCoord height,
wxDC *source, wxCoord xsrc, wxCoord ysrc,
- int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1) = 0;
+ int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord) = 0;
virtual void DoGetSize(int *width, int *height) const = 0;
virtual void DoGetSizeMM(int* width, int* height) const = 0;
virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
wxCoord width, wxCoord height) = 0;
- // FIXME are these functions really different?
+#if WXWIN_COMPATIBILITY_2_4
+ // this was only for confusing people, use DoGetClippingBox only
virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
wxCoord *w, wxCoord *h)
{ DoGetClippingBox(x, y, w, h); }
+#endif
+
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
wxCoord *descent = NULL,
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);
#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;
// now include the declaration of wxDC class
// ----------------------------------------------------------------------------
-#if defined(__WXMSW__)
+#if defined(__WXPALMOS__)
+ #include "wx/palmos/dc.h"
+#elif defined(__WXMSW__)
#include "wx/msw/dc.h"
#elif defined(__WXMOTIF__)
#include "wx/motif/dc.h"
-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)
#include "wx/gtk/dc.h"
+#elif defined(__WXGTK__)
+ #include "wx/gtk1/dc.h"
#elif defined(__WXX11__)
#include "wx/x11/dc.h"
#elif defined(__WXMGL__)
#include "wx/mgl/dc.h"
+#elif defined(__WXDFB__)
+ #include "wx/dfb/dc.h"
#elif defined(__WXMAC__)
#include "wx/mac/dc.h"
#elif defined(__WXCOCOA__)
DECLARE_NO_COPY_CLASS(wxDCTextColourChanger)
};
+// ----------------------------------------------------------------------------
+// helper class: you can use it to temporarily change the DC pen and
+// restore it automatically when the object goes out of scope
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxDCPenChanger
+{
+public:
+ wxDCPenChanger(wxDC& dc, const wxPen& pen) : m_dc(dc), m_penOld(dc.GetPen())
+ {
+ m_dc.SetPen(pen);
+ }
+
+ ~wxDCPenChanger()
+ {
+ if ( m_penOld.Ok() )
+ m_dc.SetPen(m_penOld);
+ }
+
+private:
+ wxDC& m_dc;
+
+ wxPen m_penOld;
+
+ DECLARE_NO_COPY_CLASS(wxDCPenChanger)
+};
+
+// ----------------------------------------------------------------------------
+// helper class: you can use it to temporarily change the DC brush and
+// restore it automatically when the object goes out of scope
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxDCBrushChanger
+{
+public:
+ wxDCBrushChanger(wxDC& dc, const wxBrush& brush) : m_dc(dc), m_brushOld(dc.GetBrush())
+ {
+ m_dc.SetBrush(brush);
+ }
+
+ ~wxDCBrushChanger()
+ {
+ if ( m_brushOld.Ok() )
+ m_dc.SetBrush(m_brushOld);
+ }
+
+private:
+ wxDC& m_dc;
+
+ wxBrush m_brushOld;
+
+ DECLARE_NO_COPY_CLASS(wxDCBrushChanger)
+};
+
// ----------------------------------------------------------------------------
// 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 wxRegion& r) : m_dc(dc)
+ { dc.SetClippingRegion(r); }
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)
projects / wxWidgets.git / blobdiff