Portability | portable |
---|---|
Stability | provisional |
Maintainer | wxhaskell-devel@lists.sourceforge.net |
Drawing.
- drawLines :: DC a -> [Point] -> IO ()
- drawPolygon :: DC a -> [Point] -> IO ()
- getTextExtent :: DC a -> String -> IO Size
- getFullTextExtent :: DC a -> String -> IO (Size, Int, Int)
- dcClearRect :: DC a -> Rect -> IO ()
- withPaintDC :: Window a -> (PaintDC () -> IO b) -> IO b
- withClientDC :: Window a -> (ClientDC () -> IO b) -> IO b
- dcDraw :: DC a -> IO b -> IO b
- withSVGFileDC :: FilePath -> (SVGFileDC () -> IO b) -> IO b
- withSVGFileDCWithSize :: FilePath -> Size -> (SVGFileDC () -> IO b) -> IO b
- withSVGFileDCWithSizeAndResolution :: FilePath -> Size -> Float -> (SVGFileDC () -> IO b) -> IO b
- data DrawState
- dcEncapsulate :: DC a -> IO b -> IO b
- dcGetDrawState :: DC a -> IO DrawState
- dcSetDrawState :: DC a -> DrawState -> IO ()
- drawStateDelete :: DrawState -> IO ()
- dcBuffer :: DC a -> Rect -> (DC () -> IO ()) -> IO ()
- dcBufferWithRef :: DC a -> Maybe (Var (Bitmap ())) -> Rect -> (DC () -> IO ()) -> IO ()
- dcBufferWithRefEx :: DC a -> (DC () -> IO ()) -> Maybe (Var (Bitmap ())) -> Rect -> (DC () -> IO ()) -> IO ()
- windowGetViewStart :: Window a -> IO Point
- windowGetViewRect :: Window a -> IO Rect
- windowCalcUnscrolledPosition :: Window a -> Point -> IO Point
- data FontStyle = FontStyle {
- _fontSize :: !Int
- _fontFamily :: !FontFamily
- _fontShape :: !FontShape
- _fontWeight :: !FontWeight
- _fontUnderline :: !Bool
- _fontFace :: !String
- _fontEncoding :: !Int
- data FontFamily
- = FontDefault
- | FontDecorative
- | FontRoman
- | FontScript
- | FontSwiss
- | FontModern
- data FontShape
- = ShapeNormal
- | ShapeItalic
- | ShapeSlant
- data FontWeight
- fontDefault :: FontStyle
- fontSwiss :: FontStyle
- fontSmall :: FontStyle
- fontItalic :: FontStyle
- fontFixed :: FontStyle
- withFontStyle :: FontStyle -> (Font () -> IO a) -> IO a
- dcWithFontStyle :: DC a -> FontStyle -> IO b -> IO b
- dcSetFontStyle :: DC a -> FontStyle -> IO ()
- dcGetFontStyle :: DC a -> IO FontStyle
- fontCreateFromStyle :: FontStyle -> IO (Font (), IO ())
- fontGetFontStyle :: Font () -> IO FontStyle
- data BrushStyle = BrushStyle {
- _brushKind :: !BrushKind
- _brushColor :: !Color
- data BrushKind
- = BrushTransparent
- | BrushSolid
- | BrushHatch { }
- | BrushStipple {
- _brushBitmap :: !(Bitmap ())
- data HatchStyle
- brushDefault :: BrushStyle
- brushSolid :: Color -> BrushStyle
- brushTransparent :: BrushStyle
- dcSetBrushStyle :: DC a -> BrushStyle -> IO ()
- dcGetBrushStyle :: DC a -> IO BrushStyle
- withBrushStyle :: BrushStyle -> (Brush () -> IO a) -> IO a
- dcWithBrushStyle :: DC a -> BrushStyle -> IO b -> IO b
- dcWithBrush :: DC b -> Brush a -> IO c -> IO c
- brushCreateFromStyle :: BrushStyle -> IO (Brush (), IO ())
- brushGetBrushStyle :: Brush a -> IO BrushStyle
- data PenStyle = PenStyle {}
- data PenKind
- = PenTransparent
- | PenSolid
- | PenDash { }
- | PenHatch {
- _penHatch :: !HatchStyle
- | PenStipple {
- _penBitmap :: !(Bitmap ())
- data CapStyle
- = CapRound
- | CapProjecting
- | CapButt
- data JoinStyle
- data DashStyle
- = DashDot
- | DashLong
- | DashShort
- | DashDotShort
- penDefault :: PenStyle
- penColored :: Color -> Int -> PenStyle
- penTransparent :: PenStyle
- dcSetPenStyle :: DC a -> PenStyle -> IO ()
- dcGetPenStyle :: DC a -> IO PenStyle
- withPenStyle :: PenStyle -> (Pen () -> IO a) -> IO a
- dcWithPenStyle :: DC a -> PenStyle -> IO b -> IO b
- dcWithPen :: DC a -> Pen p -> IO b -> IO b
- penCreateFromStyle :: PenStyle -> IO (Pen (), IO ())
- penGetPenStyle :: Pen a -> IO PenStyle
DC
drawPolygon :: DC a -> [Point] -> IO ()Source
Draw a polygon. The polygon is filled with the odd-even rule.
getTextExtent :: DC a -> String -> IO SizeSource
Gets the dimensions of the string using the currently selected font.
getFullTextExtent :: DC a -> String -> IO (Size, Int, Int)Source
Gets the dimensions of the string using the currently selected font. Takes text string to measure, and returns the size, descent and external leading. Descent is the dimension from the baseline of the font to the bottom of the descender , and external leading is any extra vertical space added to the font by the font designer (is usually zero).
dcClearRect :: DC a -> Rect -> IO ()Source
Clear a specific rectangle with the current background brush.
This is preferred to dcClear
for scrolled windows as dcClear
sometimes
only clears the original view area, instead of the currently visible scrolled area.
Unfortunately, the background brush is not set correctly on wxMAC 2.4, and
this will always clear to a white color on mac systems.
Creation
dcDraw :: DC a -> IO b -> IO bSource
Encloses the computation with dcBeginDrawing
and dcEndDrawing
.
withSVGFileDCWithSizeAndResolution :: FilePath -> Size -> Float -> (SVGFileDC () -> IO b) -> IO bSource
Draw state
The drawing state (pen,brush,font,text color,text background color) of a device context.
dcEncapsulate :: DC a -> IO b -> IO bSource
Run a computation after which the original drawing state of the DC
is restored.
dcGetDrawState :: DC a -> IO DrawStateSource
Get the drawing state. (Should be deleted with drawStateDelete
).
drawStateDelete :: DrawState -> IO ()Source
Release the resources associated with a drawing state.
Double buffering
dcBuffer :: DC a -> Rect -> (DC () -> IO ()) -> IO ()Source
Use double buffering to draw to a DC
-- reduces flicker. Note that
the windowOnPaint
handler can already take care of buffering automatically.
The rectangle argument is normally the view rectangle (windowGetViewRect
).
Uses a MemoryDC
to draw into memory first and than blit the result to
the device context. The memory area allocated is the minimal size necessary
to accomodate the rectangle, but is re-allocated on each invokation.
dcBufferWithRef :: DC a -> Maybe (Var (Bitmap ())) -> Rect -> (DC () -> IO ()) -> IO ()Source
Optimized double buffering. Takes a possible reference to a bitmap. If it is
Nothing
, a new bitmap is allocated everytime. Otherwise, the reference is used
to re-use an allocated bitmap if possible. The Rect
argument specifies the
the current logical view rectangle. The last argument is called to draw on the
memory DC
.
dcBufferWithRefEx :: DC a -> (DC () -> IO ()) -> Maybe (Var (Bitmap ())) -> Rect -> (DC () -> IO ()) -> IO ()Source
Optimized double buffering. Takes a clear routine as its first argument. Normally this is something like 'dc -> dcClearRect dc viewArea' but on certain platforms, like MacOS X, special handling is necessary.
Scrolled windows
windowGetViewStart :: Window a -> IO PointSource
Get logical view start, adjusted for scrolling.
windowGetViewRect :: Window a -> IO RectSource
Get logical view rectangle, adjusted for scrolling.
windowCalcUnscrolledPosition :: Window a -> Point -> IO PointSource
Get logical coordinates adjusted for scrolling.
Font
Font descriptor. The font is normally specified thru the FontFamily
, giving
some degree of portability. The _fontFace
can be used to specify the exact (platform
dependent) font.
Note that the original wxWindows FontStyle
is renamed to FontShape
.
FontStyle | |
|
data FontFamily Source
Standard font families.
FontDefault | A system default font. |
FontDecorative | Decorative font. |
FontRoman | Formal serif font. |
FontScript | Hand writing font. |
FontSwiss | Sans-serif font. |
FontModern | Fixed pitch font. |
data FontWeight Source
The font weight.
fontDefault :: FontStyleSource
Default 10pt font.
Default 10pt italic.
withFontStyle :: FontStyle -> (Font () -> IO a) -> IO aSource
Use a font that is automatically deleted at the end of the computation.
dcWithFontStyle :: DC a -> FontStyle -> IO b -> IO bSource
Set a font that is automatically deleted at the end of the computation.
dcGetFontStyle :: DC a -> IO FontStyleSource
Get the current font info.
Brush
Brush kind.
BrushTransparent | No filling |
BrushSolid | Solid color |
BrushHatch | Hatch pattern |
BrushStipple | Bitmap pattern (on win95 only 8x8 bitmaps are supported) |
|
data HatchStyle Source
Hatch style.
HatchBDiagonal | Backward diagonal |
HatchCrossDiag | Crossed diagonal |
HatchFDiagonal | Forward diagonal |
HatchCross | Crossed orthogonal |
HatchHorizontal | Horizontal |
HatchVertical | Vertical |
brushDefault :: BrushStyleSource
Default brush (transparent, black).
brushSolid :: Color -> BrushStyleSource
A solid brush of a specific color.
brushTransparent :: BrushStyleSource
A transparent brush.
dcSetBrushStyle :: DC a -> BrushStyle -> IO ()Source
Set the brush style (and text background color) of a device context.
dcGetBrushStyle :: DC a -> IO BrushStyleSource
Get the current brush of a device context.
withBrushStyle :: BrushStyle -> (Brush () -> IO a) -> IO aSource
Use a brush that is automatically deleted at the end of the computation.
dcWithBrushStyle :: DC a -> BrushStyle -> IO b -> IO bSource
Use a brush that is automatically deleted at the end of the computation.
brushCreateFromStyle :: BrushStyle -> IO (Brush (), IO ())Source
Create a new brush from a BrushStyle
. Returns both the brush and its deletion procedure.
brushGetBrushStyle :: Brush a -> IO BrushStyleSource
Get the BrushStyle
of Brush
.
Pen
Pen style.
Pen kinds.
PenTransparent | No edge. |
PenSolid | |
PenDash | |
PenHatch | |
| |
PenStipple |
|
|
Cap style
CapRound | End points are rounded |
CapProjecting | |
CapButt |
Join style.
Default pen (PenStyle PenSolid black 1 CapRound JoinRound
)
penColored :: Color -> Int -> PenStyleSource
A solid pen with a certain color and width.
penTransparent :: PenStyleSource
A transparent pen.
dcSetPenStyle :: DC a -> PenStyle -> IO ()Source
Set the current pen style. The text color is also adapted.
dcGetPenStyle :: DC a -> IO PenStyleSource
Get the current pen style.
withPenStyle :: PenStyle -> (Pen () -> IO a) -> IO aSource
Use a pen that is automatically deleted at the end of the computation.
dcWithPenStyle :: DC a -> PenStyle -> IO b -> IO bSource
Set a pen that is automatically deleted at the end of the computation.
dcWithPen :: DC a -> Pen p -> IO b -> IO bSource
Set a pen that is used during a certain computation.