Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.2


Expand All
Contract All

Table of Contents

wxDC

MODULE

wxDC

MODULE SUMMARY

See external documentation: wxDC.

DESCRIPTION

See external documentation: wxDC.

DATA TYPES

wxDC()

An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

EXPORTS

blit(This, DestPt, Sz, Source, SrcPt) -> boolean()

Types:

This = wxDC()
DestPt = {X::integer(), Y::integer()}
Sz = {W::integer(), H::integer()}
Source = wxDC()
SrcPt = {X::integer(), Y::integer()}

blit(This, DestPt, Sz, Source, SrcPt, Option::[Option]) -> boolean()

Types:

This = wxDC()
DestPt = {X::integer(), Y::integer()}
Sz = {W::integer(), H::integer()}
Source = wxDC()
SrcPt = {X::integer(), Y::integer()}
Option = {rop, wx_enum() (see module wx)} | {useMask, boolean()} | {srcPtMask, {X::integer(), Y::integer()}}

See external documentation.
Rop = integer

calcBoundingBox(This, X, Y) -> ok

Types:

This = wxDC()
X = integer()
Y = integer()

clear(This) -> ok

Types:

This = wxDC()

computeScaleAndOrigin(This) -> ok

Types:

This = wxDC()

This function is deprecated: deprecated function not available in wxWidgets-2.9 and later

See external documentation.

crossHair(This, Pt) -> ok

Types:

This = wxDC()
Pt = {X::integer(), Y::integer()}

destroyClippingRegion(This) -> ok

Types:

This = wxDC()

deviceToLogicalX(This, X) -> integer()

Types:

This = wxDC()
X = integer()

deviceToLogicalXRel(This, X) -> integer()

Types:

This = wxDC()
X = integer()

deviceToLogicalY(This, Y) -> integer()

Types:

This = wxDC()
Y = integer()

deviceToLogicalYRel(This, Y) -> integer()

Types:

This = wxDC()
Y = integer()

drawArc(This, Pt1, Pt2, Centre) -> ok

Types:

This = wxDC()
Pt1 = {X::integer(), Y::integer()}
Pt2 = {X::integer(), Y::integer()}
Centre = {X::integer(), Y::integer()}

drawBitmap(This, Bmp, Pt) -> ok

Types:

This = wxDC()
Bmp = wxBitmap() (see module wxBitmap)
Pt = {X::integer(), Y::integer()}

drawBitmap(This, Bmp, Pt, Option::[Option]) -> ok

Types:

This = wxDC()
Bmp = wxBitmap() (see module wxBitmap)
Pt = {X::integer(), Y::integer()}
Option = {useMask, boolean()}

drawCheckMark(This, Rect) -> ok

Types:

This = wxDC()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}

drawCircle(This, Pt, Radius) -> ok

Types:

This = wxDC()
Pt = {X::integer(), Y::integer()}
Radius = integer()

drawEllipse(This, Rect) -> ok

Types:

This = wxDC()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}

drawEllipse(This, Pt, Sz) -> ok

Types:

This = wxDC()
Pt = {X::integer(), Y::integer()}
Sz = {W::integer(), H::integer()}

drawEllipticArc(This, Pt, Sz, Sa, Ea) -> ok

Types:

This = wxDC()
Pt = {X::integer(), Y::integer()}
Sz = {W::integer(), H::integer()}
Sa = number()
Ea = number()

drawIcon(This, Icon, Pt) -> ok

Types:

This = wxDC()
Icon = wxIcon() (see module wxIcon)
Pt = {X::integer(), Y::integer()}

drawLabel(This, Text, Rect) -> ok

Types:

This = wxDC()
Text = chardata() (see module unicode)
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}

drawLabel(This, Text, Rect, Option::[Option]) -> ok

Types:

This = wxDC()
Text = chardata() (see module unicode)
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}
Option = {alignment, integer()} | {indexAccel, integer()}

drawLine(This, Pt1, Pt2) -> ok

Types:

This = wxDC()
Pt1 = {X::integer(), Y::integer()}
Pt2 = {X::integer(), Y::integer()}

drawLines(This, Points) -> ok

Types:

This = wxDC()
Points = [{X::integer(), Y::integer()}]

drawLines(This, Points, Option::[Option]) -> ok

Types:

This = wxDC()
Points = [{X::integer(), Y::integer()}]
Option = {xoffset, integer()} | {yoffset, integer()}

drawPolygon(This, Points) -> ok

Types:

This = wxDC()
Points = [{X::integer(), Y::integer()}]

drawPolygon(This, Points, Option::[Option]) -> ok

Types:

This = wxDC()
Points = [{X::integer(), Y::integer()}]
Option = {xoffset, integer()} | {yoffset, integer()} | {fillStyle, wx_enum() (see module wx)}

See external documentation.
FillStyle = integer

drawPoint(This, Pt) -> ok

Types:

This = wxDC()
Pt = {X::integer(), Y::integer()}

drawRectangle(This, Rect) -> ok

Types:

This = wxDC()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}

drawRectangle(This, Pt, Sz) -> ok

Types:

This = wxDC()
Pt = {X::integer(), Y::integer()}
Sz = {W::integer(), H::integer()}

drawRotatedText(This, Text, Pt, Angle) -> ok

Types:

This = wxDC()
Text = chardata() (see module unicode)
Pt = {X::integer(), Y::integer()}
Angle = number()

drawRoundedRectangle(This, R, Radius) -> ok

Types:

This = wxDC()
R = {X::integer(), Y::integer(), W::integer(), H::integer()}
Radius = number()

drawRoundedRectangle(This, Pt, Sz, Radius) -> ok

Types:

This = wxDC()
Pt = {X::integer(), Y::integer()}
Sz = {W::integer(), H::integer()}
Radius = number()

drawText(This, Text, Pt) -> ok

Types:

This = wxDC()
Text = chardata() (see module unicode)
Pt = {X::integer(), Y::integer()}

endDoc(This) -> ok

Types:

This = wxDC()

endPage(This) -> ok

Types:

This = wxDC()

floodFill(This, Pt, Col) -> boolean()

Types:

This = wxDC()
Pt = {X::integer(), Y::integer()}
Col = wx_colour() (see module wx)

floodFill(This, Pt, Col, Option::[Option]) -> boolean()

Types:

This = wxDC()
Pt = {X::integer(), Y::integer()}
Col = wx_colour() (see module wx)
Option = {style, wx_enum() (see module wx)}

See external documentation.
Style = integer

getBackground(This) -> wxBrush() (see module wxBrush)

Types:

This = wxDC()

getBackgroundMode(This) -> integer()

Types:

This = wxDC()

getBrush(This) -> wxBrush() (see module wxBrush)

Types:

This = wxDC()

getCharHeight(This) -> integer()

Types:

This = wxDC()

getCharWidth(This) -> integer()

Types:

This = wxDC()

getClippingBox(This) -> Result

Types:

Result = {X::integer(), Y::integer(), W::integer(), H::integer()}
This = wxDC()

getFont(This) -> wxFont() (see module wxFont)

Types:

This = wxDC()

getLayoutDirection(This) -> wx_enum() (see module wx)

Types:

This = wxDC()

See external documentation.
Res = ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft

getLogicalFunction(This) -> integer()

Types:

This = wxDC()

getMapMode(This) -> integer()

Types:

This = wxDC()

getMultiLineTextExtent(This, String) -> {W::integer(), H::integer()}

Types:

This = wxDC()
String = chardata() (see module unicode)

getMultiLineTextExtent(This, String, Option::[Option]) -> {Width::integer(), Height::integer(), HeightLine::integer()}

Types:

This = wxDC()
String = chardata() (see module unicode)
Option = {font, wxFont() (see module wxFont)}

getPartialTextExtents(This, Text) -> Result

Types:

Result = {Res::boolean(), Widths::[integer()]}
This = wxDC()
Text = chardata() (see module unicode)

getPen(This) -> wxPen() (see module wxPen)

Types:

This = wxDC()

getPixel(This, Pt) -> Result

Types:

Result = {Res::boolean(), Col::wx_colour4() (see module wx)}
This = wxDC()
Pt = {X::integer(), Y::integer()}

getPPI(This) -> {W::integer(), H::integer()}

Types:

This = wxDC()

getSize(This) -> {W::integer(), H::integer()}

Types:

This = wxDC()

getSizeMM(This) -> {W::integer(), H::integer()}

Types:

This = wxDC()

getTextBackground(This) -> wx_colour4() (see module wx)

Types:

This = wxDC()

getTextExtent(This, String) -> {W::integer(), H::integer()}

Types:

This = wxDC()
String = chardata() (see module unicode)

getTextExtent(This, String, Option::[Option]) -> Result

Types:

Result = {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}
This = wxDC()
String = chardata() (see module unicode)
Option = {theFont, wxFont() (see module wxFont)}

getTextForeground(This) -> wx_colour4() (see module wx)

Types:

This = wxDC()

getUserScale(This) -> {X::number(), Y::number()}

Types:

This = wxDC()

gradientFillConcentric(This, Rect, InitialColour, DestColour) -> ok

Types:

This = wxDC()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}
InitialColour = wx_colour() (see module wx)
DestColour = wx_colour() (see module wx)

gradientFillConcentric(This, Rect, InitialColour, DestColour, CircleCenter) -> ok

Types:

This = wxDC()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}
InitialColour = wx_colour() (see module wx)
DestColour = wx_colour() (see module wx)
CircleCenter = {X::integer(), Y::integer()}

gradientFillLinear(This, Rect, InitialColour, DestColour) -> ok

Types:

This = wxDC()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}
InitialColour = wx_colour() (see module wx)
DestColour = wx_colour() (see module wx)

gradientFillLinear(This, Rect, InitialColour, DestColour, Option::[Option]) -> ok

Types:

This = wxDC()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}
InitialColour = wx_colour() (see module wx)
DestColour = wx_colour() (see module wx)
Option = {nDirection, wx_enum() (see module wx)}

See external documentation.
NDirection = ?wxLEFT | ?wxRIGHT | ?wxUP | ?wxDOWN | ?wxTOP | ?wxBOTTOM | ?wxNORTH | ?wxSOUTH | ?wxWEST | ?wxEAST | ?wxALL

logicalToDeviceX(This, X) -> integer()

Types:

This = wxDC()
X = integer()

logicalToDeviceXRel(This, X) -> integer()

Types:

This = wxDC()
X = integer()

logicalToDeviceY(This, Y) -> integer()

Types:

This = wxDC()
Y = integer()

logicalToDeviceYRel(This, Y) -> integer()

Types:

This = wxDC()
Y = integer()

maxX(This) -> integer()

Types:

This = wxDC()

maxY(This) -> integer()

Types:

This = wxDC()

minX(This) -> integer()

Types:

This = wxDC()

minY(This) -> integer()

Types:

This = wxDC()

isOk(This) -> boolean()

Types:

This = wxDC()

resetBoundingBox(This) -> ok

Types:

This = wxDC()

setAxisOrientation(This, XLeftRight, YBottomUp) -> ok

Types:

This = wxDC()
XLeftRight = boolean()
YBottomUp = boolean()

setBackground(This, Brush) -> ok

Types:

This = wxDC()
Brush = wxBrush() (see module wxBrush)

setBackgroundMode(This, Mode) -> ok

Types:

This = wxDC()
Mode = integer()

setBrush(This, Brush) -> ok

Types:

This = wxDC()
Brush = wxBrush() (see module wxBrush)

setClippingRegion(This, Region) -> ok

Types:

This = wxDC()
Region = wxRegion() (see module wxRegion)

See external documentation.
Also:
setClippingRegion(This, Rect) -> ok when
This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.

setClippingRegion(This, Pt, Sz) -> ok

Types:

This = wxDC()
Pt = {X::integer(), Y::integer()}
Sz = {W::integer(), H::integer()}

setDeviceOrigin(This, X, Y) -> ok

Types:

This = wxDC()
X = integer()
Y = integer()

setFont(This, Font) -> ok

Types:

This = wxDC()
Font = wxFont() (see module wxFont)

setLayoutDirection(This, Dir) -> ok

Types:

This = wxDC()
Dir = wx_enum() (see module wx)

See external documentation.
Dir = ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft

setLogicalFunction(This, Function) -> ok

Types:

This = wxDC()
Function = wx_enum() (see module wx)

See external documentation.
Function = integer

setMapMode(This, Mode) -> ok

Types:

This = wxDC()
Mode = wx_enum() (see module wx)

See external documentation.
Mode = integer

setPalette(This, Palette) -> ok

Types:

This = wxDC()
Palette = wxPalette() (see module wxPalette)

setPen(This, Pen) -> ok

Types:

This = wxDC()
Pen = wxPen() (see module wxPen)

setTextBackground(This, Colour) -> ok

Types:

This = wxDC()
Colour = wx_colour() (see module wx)

setTextForeground(This, Colour) -> ok

Types:

This = wxDC()
Colour = wx_colour() (see module wx)

setUserScale(This, X, Y) -> ok

Types:

This = wxDC()
X = number()
Y = number()

startDoc(This, Message) -> boolean()

Types:

This = wxDC()
Message = chardata() (see module unicode)

startPage(This) -> ok

Types:

This = wxDC()