| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: wx/dc.h |
| 3 | // Purpose: wxDC class |
| 4 | // Author: Vadim Zeitlin |
| 5 | // Modified by: |
| 6 | // Created: 05/25/99 |
| 7 | // RCS-ID: $Id$ |
| 8 | // Copyright: (c) wxWidgets team |
| 9 | // Licence: wxWindows licence |
| 10 | ///////////////////////////////////////////////////////////////////////////// |
| 11 | |
| 12 | #ifndef _WX_DC_H_BASE_ |
| 13 | #define _WX_DC_H_BASE_ |
| 14 | |
| 15 | // ---------------------------------------------------------------------------- |
| 16 | // headers which we must include here |
| 17 | // ---------------------------------------------------------------------------- |
| 18 | |
| 19 | #include "wx/object.h" // the base class |
| 20 | |
| 21 | #include "wx/intl.h" // for wxLayoutDirection |
| 22 | #include "wx/cursor.h" // we have member variables of these classes |
| 23 | #include "wx/font.h" // so we can't do without them |
| 24 | #include "wx/colour.h" |
| 25 | #include "wx/bitmap.h" // for wxNullBitmap |
| 26 | #include "wx/brush.h" |
| 27 | #include "wx/pen.h" |
| 28 | #include "wx/palette.h" |
| 29 | #include "wx/list.h" // we use wxList in inline functions |
| 30 | #include "wx/dynarray.h" |
| 31 | #include "wx/math.h" |
| 32 | |
| 33 | class WXDLLEXPORT wxDC; |
| 34 | class WXDLLEXPORT wxDCBase; |
| 35 | |
| 36 | class WXDLLEXPORT wxDrawObject |
| 37 | { |
| 38 | public: |
| 39 | |
| 40 | wxDrawObject() |
| 41 | : m_isBBoxValid(false) |
| 42 | , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0) |
| 43 | { } |
| 44 | |
| 45 | virtual ~wxDrawObject() { } |
| 46 | |
| 47 | virtual void Draw(wxDCBase&) const { } |
| 48 | |
| 49 | virtual void CalcBoundingBox(wxCoord x, wxCoord y) |
| 50 | { |
| 51 | if ( m_isBBoxValid ) |
| 52 | { |
| 53 | if ( x < m_minX ) m_minX = x; |
| 54 | if ( y < m_minY ) m_minY = y; |
| 55 | if ( x > m_maxX ) m_maxX = x; |
| 56 | if ( y > m_maxY ) m_maxY = y; |
| 57 | } |
| 58 | else |
| 59 | { |
| 60 | m_isBBoxValid = true; |
| 61 | |
| 62 | m_minX = x; |
| 63 | m_minY = y; |
| 64 | m_maxX = x; |
| 65 | m_maxY = y; |
| 66 | } |
| 67 | } |
| 68 | |
| 69 | void ResetBoundingBox() |
| 70 | { |
| 71 | m_isBBoxValid = false; |
| 72 | |
| 73 | m_minX = m_maxX = m_minY = m_maxY = 0; |
| 74 | } |
| 75 | |
| 76 | // Get the final bounding box of the PostScript or Metafile picture. |
| 77 | |
| 78 | wxCoord MinX() const { return m_minX; } |
| 79 | wxCoord MaxX() const { return m_maxX; } |
| 80 | wxCoord MinY() const { return m_minY; } |
| 81 | wxCoord MaxY() const { return m_maxY; } |
| 82 | |
| 83 | //to define the type of object for derived objects |
| 84 | virtual int GetType()=0; |
| 85 | |
| 86 | protected: |
| 87 | //for boundingbox calculation |
| 88 | bool m_isBBoxValid:1; |
| 89 | //for boundingbox calculation |
| 90 | wxCoord m_minX, m_minY, m_maxX, m_maxY; |
| 91 | }; |
| 92 | |
| 93 | // --------------------------------------------------------------------------- |
| 94 | // global variables |
| 95 | // --------------------------------------------------------------------------- |
| 96 | |
| 97 | // --------------------------------------------------------------------------- |
| 98 | // wxDC is the device context - object on which any drawing is done |
| 99 | // --------------------------------------------------------------------------- |
| 100 | |
| 101 | class WXDLLEXPORT wxDCBase : public wxObject |
| 102 | { |
| 103 | public: |
| 104 | wxDCBase() |
| 105 | : m_colour(wxColourDisplay()) |
| 106 | , m_ok(true) |
| 107 | , m_clipping(false) |
| 108 | , m_isInteractive(0) |
| 109 | , m_isBBoxValid(false) |
| 110 | , m_logicalOriginX(0), m_logicalOriginY(0) |
| 111 | , m_deviceOriginX(0), m_deviceOriginY(0) |
| 112 | , m_logicalScaleX(1.0), m_logicalScaleY(1.0) |
| 113 | , m_userScaleX(1.0), m_userScaleY(1.0) |
| 114 | , m_scaleX(1.0), m_scaleY(1.0) |
| 115 | , m_signX(1), m_signY(1) |
| 116 | , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0) |
| 117 | , m_clipX1(0), m_clipY1(0), m_clipX2(0), m_clipY2(0) |
| 118 | , m_logicalFunction(wxCOPY) |
| 119 | , m_backgroundMode(wxTRANSPARENT) |
| 120 | , m_mappingMode(wxMM_TEXT) |
| 121 | , m_pen() |
| 122 | , m_brush() |
| 123 | , m_backgroundBrush(*wxTRANSPARENT_BRUSH) |
| 124 | , m_textForegroundColour(*wxBLACK) |
| 125 | , m_textBackgroundColour(*wxWHITE) |
| 126 | , m_font() |
| 127 | #if wxUSE_PALETTE |
| 128 | , m_palette() |
| 129 | , m_hasCustomPalette(false) |
| 130 | #endif // wxUSE_PALETTE |
| 131 | { |
| 132 | ResetBoundingBox(); |
| 133 | ResetClipping(); |
| 134 | } |
| 135 | |
| 136 | virtual ~wxDCBase() { } |
| 137 | |
| 138 | // graphic primitives |
| 139 | // ------------------ |
| 140 | |
| 141 | virtual void DrawObject(wxDrawObject* drawobject) |
| 142 | { |
| 143 | drawobject->Draw(*this); |
| 144 | CalcBoundingBox(drawobject->MinX(),drawobject->MinY()); |
| 145 | CalcBoundingBox(drawobject->MaxX(),drawobject->MaxY()); |
| 146 | } |
| 147 | |
| 148 | bool FloodFill(wxCoord x, wxCoord y, const wxColour& col, |
| 149 | int style = wxFLOOD_SURFACE) |
| 150 | { return DoFloodFill(x, y, col, style); } |
| 151 | bool FloodFill(const wxPoint& pt, const wxColour& col, |
| 152 | int style = wxFLOOD_SURFACE) |
| 153 | { return DoFloodFill(pt.x, pt.y, col, style); } |
| 154 | |
| 155 | // fill the area specified by rect with a radial gradient, starting from |
| 156 | // initialColour in the centre of the cercle and fading to destColour. |
| 157 | void GradientFillConcentric(const wxRect& rect, |
| 158 | const wxColour& initialColour, |
| 159 | const wxColour& destColour) |
| 160 | { GradientFillConcentric(rect, initialColour, destColour, |
| 161 | wxPoint(rect.GetWidth() / 2, |
| 162 | rect.GetHeight() / 2)); } |
| 163 | |
| 164 | void GradientFillConcentric(const wxRect& rect, |
| 165 | const wxColour& initialColour, |
| 166 | const wxColour& destColour, |
| 167 | const wxPoint& circleCenter) |
| 168 | { DoGradientFillConcentric(rect, initialColour, destColour, circleCenter); } |
| 169 | |
| 170 | // fill the area specified by rect with a linear gradient |
| 171 | void GradientFillLinear(const wxRect& rect, |
| 172 | const wxColour& initialColour, |
| 173 | const wxColour& destColour, |
| 174 | wxDirection nDirection = wxEAST) |
| 175 | { DoGradientFillLinear(rect, initialColour, destColour, nDirection); } |
| 176 | |
| 177 | bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const |
| 178 | { return DoGetPixel(x, y, col); } |
| 179 | bool GetPixel(const wxPoint& pt, wxColour *col) const |
| 180 | { return DoGetPixel(pt.x, pt.y, col); } |
| 181 | |
| 182 | void DrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2) |
| 183 | { DoDrawLine(x1, y1, x2, y2); } |
| 184 | void DrawLine(const wxPoint& pt1, const wxPoint& pt2) |
| 185 | { DoDrawLine(pt1.x, pt1.y, pt2.x, pt2.y); } |
| 186 | |
| 187 | void CrossHair(wxCoord x, wxCoord y) |
| 188 | { DoCrossHair(x, y); } |
| 189 | void CrossHair(const wxPoint& pt) |
| 190 | { DoCrossHair(pt.x, pt.y); } |
| 191 | |
| 192 | void DrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2, |
| 193 | wxCoord xc, wxCoord yc) |
| 194 | { DoDrawArc(x1, y1, x2, y2, xc, yc); } |
| 195 | void DrawArc(const wxPoint& pt1, const wxPoint& pt2, const wxPoint& centre) |
| 196 | { DoDrawArc(pt1.x, pt1.y, pt2.x, pt2.y, centre.x, centre.y); } |
| 197 | |
| 198 | void DrawCheckMark(wxCoord x, wxCoord y, |
| 199 | wxCoord width, wxCoord height) |
| 200 | { DoDrawCheckMark(x, y, width, height); } |
| 201 | void DrawCheckMark(const wxRect& rect) |
| 202 | { DoDrawCheckMark(rect.x, rect.y, rect.width, rect.height); } |
| 203 | |
| 204 | void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h, |
| 205 | double sa, double ea) |
| 206 | { DoDrawEllipticArc(x, y, w, h, sa, ea); } |
| 207 | void DrawEllipticArc(const wxPoint& pt, const wxSize& sz, |
| 208 | double sa, double ea) |
| 209 | { DoDrawEllipticArc(pt.x, pt.y, sz.x, sz.y, sa, ea); } |
| 210 | |
| 211 | void DrawPoint(wxCoord x, wxCoord y) |
| 212 | { DoDrawPoint(x, y); } |
| 213 | void DrawPoint(const wxPoint& pt) |
| 214 | { DoDrawPoint(pt.x, pt.y); } |
| 215 | |
| 216 | void DrawLines(int n, wxPoint points[], |
| 217 | wxCoord xoffset = 0, wxCoord yoffset = 0) |
| 218 | { DoDrawLines(n, points, xoffset, yoffset); } |
| 219 | void DrawLines(const wxList *list, |
| 220 | wxCoord xoffset = 0, wxCoord yoffset = 0); |
| 221 | |
| 222 | void DrawPolygon(int n, wxPoint points[], |
| 223 | wxCoord xoffset = 0, wxCoord yoffset = 0, |
| 224 | int fillStyle = wxODDEVEN_RULE) |
| 225 | { DoDrawPolygon(n, points, xoffset, yoffset, fillStyle); } |
| 226 | |
| 227 | void DrawPolygon(const wxList *list, |
| 228 | wxCoord xoffset = 0, wxCoord yoffset = 0, |
| 229 | int fillStyle = wxODDEVEN_RULE); |
| 230 | |
| 231 | void DrawPolyPolygon(int n, int count[], wxPoint points[], |
| 232 | wxCoord xoffset = 0, wxCoord yoffset = 0, |
| 233 | int fillStyle = wxODDEVEN_RULE) |
| 234 | { DoDrawPolyPolygon(n, count, points, xoffset, yoffset, fillStyle); } |
| 235 | |
| 236 | void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height) |
| 237 | { DoDrawRectangle(x, y, width, height); } |
| 238 | void DrawRectangle(const wxPoint& pt, const wxSize& sz) |
| 239 | { DoDrawRectangle(pt.x, pt.y, sz.x, sz.y); } |
| 240 | void DrawRectangle(const wxRect& rect) |
| 241 | { DoDrawRectangle(rect.x, rect.y, rect.width, rect.height); } |
| 242 | |
| 243 | void DrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height, |
| 244 | double radius) |
| 245 | { DoDrawRoundedRectangle(x, y, width, height, radius); } |
| 246 | void DrawRoundedRectangle(const wxPoint& pt, const wxSize& sz, |
| 247 | double radius) |
| 248 | { DoDrawRoundedRectangle(pt.x, pt.y, sz.x, sz.y, radius); } |
| 249 | void DrawRoundedRectangle(const wxRect& r, double radius) |
| 250 | { DoDrawRoundedRectangle(r.x, r.y, r.width, r.height, radius); } |
| 251 | |
| 252 | void DrawCircle(wxCoord x, wxCoord y, wxCoord radius) |
| 253 | { DoDrawEllipse(x - radius, y - radius, 2*radius, 2*radius); } |
| 254 | void DrawCircle(const wxPoint& pt, wxCoord radius) |
| 255 | { DrawCircle(pt.x, pt.y, radius); } |
| 256 | |
| 257 | void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height) |
| 258 | { DoDrawEllipse(x, y, width, height); } |
| 259 | void DrawEllipse(const wxPoint& pt, const wxSize& sz) |
| 260 | { DoDrawEllipse(pt.x, pt.y, sz.x, sz.y); } |
| 261 | void DrawEllipse(const wxRect& rect) |
| 262 | { DoDrawEllipse(rect.x, rect.y, rect.width, rect.height); } |
| 263 | |
| 264 | void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y) |
| 265 | { DoDrawIcon(icon, x, y); } |
| 266 | void DrawIcon(const wxIcon& icon, const wxPoint& pt) |
| 267 | { DoDrawIcon(icon, pt.x, pt.y); } |
| 268 | |
| 269 | void DrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y, |
| 270 | bool useMask = false) |
| 271 | { DoDrawBitmap(bmp, x, y, useMask); } |
| 272 | void DrawBitmap(const wxBitmap &bmp, const wxPoint& pt, |
| 273 | bool useMask = false) |
| 274 | { DoDrawBitmap(bmp, pt.x, pt.y, useMask); } |
| 275 | |
| 276 | void DrawText(const wxString& text, wxCoord x, wxCoord y) |
| 277 | { DoDrawText(text, x, y); } |
| 278 | void DrawText(const wxString& text, const wxPoint& pt) |
| 279 | { DoDrawText(text, pt.x, pt.y); } |
| 280 | |
| 281 | void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle) |
| 282 | { DoDrawRotatedText(text, x, y, angle); } |
| 283 | void DrawRotatedText(const wxString& text, const wxPoint& pt, double angle) |
| 284 | { DoDrawRotatedText(text, pt.x, pt.y, angle); } |
| 285 | |
| 286 | // this version puts both optional bitmap and the text into the given |
| 287 | // rectangle and aligns is as specified by alignment parameter; it also |
| 288 | // will emphasize the character with the given index if it is != -1 and |
| 289 | // return the bounding rectangle if required |
| 290 | virtual void DrawLabel(const wxString& text, |
| 291 | const wxBitmap& image, |
| 292 | const wxRect& rect, |
| 293 | int alignment = wxALIGN_LEFT | wxALIGN_TOP, |
| 294 | int indexAccel = -1, |
| 295 | wxRect *rectBounding = NULL); |
| 296 | |
| 297 | void DrawLabel(const wxString& text, const wxRect& rect, |
| 298 | int alignment = wxALIGN_LEFT | wxALIGN_TOP, |
| 299 | int indexAccel = -1) |
| 300 | { DrawLabel(text, wxNullBitmap, rect, alignment, indexAccel); } |
| 301 | |
| 302 | bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height, |
| 303 | wxDC *source, wxCoord xsrc, wxCoord ysrc, |
| 304 | int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord) |
| 305 | { |
| 306 | return DoBlit(xdest, ydest, width, height, |
| 307 | source, xsrc, ysrc, rop, useMask, xsrcMask, ysrcMask); |
| 308 | } |
| 309 | bool Blit(const wxPoint& destPt, const wxSize& sz, |
| 310 | wxDC *source, const wxPoint& srcPt, |
| 311 | int rop = wxCOPY, bool useMask = false, const wxPoint& srcPtMask = wxDefaultPosition) |
| 312 | { |
| 313 | return DoBlit(destPt.x, destPt.y, sz.x, sz.y, |
| 314 | source, srcPt.x, srcPt.y, rop, useMask, srcPtMask.x, srcPtMask.y); |
| 315 | } |
| 316 | |
| 317 | wxBitmap GetAsBitmap(const wxRect *subrect = (const wxRect *) NULL) const |
| 318 | { |
| 319 | return DoGetAsBitmap(subrect); |
| 320 | } |
| 321 | |
| 322 | #if wxUSE_SPLINES |
| 323 | // TODO: this API needs fixing (wxPointList, why (!const) "wxList *"?) |
| 324 | void DrawSpline(wxCoord x1, wxCoord y1, |
| 325 | wxCoord x2, wxCoord y2, |
| 326 | wxCoord x3, wxCoord y3); |
| 327 | void DrawSpline(int n, wxPoint points[]); |
| 328 | |
| 329 | void DrawSpline(wxList *points) { DoDrawSpline(points); } |
| 330 | #endif // wxUSE_SPLINES |
| 331 | |
| 332 | // Eventually we will have wxUSE_GENERIC_DRAWELLIPSE |
| 333 | #ifdef __WXWINCE__ |
| 334 | //! Generic method to draw ellipses, circles and arcs with current pen and brush. |
| 335 | /*! \param x Upper left corner of bounding box. |
| 336 | * \param y Upper left corner of bounding box. |
| 337 | * \param w Width of bounding box. |
| 338 | * \param h Height of bounding box. |
| 339 | * \param sa Starting angle of arc |
| 340 | * (counterclockwise, start at 3 o'clock, 360 is full circle). |
| 341 | * \param ea Ending angle of arc. |
| 342 | * \param angle Rotation angle, the Arc will be rotated after |
| 343 | * calculating begin and end. |
| 344 | */ |
| 345 | void DrawEllipticArcRot( wxCoord x, wxCoord y, |
| 346 | wxCoord width, wxCoord height, |
| 347 | double sa = 0, double ea = 0, double angle = 0 ) |
| 348 | { DoDrawEllipticArcRot( x, y, width, height, sa, ea, angle ); } |
| 349 | |
| 350 | void DrawEllipticArcRot( const wxPoint& pt, |
| 351 | const wxSize& sz, |
| 352 | double sa = 0, double ea = 0, double angle = 0 ) |
| 353 | { DoDrawEllipticArcRot( pt.x, pt.y, sz.x, sz.y, sa, ea, angle ); } |
| 354 | |
| 355 | void DrawEllipticArcRot( const wxRect& rect, |
| 356 | double sa = 0, double ea = 0, double angle = 0 ) |
| 357 | { DoDrawEllipticArcRot( rect.x, rect.y, rect.width, rect.height, sa, ea, angle ); } |
| 358 | |
| 359 | virtual void DoDrawEllipticArcRot( wxCoord x, wxCoord y, |
| 360 | wxCoord w, wxCoord h, |
| 361 | double sa = 0, double ea = 0, double angle = 0 ); |
| 362 | |
| 363 | //! Rotates points around center. |
| 364 | /*! This is a quite straight method, it calculates in pixels |
| 365 | * and so it produces rounding errors. |
| 366 | * \param points The points inside will be rotated. |
| 367 | * \param angle Rotating angle (counterclockwise, start at 3 o'clock, 360 is full circle). |
| 368 | * \param center Center of rotation. |
| 369 | */ |
| 370 | void Rotate( wxList* points, double angle, wxPoint center = wxPoint(0,0) ); |
| 371 | |
| 372 | // used by DrawEllipticArcRot |
| 373 | // Careful: wxList gets filled with points you have to delete later. |
| 374 | void CalculateEllipticPoints( wxList* points, |
| 375 | wxCoord xStart, wxCoord yStart, |
| 376 | wxCoord w, wxCoord h, |
| 377 | double sa, double ea ); |
| 378 | #endif |
| 379 | |
| 380 | // global DC operations |
| 381 | // -------------------- |
| 382 | |
| 383 | virtual void Clear() = 0; |
| 384 | |
| 385 | virtual bool StartDoc(const wxString& WXUNUSED(message)) { return true; } |
| 386 | virtual void EndDoc() { } |
| 387 | |
| 388 | virtual void StartPage() { } |
| 389 | virtual void EndPage() { } |
| 390 | |
| 391 | #if WXWIN_COMPATIBILITY_2_6 |
| 392 | wxDEPRECATED( void BeginDrawing() ); |
| 393 | wxDEPRECATED( void EndDrawing() ); |
| 394 | #endif // WXWIN_COMPATIBILITY_2_6 |
| 395 | |
| 396 | |
| 397 | // set objects to use for drawing |
| 398 | // ------------------------------ |
| 399 | |
| 400 | virtual void SetFont(const wxFont& font) = 0; |
| 401 | virtual void SetPen(const wxPen& pen) = 0; |
| 402 | virtual void SetBrush(const wxBrush& brush) = 0; |
| 403 | virtual void SetBackground(const wxBrush& brush) = 0; |
| 404 | virtual void SetBackgroundMode(int mode) = 0; |
| 405 | #if wxUSE_PALETTE |
| 406 | virtual void SetPalette(const wxPalette& palette) = 0; |
| 407 | #endif // wxUSE_PALETTE |
| 408 | |
| 409 | // clipping region |
| 410 | // --------------- |
| 411 | |
| 412 | void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height) |
| 413 | { DoSetClippingRegion(x, y, width, height); } |
| 414 | void SetClippingRegion(const wxPoint& pt, const wxSize& sz) |
| 415 | { DoSetClippingRegion(pt.x, pt.y, sz.x, sz.y); } |
| 416 | void SetClippingRegion(const wxRect& rect) |
| 417 | { DoSetClippingRegion(rect.x, rect.y, rect.width, rect.height); } |
| 418 | void SetClippingRegion(const wxRegion& region) |
| 419 | { DoSetClippingRegionAsRegion(region); } |
| 420 | |
| 421 | virtual void DestroyClippingRegion() { ResetClipping(); } |
| 422 | |
| 423 | void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *w, wxCoord *h) const |
| 424 | { DoGetClippingBox(x, y, w, h); } |
| 425 | void GetClippingBox(wxRect& rect) const |
| 426 | { |
| 427 | DoGetClippingBox(&rect.x, &rect.y, &rect.width, &rect.height); |
| 428 | } |
| 429 | |
| 430 | // text extent |
| 431 | // ----------- |
| 432 | |
| 433 | virtual wxCoord GetCharHeight() const = 0; |
| 434 | virtual wxCoord GetCharWidth() const = 0; |
| 435 | |
| 436 | // only works for single line strings |
| 437 | void GetTextExtent(const wxString& string, |
| 438 | wxCoord *x, wxCoord *y, |
| 439 | wxCoord *descent = NULL, |
| 440 | wxCoord *externalLeading = NULL, |
| 441 | wxFont *theFont = NULL) const |
| 442 | { DoGetTextExtent(string, x, y, descent, externalLeading, theFont); } |
| 443 | |
| 444 | // works for single as well as multi-line strings |
| 445 | virtual void GetMultiLineTextExtent(const wxString& text, |
| 446 | wxCoord *width, |
| 447 | wxCoord *height, |
| 448 | wxCoord *heightLine = NULL, |
| 449 | wxFont *font = NULL); |
| 450 | |
| 451 | // Measure cumulative width of text after each character |
| 452 | bool GetPartialTextExtents(const wxString& text, wxArrayInt& widths) const |
| 453 | { return DoGetPartialTextExtents(text, widths); } |
| 454 | |
| 455 | |
| 456 | // size and resolution |
| 457 | // ------------------- |
| 458 | |
| 459 | // in device units |
| 460 | void GetSize(int *width, int *height) const |
| 461 | { DoGetSize(width, height); } |
| 462 | wxSize GetSize() const |
| 463 | { |
| 464 | int w, h; |
| 465 | DoGetSize(&w, &h); |
| 466 | |
| 467 | return wxSize(w, h); |
| 468 | } |
| 469 | |
| 470 | // in mm |
| 471 | void GetSizeMM(int* width, int* height) const |
| 472 | { DoGetSizeMM(width, height); } |
| 473 | wxSize GetSizeMM() const |
| 474 | { |
| 475 | int w, h; |
| 476 | DoGetSizeMM(&w, &h); |
| 477 | |
| 478 | return wxSize(w, h); |
| 479 | } |
| 480 | |
| 481 | // coordinates conversions |
| 482 | // ----------------------- |
| 483 | |
| 484 | // This group of functions does actual conversion of the input, as you'd |
| 485 | // expect. |
| 486 | wxCoord DeviceToLogicalX(wxCoord x) const; |
| 487 | wxCoord DeviceToLogicalY(wxCoord y) const; |
| 488 | wxCoord DeviceToLogicalXRel(wxCoord x) const; |
| 489 | wxCoord DeviceToLogicalYRel(wxCoord y) const; |
| 490 | wxCoord LogicalToDeviceX(wxCoord x) const; |
| 491 | wxCoord LogicalToDeviceY(wxCoord y) const; |
| 492 | wxCoord LogicalToDeviceXRel(wxCoord x) const; |
| 493 | wxCoord LogicalToDeviceYRel(wxCoord y) const; |
| 494 | |
| 495 | // query DC capabilities |
| 496 | // --------------------- |
| 497 | |
| 498 | virtual bool CanDrawBitmap() const = 0; |
| 499 | virtual bool CanGetTextExtent() const = 0; |
| 500 | |
| 501 | // colour depth |
| 502 | virtual int GetDepth() const = 0; |
| 503 | |
| 504 | // Resolution in Pixels per inch |
| 505 | virtual wxSize GetPPI() const = 0; |
| 506 | |
| 507 | virtual bool Ok() const { return IsOk(); } |
| 508 | virtual bool IsOk() const { return m_ok; } |
| 509 | |
| 510 | // accessors and setters |
| 511 | // --------------------- |
| 512 | |
| 513 | virtual int GetBackgroundMode() const { return m_backgroundMode; } |
| 514 | virtual const wxBrush& GetBackground() const { return m_backgroundBrush; } |
| 515 | virtual const wxBrush& GetBrush() const { return m_brush; } |
| 516 | virtual const wxFont& GetFont() const { return m_font; } |
| 517 | virtual const wxPen& GetPen() const { return m_pen; } |
| 518 | |
| 519 | virtual const wxColour& GetTextForeground() const { return m_textForegroundColour; } |
| 520 | virtual const wxColour& GetTextBackground() const { return m_textBackgroundColour; } |
| 521 | virtual void SetTextForeground(const wxColour& colour) |
| 522 | { m_textForegroundColour = colour; } |
| 523 | virtual void SetTextBackground(const wxColour& colour) |
| 524 | { m_textBackgroundColour = colour; } |
| 525 | |
| 526 | virtual int GetMapMode() const { return m_mappingMode; } |
| 527 | virtual void SetMapMode(int mode) = 0; |
| 528 | |
| 529 | virtual void GetUserScale(double *x, double *y) const |
| 530 | { |
| 531 | if ( x ) *x = m_userScaleX; |
| 532 | if ( y ) *y = m_userScaleY; |
| 533 | } |
| 534 | virtual void SetUserScale(double x, double y) = 0; |
| 535 | |
| 536 | virtual void GetLogicalScale(double *x, double *y) |
| 537 | { |
| 538 | if ( x ) *x = m_logicalScaleX; |
| 539 | if ( y ) *y = m_logicalScaleY; |
| 540 | } |
| 541 | virtual void SetLogicalScale(double x, double y) |
| 542 | { |
| 543 | m_logicalScaleX = x; |
| 544 | m_logicalScaleY = y; |
| 545 | } |
| 546 | |
| 547 | void GetLogicalOrigin(wxCoord *x, wxCoord *y) const |
| 548 | { DoGetLogicalOrigin(x, y); } |
| 549 | wxPoint GetLogicalOrigin() const |
| 550 | { wxCoord x, y; DoGetLogicalOrigin(&x, &y); return wxPoint(x, y); } |
| 551 | virtual void SetLogicalOrigin(wxCoord x, wxCoord y) = 0; |
| 552 | |
| 553 | void GetDeviceOrigin(wxCoord *x, wxCoord *y) const |
| 554 | { DoGetDeviceOrigin(x, y); } |
| 555 | wxPoint GetDeviceOrigin() const |
| 556 | { wxCoord x, y; DoGetDeviceOrigin(&x, &y); return wxPoint(x, y); } |
| 557 | virtual void SetDeviceOrigin(wxCoord x, wxCoord y) = 0; |
| 558 | |
| 559 | virtual void ComputeScaleAndOrigin() {} |
| 560 | |
| 561 | virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp) = 0; |
| 562 | |
| 563 | virtual int GetLogicalFunction() const { return m_logicalFunction; } |
| 564 | virtual void SetLogicalFunction(int function) = 0; |
| 565 | |
| 566 | #if WXWIN_COMPATIBILITY_2_4 |
| 567 | virtual void SetOptimization(bool WXUNUSED(opt)) { } |
| 568 | virtual bool GetOptimization() { return false; } |
| 569 | #endif |
| 570 | |
| 571 | // bounding box |
| 572 | // ------------ |
| 573 | |
| 574 | virtual void CalcBoundingBox(wxCoord x, wxCoord y) |
| 575 | { |
| 576 | if ( m_isBBoxValid ) |
| 577 | { |
| 578 | if ( x < m_minX ) m_minX = x; |
| 579 | if ( y < m_minY ) m_minY = y; |
| 580 | if ( x > m_maxX ) m_maxX = x; |
| 581 | if ( y > m_maxY ) m_maxY = y; |
| 582 | } |
| 583 | else |
| 584 | { |
| 585 | m_isBBoxValid = true; |
| 586 | |
| 587 | m_minX = x; |
| 588 | m_minY = y; |
| 589 | m_maxX = x; |
| 590 | m_maxY = y; |
| 591 | } |
| 592 | } |
| 593 | |
| 594 | void ResetBoundingBox() |
| 595 | { |
| 596 | m_isBBoxValid = false; |
| 597 | |
| 598 | m_minX = m_maxX = m_minY = m_maxY = 0; |
| 599 | } |
| 600 | |
| 601 | // Get the final bounding box of the PostScript or Metafile picture. |
| 602 | wxCoord MinX() const { return m_minX; } |
| 603 | wxCoord MaxX() const { return m_maxX; } |
| 604 | wxCoord MinY() const { return m_minY; } |
| 605 | wxCoord MaxY() const { return m_maxY; } |
| 606 | |
| 607 | // misc old functions |
| 608 | // ------------------ |
| 609 | |
| 610 | // for compatibility with the old code when wxCoord was long everywhere |
| 611 | void GetTextExtent(const wxString& string, |
| 612 | long *x, long *y, |
| 613 | long *descent = NULL, |
| 614 | long *externalLeading = NULL, |
| 615 | wxFont *theFont = NULL) const |
| 616 | { |
| 617 | wxCoord x2, y2, descent2, externalLeading2; |
| 618 | DoGetTextExtent(string, &x2, &y2, |
| 619 | &descent2, &externalLeading2, |
| 620 | theFont); |
| 621 | if ( x ) |
| 622 | *x = x2; |
| 623 | if ( y ) |
| 624 | *y = y2; |
| 625 | if ( descent ) |
| 626 | *descent = descent2; |
| 627 | if ( externalLeading ) |
| 628 | *externalLeading = externalLeading2; |
| 629 | } |
| 630 | |
| 631 | void GetLogicalOrigin(long *x, long *y) const |
| 632 | { |
| 633 | wxCoord x2, y2; |
| 634 | DoGetLogicalOrigin(&x2, &y2); |
| 635 | if ( x ) |
| 636 | *x = x2; |
| 637 | if ( y ) |
| 638 | *y = y2; |
| 639 | } |
| 640 | |
| 641 | void GetDeviceOrigin(long *x, long *y) const |
| 642 | { |
| 643 | wxCoord x2, y2; |
| 644 | DoGetDeviceOrigin(&x2, &y2); |
| 645 | if ( x ) |
| 646 | *x = x2; |
| 647 | if ( y ) |
| 648 | *y = y2; |
| 649 | } |
| 650 | void GetClippingBox(long *x, long *y, long *w, long *h) const |
| 651 | { |
| 652 | wxCoord xx,yy,ww,hh; |
| 653 | DoGetClippingBox(&xx, &yy, &ww, &hh); |
| 654 | if (x) *x = xx; |
| 655 | if (y) *y = yy; |
| 656 | if (w) *w = ww; |
| 657 | if (h) *h = hh; |
| 658 | } |
| 659 | |
| 660 | // RTL related functions |
| 661 | // --------------------- |
| 662 | |
| 663 | // get or change the layout direction (LTR or RTL) for this dc, |
| 664 | // wxLayout_Default is returned if layout direction is not supported |
| 665 | virtual wxLayoutDirection GetLayoutDirection() const |
| 666 | { return wxLayout_Default; } |
| 667 | virtual void SetLayoutDirection(wxLayoutDirection WXUNUSED(dir)) |
| 668 | { } |
| 669 | |
| 670 | protected: |
| 671 | // the pure virtual functions which should be implemented by wxDC |
| 672 | virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col, |
| 673 | int style = wxFLOOD_SURFACE) = 0; |
| 674 | |
| 675 | virtual void DoGradientFillLinear(const wxRect& rect, |
| 676 | const wxColour& initialColour, |
| 677 | const wxColour& destColour, |
| 678 | wxDirection nDirection = wxEAST); |
| 679 | |
| 680 | virtual void DoGradientFillConcentric(const wxRect& rect, |
| 681 | const wxColour& initialColour, |
| 682 | const wxColour& destColour, |
| 683 | const wxPoint& circleCenter); |
| 684 | |
| 685 | virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0; |
| 686 | |
| 687 | virtual void DoDrawPoint(wxCoord x, wxCoord y) = 0; |
| 688 | virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2) = 0; |
| 689 | |
| 690 | virtual void DoDrawArc(wxCoord x1, wxCoord y1, |
| 691 | wxCoord x2, wxCoord y2, |
| 692 | wxCoord xc, wxCoord yc) = 0; |
| 693 | virtual void DoDrawCheckMark(wxCoord x, wxCoord y, |
| 694 | wxCoord width, wxCoord height); |
| 695 | virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h, |
| 696 | double sa, double ea) = 0; |
| 697 | |
| 698 | virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height) = 0; |
| 699 | virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y, |
| 700 | wxCoord width, wxCoord height, |
| 701 | double radius) = 0; |
| 702 | virtual void DoDrawEllipse(wxCoord x, wxCoord y, |
| 703 | wxCoord width, wxCoord height) = 0; |
| 704 | |
| 705 | virtual void DoCrossHair(wxCoord x, wxCoord y) = 0; |
| 706 | |
| 707 | virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y) = 0; |
| 708 | virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y, |
| 709 | bool useMask = false) = 0; |
| 710 | |
| 711 | virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y) = 0; |
| 712 | virtual void DoDrawRotatedText(const wxString& text, |
| 713 | wxCoord x, wxCoord y, double angle) = 0; |
| 714 | |
| 715 | virtual bool DoBlit(wxCoord xdest, wxCoord ydest, |
| 716 | wxCoord width, wxCoord height, |
| 717 | wxDC *source, wxCoord xsrc, wxCoord ysrc, |
| 718 | int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord) = 0; |
| 719 | |
| 720 | virtual wxBitmap DoGetAsBitmap(const wxRect *WXUNUSED(subrect)) const { return wxNullBitmap; } |
| 721 | |
| 722 | virtual void DoGetSize(int *width, int *height) const = 0; |
| 723 | virtual void DoGetSizeMM(int* width, int* height) const = 0; |
| 724 | |
| 725 | virtual void DoDrawLines(int n, wxPoint points[], |
| 726 | wxCoord xoffset, wxCoord yoffset) = 0; |
| 727 | virtual void DoDrawPolygon(int n, wxPoint points[], |
| 728 | wxCoord xoffset, wxCoord yoffset, |
| 729 | int fillStyle = wxODDEVEN_RULE) = 0; |
| 730 | virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[], |
| 731 | wxCoord xoffset, wxCoord yoffset, |
| 732 | int fillStyle); |
| 733 | |
| 734 | virtual void DoSetClippingRegionAsRegion(const wxRegion& region) = 0; |
| 735 | virtual void DoSetClippingRegion(wxCoord x, wxCoord y, |
| 736 | wxCoord width, wxCoord height) = 0; |
| 737 | |
| 738 | #if WXWIN_COMPATIBILITY_2_4 |
| 739 | // this was only for confusing people, use DoGetClippingBox only |
| 740 | virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y, |
| 741 | wxCoord *w, wxCoord *h) |
| 742 | { DoGetClippingBox(x, y, w, h); } |
| 743 | #endif |
| 744 | |
| 745 | virtual void DoGetClippingBox(wxCoord *x, wxCoord *y, |
| 746 | wxCoord *w, wxCoord *h) const |
| 747 | { |
| 748 | if ( x ) |
| 749 | *x = m_clipX1; |
| 750 | if ( y ) |
| 751 | *y = m_clipY1; |
| 752 | if ( w ) |
| 753 | *w = m_clipX2 - m_clipX1; |
| 754 | if ( h ) |
| 755 | *h = m_clipY2 - m_clipY1; |
| 756 | } |
| 757 | |
| 758 | virtual void DoGetLogicalOrigin(wxCoord *x, wxCoord *y) const |
| 759 | { |
| 760 | if ( x ) *x = m_logicalOriginX; |
| 761 | if ( y ) *y = m_logicalOriginY; |
| 762 | } |
| 763 | |
| 764 | virtual void DoGetDeviceOrigin(wxCoord *x, wxCoord *y) const |
| 765 | { |
| 766 | if ( x ) *x = m_deviceOriginX; |
| 767 | if ( y ) *y = m_deviceOriginY; |
| 768 | } |
| 769 | |
| 770 | virtual void DoGetTextExtent(const wxString& string, |
| 771 | wxCoord *x, wxCoord *y, |
| 772 | wxCoord *descent = NULL, |
| 773 | wxCoord *externalLeading = NULL, |
| 774 | wxFont *theFont = NULL) const = 0; |
| 775 | |
| 776 | virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const; |
| 777 | |
| 778 | #if wxUSE_SPLINES |
| 779 | virtual void DoDrawSpline(wxList *points); |
| 780 | #endif |
| 781 | |
| 782 | protected: |
| 783 | // unset clipping variables (after clipping region was destroyed) |
| 784 | void ResetClipping() |
| 785 | { |
| 786 | m_clipping = false; |
| 787 | |
| 788 | m_clipX1 = m_clipX2 = m_clipY1 = m_clipY2 = 0; |
| 789 | } |
| 790 | |
| 791 | // flags |
| 792 | bool m_colour:1; |
| 793 | bool m_ok:1; |
| 794 | bool m_clipping:1; |
| 795 | bool m_isInteractive:1; |
| 796 | bool m_isBBoxValid:1; |
| 797 | |
| 798 | // coordinate system variables |
| 799 | |
| 800 | // TODO short descriptions of what exactly they are would be nice... |
| 801 | |
| 802 | wxCoord m_logicalOriginX, m_logicalOriginY; |
| 803 | wxCoord m_deviceOriginX, m_deviceOriginY; |
| 804 | |
| 805 | double m_logicalScaleX, m_logicalScaleY; |
| 806 | double m_userScaleX, m_userScaleY; |
| 807 | double m_scaleX, m_scaleY; |
| 808 | |
| 809 | // Used by SetAxisOrientation() to invert the axes |
| 810 | int m_signX, m_signY; |
| 811 | |
| 812 | // bounding and clipping boxes |
| 813 | wxCoord m_minX, m_minY, m_maxX, m_maxY; |
| 814 | wxCoord m_clipX1, m_clipY1, m_clipX2, m_clipY2; |
| 815 | |
| 816 | int m_logicalFunction; |
| 817 | int m_backgroundMode; |
| 818 | int m_mappingMode; |
| 819 | |
| 820 | // GDI objects |
| 821 | wxPen m_pen; |
| 822 | wxBrush m_brush; |
| 823 | wxBrush m_backgroundBrush; |
| 824 | wxColour m_textForegroundColour; |
| 825 | wxColour m_textBackgroundColour; |
| 826 | wxFont m_font; |
| 827 | |
| 828 | #if wxUSE_PALETTE |
| 829 | wxPalette m_palette; |
| 830 | bool m_hasCustomPalette; |
| 831 | #endif // wxUSE_PALETTE |
| 832 | |
| 833 | private: |
| 834 | DECLARE_NO_COPY_CLASS(wxDCBase) |
| 835 | DECLARE_ABSTRACT_CLASS(wxDCBase) |
| 836 | }; |
| 837 | |
| 838 | // ---------------------------------------------------------------------------- |
| 839 | // now include the declaration of wxDC class |
| 840 | // ---------------------------------------------------------------------------- |
| 841 | |
| 842 | #if defined(__WXPALMOS__) |
| 843 | #include "wx/palmos/dc.h" |
| 844 | #elif defined(__WXMSW__) |
| 845 | #include "wx/msw/dc.h" |
| 846 | #elif defined(__WXMOTIF__) |
| 847 | #include "wx/motif/dc.h" |
| 848 | #elif defined(__WXGTK20__) |
| 849 | #include "wx/gtk/dc.h" |
| 850 | #elif defined(__WXGTK__) |
| 851 | #include "wx/gtk1/dc.h" |
| 852 | #elif defined(__WXX11__) |
| 853 | #include "wx/x11/dc.h" |
| 854 | #elif defined(__WXMGL__) |
| 855 | #include "wx/mgl/dc.h" |
| 856 | #elif defined(__WXDFB__) |
| 857 | #include "wx/dfb/dc.h" |
| 858 | #elif defined(__WXMAC__) |
| 859 | #include "wx/mac/dc.h" |
| 860 | #elif defined(__WXCOCOA__) |
| 861 | #include "wx/cocoa/dc.h" |
| 862 | #elif defined(__WXPM__) |
| 863 | #include "wx/os2/dc.h" |
| 864 | #endif |
| 865 | |
| 866 | #if wxUSE_GRAPHICS_CONTEXT |
| 867 | #include "wx/dcgraph.h" |
| 868 | #endif |
| 869 | |
| 870 | // ---------------------------------------------------------------------------- |
| 871 | // helper class: you can use it to temporarily change the DC text colour and |
| 872 | // restore it automatically when the object goes out of scope |
| 873 | // ---------------------------------------------------------------------------- |
| 874 | |
| 875 | class WXDLLEXPORT wxDCTextColourChanger |
| 876 | { |
| 877 | public: |
| 878 | wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { } |
| 879 | |
| 880 | wxDCTextColourChanger(wxDC& dc, const wxColour& col) : m_dc(dc) |
| 881 | { |
| 882 | Set(col); |
| 883 | } |
| 884 | |
| 885 | ~wxDCTextColourChanger() |
| 886 | { |
| 887 | if ( m_colFgOld.Ok() ) |
| 888 | m_dc.SetTextForeground(m_colFgOld); |
| 889 | } |
| 890 | |
| 891 | void Set(const wxColour& col) |
| 892 | { |
| 893 | if ( !m_colFgOld.Ok() ) |
| 894 | m_colFgOld = m_dc.GetTextForeground(); |
| 895 | m_dc.SetTextForeground(col); |
| 896 | } |
| 897 | |
| 898 | private: |
| 899 | wxDC& m_dc; |
| 900 | |
| 901 | wxColour m_colFgOld; |
| 902 | |
| 903 | DECLARE_NO_COPY_CLASS(wxDCTextColourChanger) |
| 904 | }; |
| 905 | |
| 906 | // ---------------------------------------------------------------------------- |
| 907 | // helper class: you can use it to temporarily change the DC pen and |
| 908 | // restore it automatically when the object goes out of scope |
| 909 | // ---------------------------------------------------------------------------- |
| 910 | |
| 911 | class WXDLLEXPORT wxDCPenChanger |
| 912 | { |
| 913 | public: |
| 914 | wxDCPenChanger(wxDC& dc, const wxPen& pen) : m_dc(dc), m_penOld(dc.GetPen()) |
| 915 | { |
| 916 | m_dc.SetPen(pen); |
| 917 | } |
| 918 | |
| 919 | ~wxDCPenChanger() |
| 920 | { |
| 921 | if ( m_penOld.Ok() ) |
| 922 | m_dc.SetPen(m_penOld); |
| 923 | } |
| 924 | |
| 925 | private: |
| 926 | wxDC& m_dc; |
| 927 | |
| 928 | wxPen m_penOld; |
| 929 | |
| 930 | DECLARE_NO_COPY_CLASS(wxDCPenChanger) |
| 931 | }; |
| 932 | |
| 933 | // ---------------------------------------------------------------------------- |
| 934 | // helper class: you can use it to temporarily change the DC brush and |
| 935 | // restore it automatically when the object goes out of scope |
| 936 | // ---------------------------------------------------------------------------- |
| 937 | |
| 938 | class WXDLLEXPORT wxDCBrushChanger |
| 939 | { |
| 940 | public: |
| 941 | wxDCBrushChanger(wxDC& dc, const wxBrush& brush) : m_dc(dc), m_brushOld(dc.GetBrush()) |
| 942 | { |
| 943 | m_dc.SetBrush(brush); |
| 944 | } |
| 945 | |
| 946 | ~wxDCBrushChanger() |
| 947 | { |
| 948 | if ( m_brushOld.Ok() ) |
| 949 | m_dc.SetBrush(m_brushOld); |
| 950 | } |
| 951 | |
| 952 | private: |
| 953 | wxDC& m_dc; |
| 954 | |
| 955 | wxBrush m_brushOld; |
| 956 | |
| 957 | DECLARE_NO_COPY_CLASS(wxDCBrushChanger) |
| 958 | }; |
| 959 | |
| 960 | // ---------------------------------------------------------------------------- |
| 961 | // another small helper class: sets the clipping region in its ctor and |
| 962 | // destroys it in the dtor |
| 963 | // ---------------------------------------------------------------------------- |
| 964 | |
| 965 | class WXDLLEXPORT wxDCClipper |
| 966 | { |
| 967 | public: |
| 968 | wxDCClipper(wxDC& dc, const wxRegion& r) : m_dc(dc) |
| 969 | { dc.SetClippingRegion(r); } |
| 970 | wxDCClipper(wxDC& dc, const wxRect& r) : m_dc(dc) |
| 971 | { dc.SetClippingRegion(r.x, r.y, r.width, r.height); } |
| 972 | wxDCClipper(wxDC& dc, wxCoord x, wxCoord y, wxCoord w, wxCoord h) : m_dc(dc) |
| 973 | { dc.SetClippingRegion(x, y, w, h); } |
| 974 | |
| 975 | ~wxDCClipper() { m_dc.DestroyClippingRegion(); } |
| 976 | |
| 977 | private: |
| 978 | wxDC& m_dc; |
| 979 | |
| 980 | DECLARE_NO_COPY_CLASS(wxDCClipper) |
| 981 | }; |
| 982 | |
| 983 | #endif // _WX_DC_H_BASE_ |