346 lines
12 KiB
C++
346 lines
12 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/msw/dc.h
|
|
// Purpose: wxDC class
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 01/02/97
|
|
// RCS-ID: $Id: dc.h 42612 2006-10-29 10:46:49Z SC $
|
|
// Copyright: (c) Julian Smart
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_MSW_DC_H_
|
|
#define _WX_MSW_DC_H_
|
|
|
|
#include "wx/defs.h"
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// macros
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#if wxUSE_DC_CACHEING
|
|
/*
|
|
* Cached blitting, maintaining a cache
|
|
* of bitmaps required for transparent blitting
|
|
* instead of constant creation/deletion
|
|
*/
|
|
|
|
class wxDCCacheEntry: public wxObject
|
|
{
|
|
public:
|
|
wxDCCacheEntry(WXHBITMAP hBitmap, int w, int h, int depth);
|
|
wxDCCacheEntry(WXHDC hDC, int depth);
|
|
virtual ~wxDCCacheEntry();
|
|
|
|
WXHBITMAP m_bitmap;
|
|
WXHDC m_dc;
|
|
int m_width;
|
|
int m_height;
|
|
int m_depth;
|
|
};
|
|
#endif
|
|
|
|
// this is an ABC: use one of the derived classes to create a DC associated
|
|
// with a window, screen, printer and so on
|
|
class WXDLLEXPORT wxDC : public wxDCBase
|
|
{
|
|
public:
|
|
wxDC(WXHDC hDC) { Init(); m_hDC = hDC; }
|
|
virtual ~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);
|
|
#if wxUSE_PALETTE
|
|
virtual void SetPalette(const wxPalette& palette);
|
|
#endif // wxUSE_PALETTE
|
|
|
|
virtual void DestroyClippingRegion();
|
|
|
|
virtual wxCoord GetCharHeight() const;
|
|
virtual wxCoord GetCharWidth() 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 SelectOldObjects(WXHDC dc);
|
|
|
|
wxWindow *GetWindow() const { return m_canvas; }
|
|
void SetWindow(wxWindow *win)
|
|
{
|
|
m_canvas = win;
|
|
|
|
#if wxUSE_PALETTE
|
|
// if we have palettes use the correct one for this window
|
|
InitializePalette();
|
|
#endif // wxUSE_PALETTE
|
|
}
|
|
|
|
WXHDC GetHDC() const { return m_hDC; }
|
|
void SetHDC(WXHDC dc, bool bOwnsDC = false)
|
|
{
|
|
m_hDC = dc;
|
|
m_bOwnsDC = bOwnsDC;
|
|
|
|
// we might have a pre existing clipping region, make sure that we
|
|
// return it if asked -- but avoid calling ::GetClipBox() right now as
|
|
// it could be unnecessary wasteful
|
|
m_clipping = true;
|
|
m_clipX1 =
|
|
m_clipX2 = 0;
|
|
}
|
|
|
|
const wxBitmap& GetSelectedBitmap() const { return m_selectedBitmap; }
|
|
wxBitmap& GetSelectedBitmap() { return m_selectedBitmap; }
|
|
|
|
// update the internal clip box variables
|
|
void UpdateClipBox();
|
|
|
|
#if wxUSE_DC_CACHEING
|
|
static wxDCCacheEntry* FindBitmapInCache(WXHDC hDC, int w, int h);
|
|
static wxDCCacheEntry* FindDCInCache(wxDCCacheEntry* notThis, WXHDC hDC);
|
|
|
|
static void AddToBitmapCache(wxDCCacheEntry* entry);
|
|
static void AddToDCCache(wxDCCacheEntry* entry);
|
|
static void ClearCache();
|
|
#endif
|
|
|
|
// RTL related functions
|
|
// ---------------------
|
|
|
|
// get or change the layout direction (LTR or RTL) for this dc,
|
|
// wxLayout_Default is returned if layout direction is not supported
|
|
virtual wxLayoutDirection GetLayoutDirection() const;
|
|
virtual void SetLayoutDirection(wxLayoutDirection dir);
|
|
|
|
protected:
|
|
void Init()
|
|
{
|
|
m_canvas = NULL;
|
|
m_bOwnsDC = false;
|
|
m_hDC = NULL;
|
|
|
|
m_oldBitmap = NULL;
|
|
m_oldPen = NULL;
|
|
m_oldBrush = NULL;
|
|
m_oldFont = NULL;
|
|
|
|
#if wxUSE_PALETTE
|
|
m_oldPalette = NULL;
|
|
#endif // wxUSE_PALETTE
|
|
}
|
|
|
|
// create an uninitialized DC: this should be only used by the derived
|
|
// classes
|
|
wxDC() { Init(); }
|
|
|
|
virtual void DoGetTextExtent(const wxString& string,
|
|
wxCoord *x, wxCoord *y,
|
|
wxCoord *descent = NULL,
|
|
wxCoord *externalLeading = NULL,
|
|
wxFont *theFont = NULL) const;
|
|
virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
|
|
|
|
virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
|
|
int style = wxFLOOD_SURFACE);
|
|
|
|
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;
|
|
|
|
virtual void DoDrawPoint(wxCoord x, wxCoord y);
|
|
virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
|
|
|
|
virtual void DoDrawArc(wxCoord x1, wxCoord y1,
|
|
wxCoord x2, wxCoord y2,
|
|
wxCoord xc, wxCoord yc);
|
|
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);
|
|
|
|
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);
|
|
|
|
#if wxUSE_SPLINES
|
|
virtual void DoDrawSpline(wxList *points);
|
|
#endif
|
|
|
|
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 bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
|
|
wxDC *source, wxCoord xsrc, wxCoord ysrc,
|
|
int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
|
|
|
|
// 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 DoGetClippingBox(wxCoord *x, wxCoord *y,
|
|
wxCoord *w, wxCoord *h) 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);
|
|
virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
|
|
wxCoord xoffset, wxCoord yoffset,
|
|
int fillStyle = wxODDEVEN_RULE);
|
|
virtual wxBitmap DoGetAsBitmap(const wxRect *subrect) const
|
|
{ return subrect == NULL ? GetSelectedBitmap() : GetSelectedBitmap().GetSubBitmap(*subrect); }
|
|
|
|
|
|
#if wxUSE_PALETTE
|
|
// MSW specific, select a logical palette into the HDC
|
|
// (tell windows to translate pixel from other palettes to our custom one
|
|
// and vice versa)
|
|
// Realize tells it to also reset the system palette to this one.
|
|
void DoSelectPalette(bool realize = false);
|
|
|
|
// Find out what palette our parent window has, then select it into the dc
|
|
void InitializePalette();
|
|
#endif // wxUSE_PALETTE
|
|
|
|
// common part of DoDrawText() and DoDrawRotatedText()
|
|
void DrawAnyText(const wxString& text, wxCoord x, wxCoord y);
|
|
|
|
// common part of DoSetClippingRegion() and DoSetClippingRegionAsRegion()
|
|
void SetClippingHrgn(WXHRGN hrgn);
|
|
|
|
// implementation of DoGetSize() for wxScreen/PrinterDC: this simply
|
|
// returns the size of the entire device this DC is associated with
|
|
//
|
|
// notice that we intentionally put it in a separate function instead of
|
|
// DoGetSize() itself because we want it to remain pure virtual both
|
|
// because each derived class should take care to define it as needed (this
|
|
// implementation is not at all always appropriate) and because we want
|
|
// wxDC to be an ABC to prevent it from being created directly
|
|
void GetDeviceSize(int *width, int *height) const;
|
|
|
|
|
|
// MSW-specific member variables
|
|
// -----------------------------
|
|
|
|
// 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
|
|
WXHDC m_hDC;
|
|
|
|
// 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;
|
|
|
|
#if wxUSE_PALETTE
|
|
WXHPALETTE m_oldPalette;
|
|
#endif // wxUSE_PALETTE
|
|
|
|
#if wxUSE_DC_CACHEING
|
|
static wxList sm_bitmapCache;
|
|
static wxList sm_dcCache;
|
|
#endif
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxDC)
|
|
DECLARE_NO_COPY_CLASS(wxDC)
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxDCTemp: a wxDC which doesn't free the given HDC (used by wxWidgets
|
|
// only/mainly)
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLEXPORT wxDCTemp : public wxDC
|
|
{
|
|
public:
|
|
// construct a temporary DC with the specified HDC and size (it should be
|
|
// specified whenever we know it for this HDC)
|
|
wxDCTemp(WXHDC hdc, const wxSize& size = wxDefaultSize)
|
|
: wxDC(hdc),
|
|
m_size(size)
|
|
{
|
|
}
|
|
|
|
virtual ~wxDCTemp()
|
|
{
|
|
// prevent base class dtor from freeing it
|
|
SetHDC((WXHDC)NULL);
|
|
}
|
|
|
|
protected:
|
|
virtual void DoGetSize(int *w, int *h) const
|
|
{
|
|
wxASSERT_MSG( m_size.IsFullySpecified(),
|
|
_T("size of this DC hadn't been set and is unknown") );
|
|
|
|
if ( w )
|
|
*w = m_size.x;
|
|
if ( h )
|
|
*h = m_size.y;
|
|
}
|
|
|
|
private:
|
|
// size of this DC must be explicitly set by SetSize() as we have no way to
|
|
// find it ourselves
|
|
const wxSize m_size;
|
|
|
|
DECLARE_NO_COPY_CLASS(wxDCTemp)
|
|
};
|
|
|
|
#endif // _WX_MSW_DC_H_
|
|
|