Graphics.UI.WXCore.Draw

Drawing.

DC

drawLines :: DC a -> [Point] -> IO ()

Draw connected lines.

drawPolygon :: DC a -> [Point] -> IO ()

Draw a polygon. The polygon is filled with the odd-even rule.

getTextExtent :: DC a -> String -> IO Size

Gets the dimensions of the string using the currently selected font.

getFullTextExtent :: DC a -> String -> IO (Size, Int, Int)

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 ()

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

withPaintDC :: Window a -> (PaintDC () -> IO b) -> IO b

Use a PaintDC. Draw on a window within an 'on paint' event.

withClientDC :: Window a -> (ClientDC () -> IO b) -> IO b

Use a ClientDC. Draw on a window from outside an 'on paint' event.

dcDraw :: DC a -> IO b -> IO b

Safely perform a drawing operation on a DC.

withSVGFileDC :: FilePath -> (SVGFileDC () -> IO b) -> IO b

Use a SVGFileDC.

withSVGFileDCWithSize :: FilePath -> Size -> (SVGFileDC () -> IO b) -> IO b

withSVGFileDCWithSizeAndResolution :: FilePath -> Size -> Float -> (SVGFileDC () -> IO b) -> IO b

Draw state

data DrawState

The drawing state (pen,brush,font,text color,text background color) of a device context.

dcEncapsulate :: DC a -> IO b -> IO b

Run a computation after which the original drawing state of the DC is restored.

dcGetDrawState :: DC a -> IO DrawState

Get the drawing state. (Should be deleted with drawStateDelete).

dcSetDrawState :: DC a -> DrawState -> IO ()

Set the drawing state.

drawStateDelete :: DrawState -> IO ()

Release the resources associated with a drawing state.

Double buffering

dcBuffer :: WindowDC a -> Rect -> (DC () -> IO ()) -> IO ()

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 :: WindowDC a -> Maybe (Var (Bitmap ())) -> Rect -> (DC () -> IO ()) -> IO ()

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 :: WindowDC a -> (DC () -> IO ()) -> Maybe (Var (Bitmap ())) -> Rect -> (DC () -> IO ()) -> IO ()

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.

dcBufferWithRefExGcdc :: WindowDC a -> (DC () -> IO ()) -> Maybe (Var (Bitmap ())) -> Rect -> (GCDC () -> IO b) -> IO ()

Optimized double buffering with a GCDC. 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 Point

Get logical view start, adjusted for scrolling.

windowGetViewRect :: Window a -> IO Rect

Get logical view rectangle, adjusted for scrolling.

windowCalcUnscrolledPosition :: Window a -> Point -> IO Point

Get logical coordinates adjusted for scrolling.

Font

data FontStyle

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 wxWidgets FontStyle is renamed to FontShape.

Constructors

FontStyle

Fields

• _fontSize :: !Int
• _fontFamily :: !FontFamily
• _fontShape :: !FontShape
• _fontWeight :: !FontWeight
• _fontUnderline :: !Bool
• _fontFace :: !String

  normally ""

• _fontEncoding :: !Int

  normally wxFONTENCODING_DEFAULT

Instances

Eq FontStyle

Methods

(==) :: FontStyle -> FontStyle -> Bool

(/=) :: FontStyle -> FontStyle -> Bool

Show FontStyle

Methods

showsPrec :: Int -> FontStyle -> ShowS

show :: FontStyle -> String

showList :: [FontStyle] -> ShowS

data FontFamily

Standard font families.

Constructors

FontDefault

A system default font.

FontDecorative

Decorative font.

FontRoman

Formal serif font.

FontScript

Hand writing font.

FontSwiss

Sans-serif font.

FontModern

Fixed pitch font.

FontTeletype

A teletype (i.e. monospaced) font

Instances

Eq FontFamily

Methods

(==) :: FontFamily -> FontFamily -> Bool

(/=) :: FontFamily -> FontFamily -> Bool

Show FontFamily

Methods

showsPrec :: Int -> FontFamily -> ShowS

show :: FontFamily -> String

showList :: [FontFamily] -> ShowS

data FontShape

The font style.

Constructors

ShapeNormal

ShapeItalic

ShapeSlant

Instances

Eq FontShape

Methods

(==) :: FontShape -> FontShape -> Bool

(/=) :: FontShape -> FontShape -> Bool

Show FontShape

Methods

showsPrec :: Int -> FontShape -> ShowS

show :: FontShape -> String

showList :: [FontShape] -> ShowS

data FontWeight

The font weight.

Constructors

WeightNormal

WeightBold

WeightLight

Instances

Eq FontWeight

Methods

(==) :: FontWeight -> FontWeight -> Bool

(/=) :: FontWeight -> FontWeight -> Bool

Show FontWeight

Methods

showsPrec :: Int -> FontWeight -> ShowS

show :: FontWeight -> String

showList :: [FontWeight] -> ShowS

fontDefault :: FontStyle

Default 10pt font.

fontSwiss :: FontStyle

Default 10pt sans-serif font.

fontSmall :: FontStyle

Default 8pt font.

fontItalic :: FontStyle

Default 10pt italic.

fontFixed :: FontStyle

Monospaced font, 10pt.

withFontStyle :: FontStyle -> (Font () -> IO a) -> IO a

Use a font that is automatically deleted at the end of the computation.

dcWithFontStyle :: DC a -> FontStyle -> IO b -> IO b

Set a font that is automatically deleted at the end of the computation.

dcSetFontStyle :: DC a -> FontStyle -> IO ()

Set the font info of a DC.

dcGetFontStyle :: DC a -> IO FontStyle

Get the current font info.

fontCreateFromStyle :: FontStyle -> IO (Font (), IO ())

Create a Font from FontStyle. Returns both the font and a deletion procedure.

fontGetFontStyle :: Font () -> IO FontStyle

Get the FontStyle from a Font object.

Brush

data BrushStyle

Brush style.

Constructors

BrushStyle

Fields

• _brushKind :: !BrushKind
• _brushColor :: !Color

Instances

Eq BrushStyle

Methods

(==) :: BrushStyle -> BrushStyle -> Bool

(/=) :: BrushStyle -> BrushStyle -> Bool

Show BrushStyle

Methods

showsPrec :: Int -> BrushStyle -> ShowS

show :: BrushStyle -> String

showList :: [BrushStyle] -> ShowS

data BrushKind

Brush kind.

Constructors

BrushTransparent

No filling

BrushSolid

Solid color

BrushHatch

Hatch pattern

Fields

• _brushHatch :: !HatchStyle

BrushStipple

Bitmap pattern (on win95 only 8x8 bitmaps are supported)

Fields

• _brushBitmap :: !(Bitmap ())

Instances

Eq BrushKind

Methods

(==) :: BrushKind -> BrushKind -> Bool

(/=) :: BrushKind -> BrushKind -> Bool

Show BrushKind

Methods

showsPrec :: Int -> BrushKind -> ShowS

show :: BrushKind -> String

showList :: [BrushKind] -> ShowS

data HatchStyle

Hatch style.

Constructors

HatchBDiagonal

Backward diagonal

HatchCrossDiag

Crossed diagonal

HatchFDiagonal

Forward diagonal

HatchCross

Crossed orthogonal

HatchHorizontal

Horizontal

HatchVertical

Vertical

Instances

Eq HatchStyle

Methods

(==) :: HatchStyle -> HatchStyle -> Bool

(/=) :: HatchStyle -> HatchStyle -> Bool

Show HatchStyle

Methods

showsPrec :: Int -> HatchStyle -> ShowS

show :: HatchStyle -> String

showList :: [HatchStyle] -> ShowS

brushDefault :: BrushStyle

Default brush (transparent, black).

brushSolid :: Color -> BrushStyle

A solid brush of a specific color.

brushTransparent :: BrushStyle

A transparent brush.

dcSetBrushStyle :: DC a -> BrushStyle -> IO ()

Set the brush style (and text background color) of a device context.

dcGetBrushStyle :: DC a -> IO BrushStyle

Get the current brush of a device context.

withBrushStyle :: BrushStyle -> (Brush () -> IO a) -> IO a

Use a brush that is automatically deleted at the end of the computation.

dcWithBrushStyle :: DC a -> BrushStyle -> IO b -> IO b

Use a brush that is automatically deleted at the end of the computation.

dcWithBrush :: DC b -> Brush a -> IO c -> IO c

brushCreateFromStyle :: BrushStyle -> IO (Brush (), IO ())

Create a new brush from a BrushStyle. Returns both the brush and its deletion procedure.

brushGetBrushStyle :: Brush a -> IO BrushStyle

Get the BrushStyle of Brush.

Pen

data PenStyle

Pen style.

Constructors

PenStyle

Fields

• _penKind :: !PenKind
• _penColor :: !Color
• _penWidth :: !Int
• _penCap :: !CapStyle
• _penJoin :: !JoinStyle

Instances

Eq PenStyle

Methods

(==) :: PenStyle -> PenStyle -> Bool

(/=) :: PenStyle -> PenStyle -> Bool

Show PenStyle

Methods

showsPrec :: Int -> PenStyle -> ShowS

show :: PenStyle -> String

showList :: [PenStyle] -> ShowS

data PenKind

Pen kinds.

Constructors

PenTransparent

No edge.

PenSolid

PenDash

Fields

• _penDash :: !DashStyle

PenHatch

Fields

• _penHatch :: !HatchStyle

PenStipple

_penColor is ignored

Fields

• _penBitmap :: !(Bitmap ())

Instances

Eq PenKind

Methods

(==) :: PenKind -> PenKind -> Bool

(/=) :: PenKind -> PenKind -> Bool

Show PenKind

Methods

showsPrec :: Int -> PenKind -> ShowS

show :: PenKind -> String

showList :: [PenKind] -> ShowS

data CapStyle

Cap style

Constructors

CapRound

End points are rounded

CapProjecting

CapButt

Instances

Eq CapStyle

Methods

(==) :: CapStyle -> CapStyle -> Bool

(/=) :: CapStyle -> CapStyle -> Bool

Show CapStyle

Methods

showsPrec :: Int -> CapStyle -> ShowS

show :: CapStyle -> String

showList :: [CapStyle] -> ShowS

data JoinStyle

Join style.

Constructors

JoinRound

Corners are rounded

JoinBevel

Corners are bevelled

JoinMiter

Corners are blocked

Instances

Eq JoinStyle

Methods

(==) :: JoinStyle -> JoinStyle -> Bool

(/=) :: JoinStyle -> JoinStyle -> Bool

Show JoinStyle

Methods

showsPrec :: Int -> JoinStyle -> ShowS

show :: JoinStyle -> String

showList :: [JoinStyle] -> ShowS

data DashStyle

Dash style

Constructors

DashDot

DashLong

DashShort

DashDotShort

Instances

Eq DashStyle

Methods

(==) :: DashStyle -> DashStyle -> Bool

(/=) :: DashStyle -> DashStyle -> Bool

Show DashStyle

Methods

showsPrec :: Int -> DashStyle -> ShowS

show :: DashStyle -> String

showList :: [DashStyle] -> ShowS

penDefault :: PenStyle

Default pen (PenStyle PenSolid black 1 CapRound JoinRound)

penColored :: Color -> Int -> PenStyle

A solid pen with a certain color and width.

penTransparent :: PenStyle

A transparent pen.

dcSetPenStyle :: DC a -> PenStyle -> IO ()

Set the current pen style. The text color is also adapted.

dcGetPenStyle :: DC a -> IO PenStyle

Get the current pen style.

withPenStyle :: PenStyle -> (Pen () -> IO a) -> IO a

Use a pen that is automatically deleted at the end of the computation.

dcWithPenStyle :: DC a -> PenStyle -> IO b -> IO b

Set a pen that is automatically deleted at the end of the computation.

dcWithPen :: DC a -> Pen p -> IO b -> IO b

Set a pen that is used during a certain computation.

penCreateFromStyle :: PenStyle -> IO (Pen (), IO ())

Create a new pen from a PenStyle. Returns both the pen and its deletion procedure.

penGetPenStyle :: Pen a -> IO PenStyle

Create a PenStyle from a Pen.