wxDC

See external documentation: wxDC.

Types

wxDC() = wx:wx_object()

Functions

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

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

Equivalent to blit(This, DestPt, Sz, Source, SrcPt, []).

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

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

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

See external documentation.

clear(This) -> ok

This = wxDC()

See external documentation.

computeScaleAndOrigin(This) -> ok

This = wxDC()

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

See external documentation.

crossHair(This, Pt) -> ok

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

See external documentation.

destroyClippingRegion(This) -> ok

This = wxDC()

See external documentation.

deviceToLogicalX(This, X) -> integer()

This = wxDC()
X = integer()

See external documentation.

deviceToLogicalXRel(This, X) -> integer()

This = wxDC()
X = integer()

See external documentation.

deviceToLogicalY(This, Y) -> integer()

This = wxDC()
Y = integer()

See external documentation.

deviceToLogicalYRel(This, Y) -> integer()

This = wxDC()
Y = integer()

See external documentation.

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

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

See external documentation.

drawBitmap(This, Bmp, Pt) -> ok

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

Equivalent to drawBitmap(This, Bmp, Pt, []).

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

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

See external documentation.

drawCheckMark(This, Rect) -> ok

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

See external documentation.

drawCircle(This, Pt, Radius) -> ok

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

See external documentation.

drawEllipse(This, Rect) -> ok

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

See external documentation.

drawEllipse(This, Pt, Sz) -> ok

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

See external documentation.

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

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

See external documentation.

drawIcon(This, Icon, Pt) -> ok

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

See external documentation.

drawLabel(This, Text, Rect) -> ok

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

Equivalent to drawLabel(This, Text, Rect, []).

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

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

See external documentation.

drawLine(This, Pt1, Pt2) -> ok

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

See external documentation.

drawLines(This, Points) -> ok

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

Equivalent to drawLines(This, Points, []).

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

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

See external documentation.

drawPolygon(This, Points) -> ok

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

Equivalent to drawPolygon(This, Points, []).

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

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

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

See external documentation.

drawRectangle(This, Rect) -> ok

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

See external documentation.

drawRectangle(This, Pt, Sz) -> ok

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

See external documentation.

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

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

See external documentation.

drawRoundedRectangle(This, R, Radius) -> ok

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

See external documentation.

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

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

See external documentation.

drawText(This, Text, Pt) -> ok

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

See external documentation.

endDoc(This) -> ok

This = wxDC()

See external documentation.

endPage(This) -> ok

This = wxDC()

See external documentation.

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

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

Equivalent to floodFill(This, Pt, Col, []).

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

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)

This = wxDC()

See external documentation.

getBackgroundMode(This) -> integer()

This = wxDC()

See external documentation.

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

This = wxDC()

See external documentation.

getCharHeight(This) -> integer()

This = wxDC()

See external documentation.

getCharWidth(This) -> integer()

This = wxDC()

See external documentation.

getClippingBox(This) -> Result

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

See external documentation.

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

This = wxDC()

See external documentation.

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

This = wxDC()

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

getLogicalFunction(This) -> integer()

This = wxDC()

See external documentation.

getMapMode(This) -> integer()

This = wxDC()

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

getPartialTextExtents(This, Text) -> Result

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

See external documentation.

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

This = wxDC()

See external documentation.

getPixel(This, Pt) -> Result

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

See external documentation.

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

This = wxDC()

See external documentation.

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

This = wxDC()

See external documentation.

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

This = wxDC()

See external documentation.

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

This = wxDC()

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

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

This = wxDC()

See external documentation.

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

This = wxDC()

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

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

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

Equivalent to gradientFillLinear(This, Rect, InitialColour, DestColour, []).

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

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

logicalToDeviceX(This, X) -> integer()

This = wxDC()
X = integer()

See external documentation.

logicalToDeviceXRel(This, X) -> integer()

This = wxDC()
X = integer()

See external documentation.

logicalToDeviceY(This, Y) -> integer()

This = wxDC()
Y = integer()

See external documentation.

logicalToDeviceYRel(This, Y) -> integer()

This = wxDC()
Y = integer()

See external documentation.

maxX(This) -> integer()

This = wxDC()

See external documentation.

maxY(This) -> integer()

This = wxDC()

See external documentation.

minX(This) -> integer()

This = wxDC()

See external documentation.

minY(This) -> integer()

This = wxDC()

See external documentation.

isOk(This) -> boolean()

This = wxDC()

See external documentation.

resetBoundingBox(This) -> ok

This = wxDC()

See external documentation.

setAxisOrientation(This, XLeftRight, YBottomUp) -> ok

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

See external documentation.

setBackground(This, Brush) -> ok

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

See external documentation.

setBackgroundMode(This, Mode) -> ok

This = wxDC()
Mode = integer()

See external documentation.

setBrush(This, Brush) -> ok

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

See external documentation.

setClippingRegion(This, Region) -> ok

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

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

See external documentation.

setDeviceOrigin(This, X, Y) -> ok

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

See external documentation.

setFont(This, Font) -> ok

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

See external documentation.

setLayoutDirection(This, Dir) -> ok

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

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

setLogicalFunction(This, Function) -> ok

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

See external documentation.
Function = integer

setMapMode(This, Mode) -> ok

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

See external documentation.
Mode = integer

setPalette(This, Palette) -> ok

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

See external documentation.

setPen(This, Pen) -> ok

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

See external documentation.

setTextBackground(This, Colour) -> ok

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

See external documentation.

setTextForeground(This, Colour) -> ok

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

See external documentation.

setUserScale(This, X, Y) -> ok

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

See external documentation.

startDoc(This, Message) -> boolean()

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

See external documentation.

startPage(This) -> ok

This = wxDC()

See external documentation.