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

wxErlang
Reference Manual
Version 1.7


Expand All
Contract All

Table of Contents

wxGraphicsContext

MODULE

wxGraphicsContext

MODULE SUMMARY

See external documentation: wxGraphicsContext.

DESCRIPTION

See external documentation: wxGraphicsContext.

This class is derived (and can use functions) from:
wxGraphicsObject

DATA TYPES

wxGraphicsContext()

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

create() -> wxGraphicsContext()

create(Dc) -> wxGraphicsContext()

Types:

Dc = wxWindowDC() (see module wxWindowDC) | wxWindow() (see module wxWindow)

createPen(This, Pen) -> wxGraphicsPen() (see module wxGraphicsPen)

Types:

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

createBrush(This, Brush) -> wxGraphicsBrush() (see module wxGraphicsBrush)

Types:

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

createRadialGradientBrush(This, Xo, Yo, Xc, Yc, Radius, OColor, CColor) -> wxGraphicsBrush() (see module wxGraphicsBrush)

Types:

This = wxGraphicsContext()
Xo = number()
Yo = number()
Xc = number()
Yc = number()
Radius = number()
OColor = wx_colour() (see module wx)
CColor = wx_colour() (see module wx)

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

See external documentation.

createLinearGradientBrush(This, X1, Y1, X2, Y2, C1, C2) -> wxGraphicsBrush() (see module wxGraphicsBrush)

Types:

This = wxGraphicsContext()
X1 = number()
Y1 = number()
X2 = number()
Y2 = number()
C1 = wx_colour() (see module wx)
C2 = wx_colour() (see module wx)

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

See external documentation.

createFont(This, Font) -> wxGraphicsFont() (see module wxGraphicsFont)

Types:

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

createFont(This, Font, Options::[Option]) -> wxGraphicsFont() (see module wxGraphicsFont)

Types:

This = wxGraphicsContext()
Font = wxFont() (see module wxFont)
Option = {col, wx_colour() (see module wx)}

createMatrix(This) -> wxGraphicsMatrix() (see module wxGraphicsMatrix)

Types:

This = wxGraphicsContext()

Equivalent to createMatrix(This, []).

createMatrix(This, Options::[Option]) -> wxGraphicsMatrix() (see module wxGraphicsMatrix)

Types:

This = wxGraphicsContext()
Option = {a, number()} | {b, number()} | {c, number()} | {d, number()} | {tx, number()} | {ty, number()}

createPath(This) -> wxGraphicsPath() (see module wxGraphicsPath)

Types:

This = wxGraphicsContext()

clip(This, Region) -> ok

Types:

This = wxGraphicsContext()
Region = wxRegion() (see module wxRegion)

clip(This, X, Y, W, H) -> ok

Types:

This = wxGraphicsContext()
X = number()
Y = number()
W = number()
H = number()

resetClip(This) -> ok

Types:

This = wxGraphicsContext()

drawBitmap(This, Bmp, X, Y, W, H) -> ok

Types:

This = wxGraphicsContext()
Bmp = wxBitmap() (see module wxBitmap)
X = number()
Y = number()
W = number()
H = number()

drawEllipse(This, X, Y, W, H) -> ok

Types:

This = wxGraphicsContext()
X = number()
Y = number()
W = number()
H = number()

drawIcon(This, Icon, X, Y, W, H) -> ok

Types:

This = wxGraphicsContext()
Icon = wxIcon() (see module wxIcon)
X = number()
Y = number()
W = number()
H = number()

drawLines(This, Points) -> ok

Types:

This = wxGraphicsContext()
Points = [{X::float(), Y::float()}]

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

Types:

This = wxGraphicsContext()
Points = [{X::float(), Y::float()}]
Option = {fillStyle, wx_enum() (see module wx)}

See external documentation.
FillStyle = integer

drawPath(This, Path) -> ok

Types:

This = wxGraphicsContext()
Path = wxGraphicsPath() (see module wxGraphicsPath)

Equivalent to drawPath(This, Path, []).

drawPath(This, Path, Options::[Option]) -> ok

Types:

This = wxGraphicsContext()
Path = wxGraphicsPath() (see module wxGraphicsPath)
Option = {fillStyle, wx_enum() (see module wx)}

See external documentation.
FillStyle = integer

drawRectangle(This, X, Y, W, H) -> ok

Types:

This = wxGraphicsContext()
X = number()
Y = number()
W = number()
H = number()

drawRoundedRectangle(This, X, Y, W, H, Radius) -> ok

Types:

This = wxGraphicsContext()
X = number()
Y = number()
W = number()
H = number()
Radius = number()

drawText(This, Str, X, Y) -> ok

Types:

This = wxGraphicsContext()
Str = chardata() (see module unicode)
X = number()
Y = number()

drawText(This, Str, X, Y, Angle) -> ok

Types:

This = wxGraphicsContext()
Str = chardata() (see module unicode)
X = number()
Y = number()
Angle = number()

See external documentation.
Also:
drawText(This, Str, X, Y, BackgroundBrush) -> 'ok' when
This::wxGraphicsContext(), Str::unicode:chardata(), X::number(), Y::number(), BackgroundBrush::wxGraphicsBrush:wxGraphicsBrush().

drawText(This, Str, X, Y, Angle, BackgroundBrush) -> ok

Types:

This = wxGraphicsContext()
Str = chardata() (see module unicode)
X = number()
Y = number()
Angle = number()
BackgroundBrush = wxGraphicsBrush() (see module wxGraphicsBrush)

fillPath(This, Path) -> ok

Types:

This = wxGraphicsContext()
Path = wxGraphicsPath() (see module wxGraphicsPath)

Equivalent to fillPath(This, Path, []).

fillPath(This, Path, Options::[Option]) -> ok

Types:

This = wxGraphicsContext()
Path = wxGraphicsPath() (see module wxGraphicsPath)
Option = {fillStyle, wx_enum() (see module wx)}

See external documentation.
FillStyle = integer

strokePath(This, Path) -> ok

Types:

This = wxGraphicsContext()
Path = wxGraphicsPath() (see module wxGraphicsPath)

getPartialTextExtents(This, Text) -> [number()]

Types:

This = wxGraphicsContext()
Text = chardata() (see module unicode)

getTextExtent(This, Text) -> Result

Types:

Result = {Width::number(), Height::number(), Descent::number(), ExternalLeading::number()}
This = wxGraphicsContext()
Text = chardata() (see module unicode)

rotate(This, Angle) -> ok

Types:

This = wxGraphicsContext()
Angle = number()

scale(This, XScale, YScale) -> ok

Types:

This = wxGraphicsContext()
XScale = number()
YScale = number()

translate(This, Dx, Dy) -> ok

Types:

This = wxGraphicsContext()
Dx = number()
Dy = number()

getTransform(This) -> wxGraphicsMatrix() (see module wxGraphicsMatrix)

Types:

This = wxGraphicsContext()

setTransform(This, Matrix) -> ok

Types:

This = wxGraphicsContext()
Matrix = wxGraphicsMatrix() (see module wxGraphicsMatrix)

concatTransform(This, Matrix) -> ok

Types:

This = wxGraphicsContext()
Matrix = wxGraphicsMatrix() (see module wxGraphicsMatrix)

setBrush(This, Brush) -> ok

Types:

This = wxGraphicsContext()
Brush = wxGraphicsBrush() (see module wxGraphicsBrush) | wxBrush() (see module wxBrush)

setFont(This, Font) -> ok

Types:

This = wxGraphicsContext()
Font = wxGraphicsFont() (see module wxGraphicsFont)

setFont(This, Font, Colour) -> ok

Types:

This = wxGraphicsContext()
Font = wxFont() (see module wxFont)
Colour = wx_colour() (see module wx)

setPen(This, Pen) -> ok

Types:

This = wxGraphicsContext()
Pen = wxPen() (see module wxPen) | wxGraphicsPen() (see module wxGraphicsPen)

strokeLine(This, X1, Y1, X2, Y2) -> ok

Types:

This = wxGraphicsContext()
X1 = number()
Y1 = number()
X2 = number()
Y2 = number()

strokeLines(This, Points) -> ok

Types:

This = wxGraphicsContext()
Points = [{X::float(), Y::float()}]

destroy(This::wxGraphicsContext()) -> ok

Destroys this object, do not use object again