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::wxDC(), DestPt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Source::wxDC(), SrcPt::{X::integer(), Y::integer()}) -> bool()

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

blit(This::wxDC(), DestPt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Source::wxDC(), SrcPt::{X::integer(), Y::integer()}, Options::[Option]) -> bool()

Types:

Option = {rop, integer()} | {useMask, bool()} | {srcPtMask, {X::integer(), Y::integer()}}

See external documentation.

calcBoundingBox(This::wxDC(), X::integer(), Y::integer()) -> ok

See external documentation.

clear(This::wxDC()) -> ok

See external documentation.

computeScaleAndOrigin(This::wxDC()) -> ok

See external documentation.

crossHair(This::wxDC(), Pt::{X::integer(), Y::integer()}) -> ok

See external documentation.

destroyClippingRegion(This::wxDC()) -> ok

See external documentation.

deviceToLogicalX(This::wxDC(), X::integer()) -> integer()

See external documentation.

deviceToLogicalXRel(This::wxDC(), X::integer()) -> integer()

See external documentation.

deviceToLogicalY(This::wxDC(), Y::integer()) -> integer()

See external documentation.

deviceToLogicalYRel(This::wxDC(), Y::integer()) -> integer()

See external documentation.

drawArc(This::wxDC(), Pt1::{X::integer(), Y::integer()}, Pt2::{X::integer(), Y::integer()}, Centre::{X::integer(), Y::integer()}) -> ok

See external documentation.

drawBitmap(This::wxDC(), Bmp::wxBitmap() (see module wxBitmap), Pt::{X::integer(), Y::integer()}) -> ok

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

drawBitmap(This::wxDC(), Bmp::wxBitmap() (see module wxBitmap), Pt::{X::integer(), Y::integer()}, Options::[Option]) -> ok

Types:

Option = {useMask, bool()}

See external documentation.

drawCheckMark(This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok

See external documentation.

drawCircle(This::wxDC(), Pt::{X::integer(), Y::integer()}, Radius::integer()) -> ok

See external documentation.

drawEllipse(This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok

See external documentation.

drawEllipse(This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}) -> ok

See external documentation.

drawEllipticArc(This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Sa::float(), Ea::float()) -> ok

See external documentation.

drawIcon(This::wxDC(), Icon::wxIcon() (see module wxIcon), Pt::{X::integer(), Y::integer()}) -> ok

See external documentation.

drawLabel(This::wxDC(), Text::string(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok

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

drawLabel(This::wxDC(), Text::string(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, Options::[Option]) -> ok

Types:

Option = {alignment, integer()} | {indexAccel, integer()}

See external documentation.

drawLine(This::wxDC(), Pt1::{X::integer(), Y::integer()}, Pt2::{X::integer(), Y::integer()}) -> ok

See external documentation.

drawLines(This::wxDC(), Points::[{X::integer(), Y::integer()}]) -> ok

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

drawLines(This::wxDC(), Points::[{X::integer(), Y::integer()}], Options::[Option]) -> ok

Types:

Option = {xoffset, integer()} | {yoffset, integer()}

See external documentation.

drawPolygon(This::wxDC(), Points::[{X::integer(), Y::integer()}]) -> ok

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

drawPolygon(This::wxDC(), Points::[{X::integer(), Y::integer()}], Options::[Option]) -> ok

Types:

Option = {xoffset, integer()} | {yoffset, integer()} | {fillStyle, integer()}

See external documentation.

drawPoint(This::wxDC(), Pt::{X::integer(), Y::integer()}) -> ok

See external documentation.

drawRectangle(This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok

See external documentation.

drawRectangle(This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}) -> ok

See external documentation.

drawRotatedText(This::wxDC(), Text::string(), Pt::{X::integer(), Y::integer()}, Angle::float()) -> ok

See external documentation.

drawRoundedRectangle(This::wxDC(), R::{X::integer(), Y::integer(), W::integer(), H::integer()}, Radius::float()) -> ok

See external documentation.

drawRoundedRectangle(This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Radius::float()) -> ok

See external documentation.

drawText(This::wxDC(), Text::string(), Pt::{X::integer(), Y::integer()}) -> ok

See external documentation.

endDoc(This::wxDC()) -> ok

See external documentation.

endPage(This::wxDC()) -> ok

See external documentation.

floodFill(This::wxDC(), Pt::{X::integer(), Y::integer()}, Col::colour() (see module wx)) -> bool()

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

floodFill(This::wxDC(), Pt::{X::integer(), Y::integer()}, Col::colour() (see module wx), Options::[Option]) -> bool()

Types:

Option = {style, integer()}

See external documentation.

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

See external documentation.

getBackgroundMode(This::wxDC()) -> integer()

See external documentation.

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

See external documentation.

getCharHeight(This::wxDC()) -> integer()

See external documentation.

getCharWidth(This::wxDC()) -> integer()

See external documentation.

getClippingBox(This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok

See external documentation.

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

See external documentation.

getLayoutDirection(This::wxDC()) -> WxLayoutDirection

Types:

WxLayoutDirection = integer()

See external documentation.
WxLayoutDirection is one of ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft

getLogicalFunction(This::wxDC()) -> integer()

See external documentation.

getMapMode(This::wxDC()) -> integer()

See external documentation.

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

See external documentation.

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

Types:

Option = {font, wxFont() (see module wxFont)}

See external documentation.

getPartialTextExtents(This::wxDC(), Text::string(), Widths::[integer()]) -> bool()

See external documentation.

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

See external documentation.

getPixel(This::wxDC(), Pt::{X::integer(), Y::integer()}, Col::colour() (see module wx)) -> bool()

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

getTextBackground(This::wxDC()) -> colour() (see module wx)

See external documentation.

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

See external documentation.

getTextExtent(This::wxDC(), String::string(), Options::[Option]) -> {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}

Types:

Option = {theFont, wxFont() (see module wxFont)}

See external documentation.

getTextForeground(This::wxDC()) -> colour() (see module wx)

See external documentation.

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

See external documentation.

gradientFillConcentric(This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::colour() (see module wx), DestColour::colour() (see module wx)) -> ok

See external documentation.

gradientFillConcentric(This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::colour() (see module wx), DestColour::colour() (see module wx), CircleCenter::{X::integer(), Y::integer()}) -> ok

See external documentation.

gradientFillLinear(This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::colour() (see module wx), DestColour::colour() (see module wx)) -> ok

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

gradientFillLinear(This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::colour() (see module wx), DestColour::colour() (see module wx), Options::[Option]) -> ok

Types:

Option = {nDirection, WxDirection}

WxDirection = integer()

logicalToDeviceX(This::wxDC(), X::integer()) -> integer()

See external documentation.

logicalToDeviceXRel(This::wxDC(), X::integer()) -> integer()

See external documentation.

logicalToDeviceY(This::wxDC(), Y::integer()) -> integer()

See external documentation.

logicalToDeviceYRel(This::wxDC(), Y::integer()) -> integer()

See external documentation.

maxX(This::wxDC()) -> integer()

See external documentation.

maxY(This::wxDC()) -> integer()

See external documentation.

minX(This::wxDC()) -> integer()

See external documentation.

minY(This::wxDC()) -> integer()

See external documentation.

isOk(This::wxDC()) -> bool()

See external documentation.

resetBoundingBox(This::wxDC()) -> ok

See external documentation.

setAxisOrientation(This::wxDC(), XLeftRight::bool(), YBottomUp::bool()) -> ok

See external documentation.

setBackground(This::wxDC(), Brush::wxBrush() (see module wxBrush)) -> ok

See external documentation.

setBackgroundMode(This::wxDC(), Mode::integer()) -> ok

See external documentation.

setBrush(This::wxDC(), Brush::wxBrush() (see module wxBrush)) -> ok

See external documentation.

setClippingRegion(This::wxDC(), X::term()) -> ok

See external documentation.
Alternatives:

setClippingRegion(This::wxDC(), Region::wxRegion:wxRegion()) -> ok

setClippingRegion(This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok

setClippingRegion(This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}) -> ok

See external documentation.

setDeviceOrigin(This::wxDC(), X::integer(), Y::integer()) -> ok

See external documentation.

setFont(This::wxDC(), Font::wxFont() (see module wxFont)) -> ok

See external documentation.

setLayoutDirection(This::wxDC(), Dir::WxLayoutDirection) -> ok

Types:

WxLayoutDirection = integer()

See external documentation.
WxLayoutDirection is one of ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft

setLogicalFunction(This::wxDC(), Function::integer()) -> ok

See external documentation.

setMapMode(This::wxDC(), Mode::integer()) -> ok

See external documentation.

setPalette(This::wxDC(), Palette::wxPalette() (see module wxPalette)) -> ok

See external documentation.

setPen(This::wxDC(), Pen::wxPen() (see module wxPen)) -> ok

See external documentation.

setTextBackground(This::wxDC(), Colour::colour() (see module wx)) -> ok

See external documentation.

setTextForeground(This::wxDC(), Colour::colour() (see module wx)) -> ok

See external documentation.

setUserScale(This::wxDC(), X::float(), Y::float()) -> ok

See external documentation.

startDoc(This::wxDC(), Message::string()) -> bool()

See external documentation.

startPage(This::wxDC()) -> ok

See external documentation.