wxDC

Implements methods from the following classes

• wxObject

Methods

• StartPage
  Starts a document page (only relevant when outputting to a printer).
• StartDoc
  Starts a document (only relevant when outputting to a printer).
• SetUserScale
  Sets the user scaling factor, useful for applications which require 'zooming'.
• SetTextForeground
  Sets the current text foreground colour for the DC.
• SetTextBackground
  Sets the current text background colour for the DC.
• CalcBoundingBox
  Adds the specified point to the bounding box which can be retrieved with MinX(), MaxX() and MinY(), MaxY() functions.
• CanUseTransformMatrix
  Check if the use of transformation matrix is supported by the current system.
• Clear
  Clears the device context using the current background brush.
• CopyAttributes
  Copy attributes from another DC.
• CrossHair
  Displays a cross hair using the current pen.
• DestroyClippingRegion
  Destroys the current clipping region so that none of the DC is clipped.
• DeviceToLogicalX
  Convert device X coordinate to logical coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
• DeviceToLogicalXRel
  Convert device X coordinate to relative logical coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
• DeviceToLogicalY
  Converts device Y coordinate to logical coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
• DeviceToLogicalYRel
  Convert device Y coordinate to relative logical coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
• DrawArc
  Draws an arc of a circle, centred on (xc, yc), with starting point (xStart, yStart) and ending at (xEnd, yEnd).
• DrawBitmap
  Draw a bitmap on the device context at the specified point.
• DrawCheckMark
  Draws a check mark inside the given rectangle.
• DrawCircle
  Draws a circle with the given centre and radius.
• DrawEllipse
  Draws an ellipse contained in the rectangle specified either with the given top left corner and the given size or directly.
• DrawEllipticArc
  Draws an arc of an ellipse.
• DrawIcon
  Draw an icon on the display (does nothing if the device context is PostScript).
• DrawLabel
  Draw optional bitmap and the text into the given rectangle and aligns it as specified by alignment parameter; it also will emphasize the character with the given index if it is != -1 and return the bounding rectangle if required.
• DrawLine
  Draws a line from the first point to the second.
• DrawPoint
  Draws a point using the color of the current pen.
• DrawRectangle
  Draws a rectangle with the given top left corner, and with the given size.
• DrawRotatedText
  Draws the text rotated by angle degrees (positive angles are counterclockwise; the full angle is 360 degrees).
• DrawRoundedRectangle
  Draws a rectangle with the given top left corner, and with the given size.
• DrawSpline
  This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
• DrawText
  Draws a text string at the specified point, using the current text font, and the current text foreground and background colours.
• EndDoc
  Ends a document (only relevant when outputting to a printer).
• EndPage
  Ends a document page (only relevant when outputting to a printer).
• FloodFill
  Flood fills the device context starting from the given point, using the current brush colour, and using a style:
• GetBackground
  Gets the brush used for painting the background.
• GetBackgroundMode
  Returns the current background mode: wxSOLID or wxTRANSPARENT.
• GetBrush
  Gets the current brush.
• GetCharHeight
  Gets the character height of the currently set font.
• GetCharWidth
  Gets the average character width of the currently set font.
• GetClippingBox
  Gets the rectangle surrounding the current clipping region.
• GetDepth
  Returns the depth (number of bits/pixel) of this DC.
• GetDeviceOrigin
  Returns the current device origin.
• GetFont
  Gets the current font.
• GetLayoutDirection
  Gets the current layout direction of the device context.
• GetLogicalFunction
  Gets the current logical function.
• GetLogicalOrigin
• GetLogicalScale
• GetMapMode
  Gets the current mapping mode for the device context.
• GetMultiLineTextExtent
  Gets the dimensions of the string using the currently selected font.
• GetPPI
  Returns the resolution of the device in pixels per inch.
• GetPen
  Gets the current pen.
• GetPixel
  Gets in colour the colour at the specified location.
• GetSize
  Gets the horizontal and vertical extent of this device context in device units.
• GetSizeMM
  Returns the horizontal and vertical resolution in millimetres.
• GetTextBackground
  Gets the current text background colour.
• GetTextExtent
  Gets the dimensions of the string using the currently selected font.
• GetTextForeground
  Gets the current text foreground colour.
• GetUserScale
  Gets the current user scale factor.
• GradientFillConcentric
  Fill the area specified by rect with a radial gradient, starting from initialColour at the centre of the circle and fading to destColour on the circle outside.
• GradientFillLinear
  Fill the area specified by rect with a linear gradient, starting from initialColour and eventually fading to destColour.
• IsOk
  Returns true if the DC is ok to use.
• LogicalToDeviceX
  Converts logical X coordinate to device coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
• LogicalToDeviceY
  Converts logical Y coordinate to device coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
• LogicalToDeviceXRel
  Converts logical X coordinate to relative device coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
• LogicalToDeviceYRel
  Converts logical Y coordinate to relative device coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
• MaxX
  Gets the maximum horizontal extent used in drawing commands so far.
• MaxY
  Gets the maximum vertical extent used in drawing commands so far.
• MinX
  Gets the minimum horizontal extent used in drawing commands so far.
• MinY
  Gets the minimum vertical extent used in drawing commands so far.
• ResetBoundingBox
  Resets the bounding box: after a call to this function, the bounding box doesn't contain anything.
• ResetTransformMatrix
  Revert the transformation matrix to identity matrix.
• SetAxisOrientation
  Sets the x and y axis orientation (i.e., the direction from lowest to highest values on the axis).
• SetBackground
  Sets the current background brush for the DC.
• SetBackgroundMode
  mode may be one of wxSOLID and wxTRANSPARENT.
• SetBrush
  Sets the current brush for the DC.
• SetClippingRegion
  Sets the clipping region for this device context to the intersection of the given region described by the parameters of this method and the previously set clipping region.
• SetDeviceClippingRegion
  Sets the clipping region for this device context.
• SetDeviceOrigin
  Sets the device origin (i.e., the origin in pixels after scaling has been applied).
• SetFont
  Sets the current font for the DC.
• SetLayoutDirection
  Sets the current layout direction for the device context.
• SetLogicalFunction
  Sets the current logical function for the device context.
• SetLogicalOrigin
• SetLogicalScale
• SetMapMode
  The mapping mode of the device context defines the unit of measurement used to convert logical units to device units.
• SetPalette
  If this is a window DC or memory DC, assigns the given palette to the window or bitmap associated with the DC.
• SetPen
  Sets the current pen for the DC.
• StretchBlit
  Copy from a source DC to this DC possibly changing the scale.
• Blit
  Copy from a source DC to this DC.

Static Methods

StartPage

StartPage ( )

Starts a document page (only relevant when outputting to a printer).

StartDoc

bool StartDoc ( string $message )

Starts a document (only relevant when outputting to a printer).

SetUserScale

SetUserScale ( float $xScale, float $yScale )

Sets the user scaling factor, useful for applications which require 'zooming'.

SetTextForeground

SetTextForeground ( wxColour $colour )

Sets the current text foreground colour for the DC.

SetTextBackground

SetTextBackground ( wxColour $colour )

Sets the current text background colour for the DC.

CalcBoundingBox

CalcBoundingBox ( integer $x, integer $y )

Adds the specified point to the bounding box which can be retrieved with MinX(), MaxX() and MinY(), MaxY() functions.

CanUseTransformMatrix

bool CanUseTransformMatrix ( )

Check if the use of transformation matrix is supported by the current system.

Clear

Clear ( )

Clears the device context using the current background brush.

CopyAttributes

CopyAttributes ( wxDC $dc )

Copy attributes from another DC.

CrossHair

CrossHair ( integer $x, integer $y )

Displays a cross hair using the current pen.
CrossHair ( wxPoint $pt )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DestroyClippingRegion

DestroyClippingRegion ( )

Destroys the current clipping region so that none of the DC is clipped.

DeviceToLogicalX

integer DeviceToLogicalX ( integer $x )

Convert device X coordinate to logical coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.

DeviceToLogicalXRel

integer DeviceToLogicalXRel ( integer $x )

Convert device X coordinate to relative logical coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.

DeviceToLogicalY

integer DeviceToLogicalY ( integer $y )

Converts device Y coordinate to logical coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.

DeviceToLogicalYRel

integer DeviceToLogicalYRel ( integer $y )

Convert device Y coordinate to relative logical coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.

DrawArc

DrawArc ( integer $xStart, integer $yStart, integer $xEnd, integer $yEnd, integer $xc, integer $yc )

Draws an arc of a circle, centred on (xc, yc), with starting point (xStart, yStart) and ending at (xEnd, yEnd).
DrawArc ( wxPoint $ptStart, wxPoint $ptEnd, wxPoint $centre )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawBitmap

DrawBitmap ( wxBitmap $bitmap, integer $x, integer $y, bool $useMask=false )

Draw a bitmap on the device context at the specified point.
DrawBitmap ( wxBitmap $bmp, wxPoint $pt, bool $useMask=false )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawCheckMark

DrawCheckMark ( integer $x, integer $y, integer $width, integer $height )

Draws a check mark inside the given rectangle.
DrawCheckMark ( wxRect $rect )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawCircle

DrawCircle ( integer $x, integer $y, integer $radius )

Draws a circle with the given centre and radius.
DrawCircle ( wxPoint $pt, integer $radius )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawEllipse

DrawEllipse ( integer $x, integer $y, integer $width, integer $height )

Draws an ellipse contained in the rectangle specified either with the given top left corner and the given size or directly.
DrawEllipse ( wxPoint $pt, wxSize $size )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
DrawEllipse ( wxRect $rect )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawEllipticArc

DrawEllipticArc ( integer $x, integer $y, integer $width, integer $height, float $start, float $end )

Draws an arc of an ellipse.
DrawEllipticArc ( wxPoint $pt, wxSize $sz, float $sa, float $ea )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawIcon

DrawIcon ( wxIcon $icon, integer $x, integer $y )

Draw an icon on the display (does nothing if the device context is PostScript).
DrawIcon ( wxIcon $icon, wxPoint $pt )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawLabel

DrawLabel ( string $text, wxBitmap $bitmap, wxRect $rect, integer $alignment=wxALIGN_LEFT|wxALIGN_TOP, integer $indexAccel=-1, wxRect &$rectBounding=NULL )

Draw optional bitmap and the text into the given rectangle and aligns it as specified by alignment parameter; it also will emphasize the character with the given index if it is != -1 and return the bounding rectangle if required.
DrawLabel ( string $text, wxRect $rect, integer $alignment=wxALIGN_LEFT|wxALIGN_TOP, integer $indexAccel=-1 )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawLine

DrawLine ( integer $x1, integer $y1, integer $x2, integer $y2 )

Draws a line from the first point to the second.
DrawLine ( wxPoint $pt1, wxPoint $pt2 )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawPoint

DrawPoint ( integer $x, integer $y )

Draws a point using the color of the current pen.
DrawPoint ( wxPoint $pt )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawRectangle

DrawRectangle ( integer $x, integer $y, integer $width, integer $height )

Draws a rectangle with the given top left corner, and with the given size.
DrawRectangle ( wxPoint $pt, wxSize $sz )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
DrawRectangle ( wxRect $rect )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawRotatedText

DrawRotatedText ( string $text, integer $x, integer $y, float $angle )

Draws the text rotated by angle degrees (positive angles are counterclockwise; the full angle is 360 degrees).
DrawRotatedText ( string $text, wxPoint $point, float $angle )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawRoundedRectangle

DrawRoundedRectangle ( integer $x, integer $y, integer $width, integer $height, float $radius )

Draws a rectangle with the given top left corner, and with the given size.
DrawRoundedRectangle ( wxPoint $pt, wxSize $sz, float $radius )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
DrawRoundedRectangle ( wxRect $rect, float $radius )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawSpline

DrawSpline ( integer $x1, integer $y1, integer $x2, integer $y2, integer $x3, integer $y3 )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DrawText

DrawText ( string $text, integer $x, integer $y )

Draws a text string at the specified point, using the current text font, and the current text foreground and background colours.
DrawText ( string $text, wxPoint $pt )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

EndDoc

EndDoc ( )

Ends a document (only relevant when outputting to a printer).

EndPage

EndPage ( )

Ends a document page (only relevant when outputting to a printer).

FloodFill

bool FloodFill ( integer $x, integer $y, wxColour $colour, wxFloodFillStyle $style=wxFLOOD_SURFACE )

Flood fills the device context starting from the given point, using the current brush colour, and using a style:
bool FloodFill ( wxPoint $pt, wxColour $col, wxFloodFillStyle $style=wxFLOOD_SURFACE )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

GetBackground

wxBrush GetBackground ( )

Gets the brush used for painting the background.

GetBackgroundMode

integer GetBackgroundMode ( )

Returns the current background mode: wxSOLID or wxTRANSPARENT.

GetBrush

wxBrush GetBrush ( )

Gets the current brush.

GetCharHeight

integer GetCharHeight ( )

Gets the character height of the currently set font.

GetCharWidth

integer GetCharWidth ( )

Gets the average character width of the currently set font.

GetClippingBox

GetClippingBox ( integer $x, integer $y, integer $width, integer $height )

Gets the rectangle surrounding the current clipping region.

GetDepth

integer GetDepth ( )

Returns the depth (number of bits/pixel) of this DC.

GetDeviceOrigin

wxPoint GetDeviceOrigin ( )

Returns the current device origin.

GetFont

wxFont GetFont ( )

Gets the current font.

GetLayoutDirection

wxLayoutDirection GetLayoutDirection ( )

Gets the current layout direction of the device context.

GetLogicalFunction

wxRasterOperationMode GetLogicalFunction ( )

Gets the current logical function.

GetLogicalOrigin

GetLogicalOrigin ( integer $x, integer $y )
wxPoint GetLogicalOrigin ( )

GetLogicalScale

GetLogicalScale ( float &$x, float &$y )

GetMapMode

wxMappingMode GetMapMode ( )

Gets the current mapping mode for the device context.

GetMultiLineTextExtent

GetMultiLineTextExtent ( string $string, integer $w, integer $h, integer $heightLine=NULL, wxFont $font=NULL )

Gets the dimensions of the string using the currently selected font.
wxSize GetMultiLineTextExtent ( string $string )

Gets the dimensions of the string using the currently selected font.

GetPPI

wxSize GetPPI ( )

Returns the resolution of the device in pixels per inch.

GetPen

wxPen GetPen ( )

Gets the current pen.

GetPixel

bool GetPixel ( integer $x, integer $y, wxColour &$colour )

Gets in colour the colour at the specified location.

GetSize

GetSize ( integer $width, integer $height )

Gets the horizontal and vertical extent of this device context in device units.
wxSize GetSize ( )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

GetSizeMM

GetSizeMM ( integer $width, integer $height )

Returns the horizontal and vertical resolution in millimetres.
wxSize GetSizeMM ( )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

GetTextBackground

wxColour GetTextBackground ( )

Gets the current text background colour.

GetTextExtent

GetTextExtent ( string $string, integer $w, integer $h, integer $descent=NULL, integer $externalLeading=NULL, wxFont $font=NULL )

Gets the dimensions of the string using the currently selected font.
wxSize GetTextExtent ( string $string )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

GetTextForeground

wxColour GetTextForeground ( )

Gets the current text foreground colour.

GetUserScale

GetUserScale ( float &$x, float &$y )

Gets the current user scale factor.

GradientFillConcentric

GradientFillConcentric ( wxRect $rect, wxColour $initialColour, wxColour $destColour )

Fill the area specified by rect with a radial gradient, starting from initialColour at the centre of the circle and fading to destColour on the circle outside.
GradientFillConcentric ( wxRect $rect, wxColour $initialColour, wxColour $destColour, wxPoint $circleCenter )

Fill the area specified by rect with a radial gradient, starting from initialColour at the centre of the circle and fading to destColour on the circle outside.

GradientFillLinear

GradientFillLinear ( wxRect $rect, wxColour $initialColour, wxColour $destColour, wxDirection $nDirection=wxRIGHT )

Fill the area specified by rect with a linear gradient, starting from initialColour and eventually fading to destColour.

IsOk

bool IsOk ( )

Returns true if the DC is ok to use.

LogicalToDeviceX

integer LogicalToDeviceX ( integer $x )

Converts logical X coordinate to device coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.

LogicalToDeviceY

integer LogicalToDeviceY ( integer $y )

Converts logical Y coordinate to device coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.

LogicalToDeviceXRel

integer LogicalToDeviceXRel ( integer $x )

Converts logical X coordinate to relative device coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.

LogicalToDeviceYRel

integer LogicalToDeviceYRel ( integer $y )

Converts logical Y coordinate to relative device coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.

MaxX

integer MaxX ( )

Gets the maximum horizontal extent used in drawing commands so far.

MaxY

integer MaxY ( )

Gets the maximum vertical extent used in drawing commands so far.

MinX

integer MinX ( )

Gets the minimum horizontal extent used in drawing commands so far.

MinY

integer MinY ( )

Gets the minimum vertical extent used in drawing commands so far.

ResetBoundingBox

ResetBoundingBox ( )

Resets the bounding box: after a call to this function, the bounding box doesn't contain anything.

ResetTransformMatrix

ResetTransformMatrix ( )

Revert the transformation matrix to identity matrix.

SetAxisOrientation

SetAxisOrientation ( bool $xLeftRight, bool $yBottomUp )

Sets the x and y axis orientation (i.e., the direction from lowest to highest values on the axis).

SetBackground

SetBackground ( wxBrush $brush )

Sets the current background brush for the DC.

SetBackgroundMode

SetBackgroundMode ( integer $mode )

mode may be one of wxSOLID and wxTRANSPARENT.

SetBrush

SetBrush ( wxBrush $brush )

Sets the current brush for the DC.

SetClippingRegion

SetClippingRegion ( integer $x, integer $y, integer $width, integer $height )

Sets the clipping region for this device context to the intersection of the given region described by the parameters of this method and the previously set clipping region.
SetClippingRegion ( wxPoint $pt, wxSize $sz )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
SetClippingRegion ( wxRect $rect )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

SetDeviceClippingRegion

SetDeviceClippingRegion ( wxRegion $region )

Sets the clipping region for this device context.

SetDeviceOrigin

SetDeviceOrigin ( integer $x, integer $y )

Sets the device origin (i.e., the origin in pixels after scaling has been applied).

SetFont

SetFont ( wxFont $font )

Sets the current font for the DC.

SetLayoutDirection

SetLayoutDirection ( wxLayoutDirection $dir )

Sets the current layout direction for the device context.

SetLogicalFunction

SetLogicalFunction ( wxRasterOperationMode $function )

Sets the current logical function for the device context.

SetLogicalOrigin

SetLogicalOrigin ( integer $x, integer $y )

SetLogicalScale

SetLogicalScale ( float $x, float $y )

SetMapMode

SetMapMode ( wxMappingMode $mode )

The mapping mode of the device context defines the unit of measurement used to convert logical units to device units.

SetPalette

SetPalette ( wxPalette $palette )

If this is a window DC or memory DC, assigns the given palette to the window or bitmap associated with the DC.

SetPen

SetPen ( wxPen $pen )

Sets the current pen for the DC.

StretchBlit

bool StretchBlit ( integer $xdest, integer $ydest, integer $dstWidth, integer $dstHeight, wxDC &$source, integer $xsrc, integer $ysrc, integer $srcWidth, integer $srcHeight, wxRasterOperationMode $logicalFunc=wxCOPY, bool $useMask=false, integer $xsrcMask=wxDefaultCoord, integer $ysrcMask=wxDefaultCoord )

Copy from a source DC to this DC possibly changing the scale.

Blit

bool Blit ( integer $xdest, integer $ydest, integer $width, integer $height, wxDC &$source, integer $xsrc, integer $ysrc, wxRasterOperationMode $logicalFunc=wxCOPY, bool $useMask=false, integer $xsrcMask=wxDefaultCoord, integer $ysrcMask=wxDefaultCoord )

Copy from a source DC to this DC.