wxDC.3erl

Langue: en

Autres versions - même langue

Version: 292574 (debian - 07/07/09)

Section: 3 (Bibliothèques de fonctions)

NAME

wxDC - See external documentation: wxDC.

DESCRIPTION

See external documentation: wxDC <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html>.

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 <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcblit>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdccalcboundingbox>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcclear>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdccomputescaleandorigin>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdccrosshair>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdestroyclippingregion>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdevicetologicalx>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdevicetologicalxrel>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdevicetologicaly>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdevicetologicalyrel>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawarc>.

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 <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawbitmap>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawcheckmark>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawcircle>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawellipse>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawellipse>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawellipticarc>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawicon>.

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 <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawlabel>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawline>.

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 <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawlines>.

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 <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawpolygon>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawpoint>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawrectangle>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawrectangle>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawrotatedtext>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawroundedrectangle>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawroundedrectangle>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcdrawtext>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcenddoc>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcendpage>.

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 <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcfloodfill>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetbackground>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetbackgroundmode>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetbrush>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetcharheight>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetcharwidth>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetclippingbox>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetfont>.

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

Types
WxLayoutDirection = integer()

See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetlayoutdirection>.

 WxLayoutDirection is one of ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetlogicalfunction>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetmapmode>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetmultilinetextextent>.

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

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

See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetmultilinetextextent>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetpartialtextextents>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetpen>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetpixel>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetppi>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetsize>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetsizemm>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgettextbackground>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgettextextent>.

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 <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgettextextent>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgettextforeground>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgetuserscale>.

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 <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgradientfillconcentric>.

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 <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgradientfillconcentric>.

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

See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcgradientfilllinear>.

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

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdclogicaltodevicex>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdclogicaltodevicexrel>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdclogicaltodevicey>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdclogicaltodeviceyrel>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcmaxx>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcmaxy>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcminx>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcminy>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcisok>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcresetboundingbox>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetaxisorientation>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetbackground>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetbackgroundmode>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetbrush>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetclippingregion>.

 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 <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetclippingregion>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetdeviceorigin>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetfont>.

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

Types
WxLayoutDirection = integer()

See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetlayoutdirection>.

 WxLayoutDirection is one of ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetlogicalfunction>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetmapmode>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetpalette>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetpen>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsettextbackground>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsettextforeground>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcsetuserscale>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcstartdoc>.

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


See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxdc.html#wxdcstartpage>.