FXDC.h

/********************************************************************************
*                                                                               *
*               D e v i c e   C o n t e x t   B a s e   C l a s s               *
*                                                                               *
*********************************************************************************
* Copyright (C) 1999,2024 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library is free software; you can redistribute it and/or modify          *
* it under the terms of the GNU Lesser General Public License as published by   *
* the Free Software Foundation; either version 3 of the License, or             *
* (at your option) any later version.                                           *
*                                                                               *
* This library is distributed in the hope that it will be useful,               *
* but WITHOUT ANY WARRANTY; without even the implied warranty of                *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                 *
* GNU Lesser General Public License for more details.                           *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public License      *
* along with this program.  If not, see <http://www.gnu.org/licenses/>          *
********************************************************************************/
#ifndef FXDC_H
#define FXDC_H


namespace FX {


enum FXFunction {
  BLT_CLR,                        
  BLT_SRC_AND_DST,                
  BLT_SRC_AND_NOT_DST,            
  BLT_SRC,                        
  BLT_NOT_SRC_AND_DST,            
  BLT_DST,                        
  BLT_SRC_XOR_DST,                
  BLT_SRC_OR_DST,                 
  BLT_NOT_SRC_AND_NOT_DST,        
  BLT_NOT_SRC_XOR_DST,            
  BLT_NOT_DST,                    
  BLT_SRC_OR_NOT_DST,             
  BLT_NOT_SRC,                    
  BLT_NOT_SRC_OR_DST,             
  BLT_NOT_SRC_OR_NOT_DST,         
  BLT_SET                         
  };


enum FXLineStyle {
  LINE_SOLID,                     
  LINE_ONOFF_DASH,                
  LINE_DOUBLE_DASH                
  };


enum FXCapStyle {
  CAP_NOT_LAST,                   
  CAP_BUTT,                       
  CAP_ROUND,                      
  CAP_PROJECTING                  
  };


enum FXJoinStyle {
  JOIN_MITER,                     
  JOIN_ROUND,                     
  JOIN_BEVEL                      
  };


enum FXFillStyle {
  FILL_SOLID,                     
  FILL_TILED,                     
  FILL_STIPPLED,                  
  FILL_OPAQUESTIPPLED             
  };


enum FXFillRule {
  RULE_EVEN_ODD,                  
  RULE_WINDING                    
  };


enum FXStipplePattern {
  STIPPLE_0         = 0,
  STIPPLE_NONE      = 0,
  STIPPLE_BLACK     = 0,            
  STIPPLE_1         = 1,
  STIPPLE_2         = 2,
  STIPPLE_3         = 3,
  STIPPLE_4         = 4,
  STIPPLE_5         = 5,
  STIPPLE_6         = 6,
  STIPPLE_7         = 7,
  STIPPLE_8         = 8,
  STIPPLE_GRAY      = 8,            
  STIPPLE_9         = 9,
  STIPPLE_10        = 10,
  STIPPLE_11        = 11,
  STIPPLE_12        = 12,
  STIPPLE_13        = 13,
  STIPPLE_14        = 14,
  STIPPLE_15        = 15,
  STIPPLE_16        = 16,
  STIPPLE_WHITE     = 16,           
  STIPPLE_HORZ      = 17,           
  STIPPLE_VERT      = 18,           
  STIPPLE_CROSS     = 19,           
  STIPPLE_DIAG      = 20,           
  STIPPLE_REVDIAG   = 21,           
  STIPPLE_CROSSDIAG = 22            
  };


struct FXSegment {
  FXshort x1,y1,x2,y2;
  };


struct FXArc {
  FXshort x,y,w,h,a,b;
  };


class FXApp;
class FXImage;
class FXBitmap;
class FXIcon;
class FXFont;
class FXDrawable;
class FXRegion;


class FXAPI FXDC {
  friend class FXFont;
private:
  FXApp           *app;         // Application
protected:
  void            *ctx;         // Context handle
  FXFont          *font;        // Drawing font
  FXStipplePattern pattern;     // Stipple pattern
  FXBitmap        *stipple;     // Stipple bitmap
  FXImage         *tile;        // Tile image
  FXBitmap        *mask;        // Mask bitmap
  FXRectangle      clip;        // Clip rectangle
  FXColor          fg;          // Foreground color
  FXColor          bg;          // Background color
  FXuint           width;       // Line width
  FXCapStyle       cap;         // Line cap style
  FXJoinStyle      join;        // Line join style
  FXLineStyle      style;       // Line style
  FXFillStyle      fill;        // Fill style
  FXFillRule       rule;        // Fill rule
  FXFunction       rop;         // RasterOp
  FXuchar          dashpat[32]; // Line dash pattern data
  FXuint           dashlen;     // Line dash pattern length
  FXuint           dashoff;     // Line dash pattern offset
  FXint            tx;          // Tile dx
  FXint            ty;          // Tile dy
  FXint            cx;          // Clip x
  FXint            cy;          // Clip y
private:
  FXDC();
  FXDC(const FXDC&);
  FXDC &operator=(const FXDC&);
public:

  FXDC(FXApp* a);

  FXApp* getApp() const { return app; }

  void* context() const { return ctx; }

  virtual FXColor readPixel(FXint x,FXint y);

  virtual void drawPoint(FXint x,FXint y);
  virtual void drawPoints(const FXPoint* points,FXuint npoints);
  virtual void drawPointsRel(const FXPoint* points,FXuint npoints);

  virtual void drawLine(FXint x1,FXint y1,FXint x2,FXint y2);
  virtual void drawLines(const FXPoint* points,FXuint npoints);
  virtual void drawLinesRel(const FXPoint* points,FXuint npoints);
  virtual void drawLineSegments(const FXSegment* segments,FXuint nsegments);

  virtual void drawRectangle(FXint x,FXint y,FXint w,FXint h);
  virtual void drawRectangles(const FXRectangle* rectangles,FXuint nrectangles);

  virtual void drawRoundRectangle(FXint x,FXint y,FXint w,FXint h,FXint ew,FXint eh);

  virtual void drawArc(FXint x,FXint y,FXint w,FXint h,FXint ang1,FXint ang2);
  virtual void drawArcs(const FXArc* arcs,FXuint narcs);

  virtual void drawEllipse(FXint x,FXint y,FXint w,FXint h);

  virtual void fillRectangle(FXint x,FXint y,FXint w,FXint h);
  virtual void fillRectangles(const FXRectangle* rectangles,FXuint nrectangles);

  virtual void fillRoundRectangle(FXint x,FXint y,FXint w,FXint h,FXint ew,FXint eh);

  virtual void fillChord(FXint x,FXint y,FXint w,FXint h,FXint ang1,FXint ang2);
  virtual void fillChords(const FXArc* chords,FXuint nchords);

  virtual void fillArc(FXint x,FXint y,FXint w,FXint h,FXint ang1,FXint ang2);
  virtual void fillArcs(const FXArc* arcs,FXuint narcs);

  virtual void fillEllipse(FXint x,FXint y,FXint w,FXint h);

  virtual void fillPolygon(const FXPoint* points,FXuint npoints);
  virtual void fillConcavePolygon(const FXPoint* points,FXuint npoints);
  virtual void fillComplexPolygon(const FXPoint* points,FXuint npoints);

  virtual void fillPolygonRel(const FXPoint* points,FXuint npoints);
  virtual void fillConcavePolygonRel(const FXPoint* points,FXuint npoints);
  virtual void fillComplexPolygonRel(const FXPoint* points,FXuint npoints);

  virtual void fillVerticalGradient(FXint x,FXint y,FXint w,FXint h,FXColor top,FXColor bottom);

  virtual void fillHorizontalGradient(FXint x,FXint y,FXint w,FXint h,FXColor left,FXColor right);

  virtual void drawHashBox(FXint x,FXint y,FXint w,FXint h,FXint b=1);

  virtual void drawFocusRectangle(FXint x,FXint y,FXint w,FXint h);

  virtual void drawArea(const FXDrawable* source,FXint sx,FXint sy,FXint sw,FXint sh,FXint dx,FXint dy);

  virtual void drawArea(const FXDrawable* source,FXint sx,FXint sy,FXint sw,FXint sh,FXint dx,FXint dy,FXint dw,FXint dh);

  virtual void drawImage(const FXImage* image,FXint dx,FXint dy);

  virtual void drawBitmap(const FXBitmap* bitmap,FXint dx,FXint dy);

  virtual void drawIcon(const FXIcon* icon,FXint dx,FXint dy);
  virtual void drawIconShaded(const FXIcon* icon,FXint dx,FXint dy);
  virtual void drawIconSunken(const FXIcon* icon,FXint dx,FXint dy);

  virtual void drawText(FXint x,FXint y,const FXString& string);
  virtual void drawText(FXint x,FXint y,const FXchar* string,FXuint length);

  virtual void drawImageText(FXint x,FXint y,const FXString& string);
  virtual void drawImageText(FXint x,FXint y,const FXchar* string,FXuint length);

  virtual void setForeground(FXColor clr);

  FXColor getForeground() const { return fg; }

  virtual void setBackground(FXColor clr);

  FXColor getBackground() const { return bg; }

  virtual void setDashes(FXuint dashoffset,const FXuchar *dashpattern,FXuint dashlength);

  const FXuchar* getDashPattern() const { return dashpat; }

  FXuint getDashOffset() const { return dashoff; }

  FXuint getDashLength() const { return dashlen; }

  virtual void setLineWidth(FXuint linewidth=0);

  FXuint getLineWidth() const { return width; }

  virtual void setLineCap(FXCapStyle capstyle=CAP_BUTT);

  FXCapStyle getLineCap() const { return cap; }

  virtual void setLineJoin(FXJoinStyle joinstyle=JOIN_MITER);

  FXJoinStyle getLineJoin() const { return join; }

  virtual void setLineStyle(FXLineStyle linestyle=LINE_SOLID);

  FXLineStyle getLineStyle() const { return style; }

  virtual void setFillStyle(FXFillStyle fillstyle=FILL_SOLID);

  FXFillStyle getFillStyle() const { return fill; }

  virtual void setFillRule(FXFillRule fillrule=RULE_EVEN_ODD);

  FXFillRule getFillRule() const { return rule; }

  virtual void setFunction(FXFunction func=BLT_SRC);

  FXFunction getFunction() const { return rop; }

  virtual void setTile(FXImage* image,FXint dx=0,FXint dy=0);

  FXImage *getTile() const { return tile; }

  virtual void setStipple(FXBitmap *bitmap,FXint dx=0,FXint dy=0);

  FXBitmap *getStippleBitmap() const { return stipple; }

  virtual void setStipple(FXStipplePattern pat,FXint dx=0,FXint dy=0);

  FXStipplePattern getStipplePattern() const { return pattern; }

  virtual void setClipRegion(const FXRegion& region);

  virtual void setClipRectangle(FXint x,FXint y,FXint w,FXint h);

  virtual void setClipRectangle(const FXRectangle& rectangle);

  const FXRectangle& getClipRectangle() const { return clip; }

  FXint getClipX() const { return clip.x; }

  FXint getClipY() const { return clip.y; }

  FXint getClipWidth() const { return clip.w; }

  FXint getClipHeight() const { return clip.h; }

  virtual void clearClipRectangle();

  virtual void setClipMask(FXBitmap* bitmap,FXint dx=0,FXint dy=0);

  virtual void clearClipMask();

  virtual void setFont(FXFont *fnt);

  FXFont* getFont() const { return font; }

  virtual void clipChildren(FXbool yes);

  virtual ~FXDC();
  };

}

#endif