Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FXDC.h

00001 /********************************************************************************
00002 *                                                                               *
00003 *               D e v i c e   C o n t e x t   B a s e   C l a s s               *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 1999,2002 by Jeroen van der Zijp.   All Rights Reserved.        *
00007 *********************************************************************************
00008 * This library is free software; you can redistribute it and/or                 *
00009 * modify it under the terms of the GNU Lesser General Public                    *
00010 * License as published by the Free Software Foundation; either                  *
00011 * version 2.1 of the License, or (at your option) any later version.            *
00012 *                                                                               *
00013 * This library is distributed in the hope that it will be useful,               *
00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of                *
00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU             *
00016 * Lesser General Public License for more details.                               *
00017 *                                                                               *
00018 * You should have received a copy of the GNU Lesser General Public              *
00019 * License along with this library; if not, write to the Free Software           *
00020 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
00021 *********************************************************************************
00022 * $Id: FXDC.h,v 1.22 2002/01/18 22:42:51 jeroen Exp $                           *
00023 ********************************************************************************/
00024 #ifndef FXDC_H
00025 #define FXDC_H
00026 
00027 
00028 /// Drawing (BITBLT) functions
00029 enum FXFunction {
00030   BLT_CLR,                        /// D := 0
00031   BLT_SRC_AND_DST,                /// D := S & D
00032   BLT_SRC_AND_NOT_DST,            /// D := S & ~D
00033   BLT_SRC,                        /// D := S
00034   BLT_NOT_SRC_AND_DST,            /// D := ~S & D
00035   BLT_DST,                        /// D := D
00036   BLT_SRC_XOR_DST,                /// D := S ^ D
00037   BLT_SRC_OR_DST,                 /// D := S | D
00038   BLT_NOT_SRC_AND_NOT_DST,        /// D := ~S & ~D  ==  D := ~(S | D)
00039   BLT_NOT_SRC_XOR_DST,            /// D := ~S ^ D
00040   BLT_NOT_DST,                    /// D := ~D
00041   BLT_SRC_OR_NOT_DST,             /// D := S | ~D
00042   BLT_NOT_SRC,                    /// D := ~S
00043   BLT_NOT_SRC_OR_DST,             /// D := ~S | D
00044   BLT_NOT_SRC_OR_NOT_DST,         /// D := ~S | ~D  ==  ~(S & D)
00045   BLT_SET                         /// D := 1
00046   };
00047 
00048 
00049 /// Line Styles
00050 enum FXLineStyle {
00051   LINE_SOLID,                     /// Solid lines
00052   LINE_ONOFF_DASH,                /// On-off dashed lines
00053   LINE_DOUBLE_DASH                /// Double dashed lines
00054   };
00055 
00056 
00057 /// Line Cap Styles
00058 enum FXCapStyle {
00059   CAP_NOT_LAST,                   /// Don't include last end cap
00060   CAP_BUTT,                       /// Butting line end caps
00061   CAP_ROUND,                      /// Round line end caps
00062   CAP_PROJECTING                  /// Projecting line end caps
00063   };
00064 
00065 
00066 /// Line Join Styles
00067 enum FXJoinStyle {
00068   JOIN_MITER,                     /// Mitered or pointy joints
00069   JOIN_ROUND,                     /// Round line joints
00070   JOIN_BEVEL                      /// Beveled or flat joints
00071   };
00072 
00073 
00074 /// Fill Styles
00075 enum FXFillStyle {
00076   FILL_SOLID,                     /// Fill with solid color
00077   FILL_TILED,                     /// Fill with tiled bitmap
00078   FILL_STIPPLED,                  /// Fill where stipple mask is 1
00079   FILL_OPAQUESTIPPLED             /// Fill with foreground where mask is 1, background otherwise
00080   };
00081 
00082 
00083 /// Fill Rules
00084 enum FXFillRule {
00085   RULE_EVEN_ODD,                  /// Even odd polygon filling
00086   RULE_WINDING                    /// Winding rule polygon filling
00087   };
00088 
00089 
00090 /// Stipple/dither patterns
00091 enum FXStipplePattern {
00092   STIPPLE_0         = 0,
00093   STIPPLE_NONE      = 0,
00094   STIPPLE_BLACK     = 0,            /// All ones
00095   STIPPLE_1         = 1,
00096   STIPPLE_2         = 2,
00097   STIPPLE_3         = 3,
00098   STIPPLE_4         = 4,
00099   STIPPLE_5         = 5,
00100   STIPPLE_6         = 6,
00101   STIPPLE_7         = 7,
00102   STIPPLE_8         = 8,
00103   STIPPLE_GRAY      = 8,            /// 50% gray
00104   STIPPLE_9         = 9,
00105   STIPPLE_10        = 10,
00106   STIPPLE_11        = 11,
00107   STIPPLE_12        = 12,
00108   STIPPLE_13        = 13,
00109   STIPPLE_14        = 14,
00110   STIPPLE_15        = 15,
00111   STIPPLE_16        = 16,
00112   STIPPLE_WHITE     = 16,           /// All zeroes
00113   STIPPLE_HORZ      = 17,           /// Horizontal hatch pattern
00114   STIPPLE_VERT      = 18,           /// Vertical hatch pattern
00115   STIPPLE_CROSS     = 19,           /// Cross-hatch pattern
00116   STIPPLE_DIAG      = 20,           /// Diagonal // hatch pattern
00117   STIPPLE_REVDIAG   = 21,           /// Reverse diagonal \\ hatch pattern
00118   STIPPLE_CROSSDIAG = 22            /// Cross-diagonal hatch pattern
00119   };
00120 
00121 
00122 /// Line segment
00123 struct FXSegment {
00124   FXshort x1,y1,x2,y2;
00125   };
00126 
00127 
00128 /// Arc
00129 struct FXArc {
00130   FXshort x,y,w,h,a,b;
00131   };
00132 
00133 
00134 class FXApp;
00135 class FXImage;
00136 class FXBitmap;
00137 class FXIcon;
00138 class FXFont;
00139 class FXDrawable;
00140 class FXRegion;
00141 
00142 
00143 /**
00144 * Abstract Device Context
00145 *
00146 * A Device Context is used to maintain the state of the graphics drawing system.
00147 * Defining your drawing code in terms of the Abstract Device Context allows the
00148 * drawing commands to be rendered on different types of surfaces, such as windows
00149 * and images (FXDCWindow), or on paper (FXDCPrint).
00150 * WYSYWYG may be obtained by using the same identical drawing code in your
00151 * application regardless of the actual device surface being utilized.
00152 */
00153 class FXAPI FXDC {
00154 private:
00155   FXApp           *app;         // Application
00156 protected:
00157   FXFont          *font;        // Drawing font
00158   FXStipplePattern pattern;     // Stipple pattern
00159   FXBitmap        *stipple;     // Stipple bitmap
00160   FXImage         *tile;        // Tile image
00161   FXBitmap        *mask;        // Mask bitmap
00162   FXRectangle      clip;        // Clip rectangle
00163   FXColor          fg;          // Foreground color
00164   FXColor          bg;          // Background color
00165   FXuint           width;       // Line width
00166   FXCapStyle       cap;         // Line cap style
00167   FXJoinStyle      join;        // Line join style
00168   FXLineStyle      style;       // Line style
00169   FXFillStyle      fill;        // Fill style
00170   FXFillRule       rule;        // Fill rule
00171   FXFunction       rop;         // RasterOp
00172   FXchar           dashpat[32]; // Line dash pattern data
00173   FXuint           dashlen;     // Line dash pattern length
00174   FXuint           dashoff;     // Line dash pattern offset
00175   FXint            tx;          // Tile dx
00176   FXint            ty;          // Tile dy
00177   FXint            cx;          // Clip x
00178   FXint            cy;          // Clip y
00179 private:
00180   FXDC();
00181   FXDC(const FXDC&);
00182   FXDC &operator=(const FXDC&);
00183 public:
00184 
00185   /// Construct dummy DC
00186   FXDC(FXApp* a);
00187 
00188   /// Get application
00189   FXApp* getApp() const { return app; }
00190 
00191   /// Read back pixel
00192   virtual FXColor readPixel(FXint x,FXint y);
00193 
00194   /// Draw points
00195   virtual void drawPoint(FXint x,FXint y);
00196   virtual void drawPoints(const FXPoint* points,FXuint npoints);
00197   virtual void drawPointsRel(const FXPoint* points,FXuint npoints);
00198 
00199   /// Draw lines
00200   virtual void drawLine(FXint x1,FXint y1,FXint x2,FXint y2);
00201   virtual void drawLines(const FXPoint* points,FXuint npoints);
00202   virtual void drawLinesRel(const FXPoint* points,FXuint npoints);
00203   virtual void drawLineSegments(const FXSegment* segments,FXuint nsegments);
00204 
00205   /// Draw rectangles
00206   virtual void drawRectangle(FXint x,FXint y,FXint w,FXint h);
00207   virtual void drawRectangles(const FXRectangle* rectangles,FXuint nrectangles);
00208 
00209   /**
00210   * Draw arcs.
00211   * The argument ang1 specifies the start of the arc relative to the
00212   * three-o'clock position from the center, in units of degrees*64.
00213   * The argument ang2 specifies the path and extent of the arc relative
00214   * to the start of the arc, in units of degrees*64.
00215   * The arguments x,y,w,h specify the bounding rectangle.
00216   */
00217   virtual void drawArc(FXint x,FXint y,FXint w,FXint h,FXint ang1,FXint ang2);
00218   virtual void drawArcs(const FXArc* arcs,FXuint narcs);
00219 
00220   /// Filled rectangles
00221   virtual void fillRectangle(FXint x,FXint y,FXint w,FXint h);
00222   virtual void fillRectangles(const FXRectangle* rectangles,FXuint nrectangles);
00223 
00224   /// Draw arcs
00225   virtual void fillArc(FXint x,FXint y,FXint w,FXint h,FXint ang1,FXint ang2);
00226   virtual void fillArcs(const FXArc* arcs,FXuint narcs);
00227 
00228   /// Filled polygon
00229   virtual void fillPolygon(const FXPoint* points,FXuint npoints);
00230   virtual void fillConcavePolygon(const FXPoint* points,FXuint npoints);
00231   virtual void fillComplexPolygon(const FXPoint* points,FXuint npoints);
00232 
00233   /// Filled polygon with relative points
00234   virtual void fillPolygonRel(const FXPoint* points,FXuint npoints);
00235   virtual void fillConcavePolygonRel(const FXPoint* points,FXuint npoints);
00236   virtual void fillComplexPolygonRel(const FXPoint* points,FXuint npoints);
00237 
00238   /// Draw hashed box
00239   virtual void drawHashBox(FXint x,FXint y,FXint w,FXint h,FXint b=1);
00240 
00241   /// Draw focus rectangle
00242   virtual void drawFocusRectangle(FXint x,FXint y,FXint w,FXint h);
00243 
00244   /// Draw area from source
00245   virtual void drawArea(const FXDrawable* source,FXint sx,FXint sy,FXint sw,FXint sh,FXint dx,FXint dy);
00246 
00247   /// Draw image
00248   virtual void drawImage(const FXImage* image,FXint dx,FXint dy);
00249 
00250   /// Draw bitmap
00251   virtual void drawBitmap(const FXBitmap* bitmap,FXint dx,FXint dy);
00252 
00253   /// Draw icon
00254   virtual void drawIcon(const FXIcon* icon,FXint dx,FXint dy);
00255   virtual void drawIconShaded(const FXIcon* icon,FXint dx,FXint dy);
00256   virtual void drawIconSunken(const FXIcon* icon,FXint dx,FXint dy);
00257 
00258   /// Draw string
00259   virtual void drawText(FXint x,FXint y,const FXchar* string,FXuint length);
00260   virtual void drawImageText(FXint x,FXint y,const FXchar* string,FXuint length);
00261 
00262   /// Set foreground drawing color
00263   virtual void setForeground(FXColor clr);
00264 
00265   /// Get foreground drawing color
00266   FXColor getForeground() const { return fg; }
00267 
00268   /// Set background drawing color
00269   virtual void setBackground(FXColor clr);
00270 
00271   /// Get background drawing color
00272   FXColor getBackground() const { return bg; }
00273 
00274   /**
00275   * Set dash pattern and dash offset.
00276   * A dash pattern of [1 2 3 4] is a repeating pattern of 1 foreground pixel,
00277   * 2 background pixels, 3 foreground pixels, and 4 background pixels.
00278   * The offset is where in the pattern the system will start counting.
00279   * The maximum length of the dash pattern is 32.
00280   */
00281   virtual void setDashes(FXuint dashoffset,const FXchar *dashpattern,FXuint dashlength);
00282 
00283   /// Get dash pattern
00284   const FXchar* getDashPattern() const { return dashpat; }
00285 
00286   /// Get dash offset
00287   FXuint getDashOffset() const { return dashoff; }
00288 
00289   /// Get dash length
00290   FXuint getDashLength() const { return dashlen; }
00291 
00292   /// Set line width:- 0 means thinnest/fastest possible
00293   virtual void setLineWidth(FXuint linewidth=0);
00294 
00295   /// Get line width
00296   FXuint getLineWidth() const { return width; }
00297 
00298   /// Set line cap style
00299   virtual void setLineCap(FXCapStyle capstyle=CAP_BUTT);
00300 
00301   /// Get line cap style
00302   FXCapStyle getLineCap() const { return cap; }
00303 
00304   /// Set line join style
00305   virtual void setLineJoin(FXJoinStyle joinstyle=JOIN_MITER);
00306 
00307   /// Get line join style
00308   FXJoinStyle getLineJoin() const { return join; }
00309 
00310   /// Set line style
00311   virtual void setLineStyle(FXLineStyle linestyle=LINE_SOLID);
00312 
00313   /// Get line style
00314   FXLineStyle getLineStyle() const { return style; }
00315 
00316   /// Set fill style
00317   virtual void setFillStyle(FXFillStyle fillstyle=FILL_SOLID);
00318 
00319   /// Get fill style
00320   FXFillStyle getFillStyle() const { return fill; }
00321 
00322   /// Set fill rule
00323   virtual void setFillRule(FXFillRule fillrule=RULE_EVEN_ODD);
00324 
00325   /// Get fill rule
00326   FXFillRule getFillRule() const { return rule; }
00327 
00328   /// Set rasterop function
00329   virtual void setFunction(FXFunction func=BLT_SRC);
00330 
00331   /// Get rasterop function
00332   FXFunction getFunction() const { return rop; }
00333 
00334   /// Set the tile image
00335   virtual void setTile(FXImage* image,FXint dx=0,FXint dy=0);
00336 
00337   /// Get the tile image
00338   FXImage *getTile() const { return tile; }
00339 
00340   /// Set the stipple pattern
00341   virtual void setStipple(FXBitmap *bitmap,FXint dx=0,FXint dy=0);
00342 
00343   /// Get stipple bitmap
00344   FXBitmap *getStippleBitmap() const { return stipple; }
00345 
00346   /// Set the stipple pattern
00347   virtual void setStipple(FXStipplePattern pat,FXint dx=0,FXint dy=0);
00348 
00349   /// Get pattern
00350   FXStipplePattern getStipplePattern() const { return pattern; }
00351 
00352   /// Set clip region
00353   virtual void setClipRegion(const FXRegion& region);
00354 
00355   /// Set clip rectangle
00356   virtual void setClipRectangle(FXint x,FXint y,FXint w,FXint h);
00357 
00358   /// Change clip rectangle
00359   virtual void setClipRectangle(const FXRectangle& rectangle);
00360 
00361   /// Return clip rectangle
00362   const FXRectangle& getClipRectangle() const { return clip; }
00363 
00364   /// Return clip x
00365   FXint getClipX() const { return clip.x; }
00366 
00367   /// Return clip y
00368   FXint getClipY() const { return clip.y; }
00369 
00370   /// Return clip width
00371   FXint getClipWidth() const { return clip.w; }
00372 
00373   /// Return clip height
00374   FXint getClipHeight() const { return clip.h; }
00375 
00376   /// Clear clipping
00377   virtual void clearClipRectangle();
00378 
00379   /// Set clip mask
00380   virtual void setClipMask(FXBitmap* bitmap,FXint dx=0,FXint dy=0);
00381 
00382   /// Clear clip mask
00383   virtual void clearClipMask();
00384 
00385   /// Set font to draw text with
00386   virtual void setTextFont(FXFont *fnt);
00387 
00388   /// Get text font
00389   FXFont* getTextFont() const { return font; }
00390 
00391   /// Clip against child windows
00392   virtual void clipChildren(FXbool yes);
00393 
00394   /// Destructor
00395   virtual ~FXDC();
00396   };
00397 
00398 
00399 #endif