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

wxErlang
Reference Manual
Version 0.99


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

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

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

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

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

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

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

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

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

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

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

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

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

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

Types:

Option = {useMask, bool()}

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

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

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

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

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

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

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

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

Types:

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

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

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

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

Types:

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

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

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

Types:

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

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

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

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

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

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

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

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

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

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

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

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

Types:

Option = {style, integer()}

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

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

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

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

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

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

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

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

Types:

WxLayoutDirection = integer()

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

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

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

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

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

Types:

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

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

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

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

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

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

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

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

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

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

Types:

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

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

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

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

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

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

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

See external documentation.
WxDirection is one of ?wxLEFT | ?wxRIGHT | ?wxUP | ?wxDOWN | ?wxTOP | ?wxBOTTOM | ?wxNORTH | ?wxSOUTH | ?wxWEST | ?wxEAST | ?wxALL

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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