wxDC(3)

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

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

blit(This, DestPt, Sz, Source, SrcPt, Options::[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:wx_enum()} | {useMask, boolean()} | {srcPtMask, {X::integer(), Y::integer()}}

    See external documentation.
    Rop = integer

calcBoundingBox(This, X, Y) -> ok

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

    See external documentation.

clear(This) -> ok

    Types:
        This = wxDC()

    See external documentation.

computeScaleAndOrigin(This) -> ok

    Types:
        This = wxDC()

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

    See external documentation.

crossHair(This, Pt) -> ok

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

    See external documentation.

destroyClippingRegion(This) -> ok

    Types:
        This = wxDC()

    See external documentation.

deviceToLogicalX(This, X) -> integer()

    Types:
        This = wxDC()
        X = integer()

    See external documentation.

deviceToLogicalXRel(This, X) -> integer()

    Types:
        This = wxDC()
        X = integer()

    See external documentation.

deviceToLogicalY(This, Y) -> integer()

    Types:
        This = wxDC()
        Y = integer()

    See external documentation.

deviceToLogicalYRel(This, Y) -> integer()

    Types:
        This = wxDC()
        Y = integer()

    See external documentation.

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

    Types:
        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

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

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

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

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

    See external documentation.

drawCheckMark(This, Rect) -> ok

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

    See external documentation.

drawCircle(This, Pt, Radius) -> ok

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

    See external documentation.

drawEllipse(This, Rect) -> ok

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

    See external documentation.

drawEllipse(This, Pt, Sz) -> ok

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

    See external documentation.

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

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

    See external documentation.

drawIcon(This, Icon, Pt) -> ok

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

    See external documentation.

drawLabel(This, Text, Rect) -> ok

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

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

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

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

    See external documentation.

drawLine(This, Pt1, Pt2) -> ok

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

    See external documentation.

drawLines(This, Points) -> ok

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

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

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

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

    See external documentation.

drawPolygon(This, Points) -> ok

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

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

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

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

    See external documentation.
    FillStyle = integer

drawPoint(This, Pt) -> ok

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

    See external documentation.

drawRectangle(This, Rect) -> ok

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

    See external documentation.

drawRectangle(This, Pt, Sz) -> ok

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

    See external documentation.

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

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

    See external documentation.

drawRoundedRectangle(This, R, Radius) -> ok

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

    See external documentation.

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

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

    See external documentation.

drawText(This, Text, Pt) -> ok

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

    See external documentation.

endDoc(This) -> ok

    Types:
        This = wxDC()

    See external documentation.

endPage(This) -> ok

    Types:
        This = wxDC()

    See external documentation.

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

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

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

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

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

    See external documentation.
    Style = integer

getBackground(This) -> wxBrush:wxBrush()

    Types:
        This = wxDC()

    See external documentation.

getBackgroundMode(This) -> integer()

    Types:
        This = wxDC()

    See external documentation.

getBrush(This) -> wxBrush:wxBrush()

    Types:
        This = wxDC()

    See external documentation.

getCharHeight(This) -> integer()

    Types:
        This = wxDC()

    See external documentation.

getCharWidth(This) -> integer()

    Types:
        This = wxDC()

    See external documentation.

getClippingBox(This) -> Result

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

    See external documentation.

getFont(This) -> wxFont:wxFont()

    Types:
        This = wxDC()

    See external documentation.

getLayoutDirection(This) -> wx:wx_enum()

    Types:
        This = wxDC()

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

getLogicalFunction(This) -> integer()

    Types:
        This = wxDC()

    See external documentation.

getMapMode(This) -> integer()

    Types:
        This = wxDC()

    See external documentation.

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

    Types:
        This = wxDC()
        String = unicode:chardata()

    See external documentation.

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

    Types:
        This = wxDC()
        String = unicode:chardata()
        Option = {font, wxFont:wxFont()}

    See external documentation.

getPartialTextExtents(This, Text) -> Result

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

    See external documentation.

getPen(This) -> wxPen:wxPen()

    Types:
        This = wxDC()

    See external documentation.

getPixel(This, Pt) -> Result

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

    See external documentation.

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

    Types:
        This = wxDC()

    See external documentation.

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

    Types:
        This = wxDC()

    See external documentation.

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

    Types:
        This = wxDC()

    See external documentation.

getTextBackground(This) -> wx:wx_colour4()

    Types:
        This = wxDC()

    See external documentation.

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

    Types:
        This = wxDC()
        String = unicode:chardata()

    See external documentation.

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

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

    See external documentation.

getTextForeground(This) -> wx:wx_colour4()

    Types:
        This = wxDC()

    See external documentation.

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

    Types:
        This = wxDC()

    See external documentation.

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

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

    See external documentation.

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

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

    See external documentation.

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

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

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

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

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

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

logicalToDeviceX(This, X) -> integer()

    Types:
        This = wxDC()
        X = integer()

    See external documentation.

logicalToDeviceXRel(This, X) -> integer()

    Types:
        This = wxDC()
        X = integer()

    See external documentation.

logicalToDeviceY(This, Y) -> integer()

    Types:
        This = wxDC()
        Y = integer()

    See external documentation.

logicalToDeviceYRel(This, Y) -> integer()

    Types:
        This = wxDC()
        Y = integer()

    See external documentation.

maxX(This) -> integer()

    Types:
        This = wxDC()

    See external documentation.

maxY(This) -> integer()

    Types:
        This = wxDC()

    See external documentation.

minX(This) -> integer()

    Types:
        This = wxDC()

    See external documentation.

minY(This) -> integer()

    Types:
        This = wxDC()

    See external documentation.

isOk(This) -> boolean()

    Types:
        This = wxDC()

    See external documentation.

resetBoundingBox(This) -> ok

    Types:
        This = wxDC()

    See external documentation.

setAxisOrientation(This, XLeftRight, YBottomUp) -> ok

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

    See external documentation.

setBackground(This, Brush) -> ok

    Types:
        This = wxDC()
        Brush = wxBrush:wxBrush()

    See external documentation.

setBackgroundMode(This, Mode) -> ok

    Types:
        This = wxDC()
        Mode = integer()

    See external documentation.

setBrush(This, Brush) -> ok

    Types:
        This = wxDC()
        Brush = wxBrush:wxBrush()

    See external documentation.

setClippingRegion(This, Region) -> ok
setClippingRegion(This, Rect) -> ok

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

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

    See external documentation.

setDeviceOrigin(This, X, Y) -> ok

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

    See external documentation.

setFont(This, Font) -> ok

    Types:
        This = wxDC()
        Font = wxFont:wxFont()

    See external documentation.

setLayoutDirection(This, Dir) -> ok

    Types:
        This = wxDC()
        Dir = wx:wx_enum()

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

setLogicalFunction(This, Function) -> ok

    Types:
        This = wxDC()
        Function = wx:wx_enum()

    See external documentation.
    Function = integer

setMapMode(This, Mode) -> ok

    Types:
        This = wxDC()
        Mode = wx:wx_enum()

    See external documentation.
    Mode = integer

setPalette(This, Palette) -> ok

    Types:
        This = wxDC()
        Palette = wxPalette:wxPalette()

    See external documentation.

setPen(This, Pen) -> ok

    Types:
        This = wxDC()
        Pen = wxPen:wxPen()

    See external documentation.

setTextBackground(This, Colour) -> ok

    Types:
        This = wxDC()
        Colour = wx:wx_colour()

    See external documentation.

setTextForeground(This, Colour) -> ok

    Types:
        This = wxDC()
        Colour = wx:wx_colour()

    See external documentation.

setUserScale(This, X, Y) -> ok

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

    See external documentation.

startDoc(This, Message) -> boolean()

    Types:
        This = wxDC()
        Message = unicode:chardata()

    See external documentation.

startPage(This) -> ok

    Types:
        This = wxDC()

    See external documentation.

AUTHORS

<>