***********
wx.PseudoDC
***********

Inheritance diagram for `wx.PseudoDC`:

|

.. inheritance-diagram:: wx.PseudoDC

|

Description
===========

A `wx.PseudoDC` is an object that can be used as if it were a `wx.DC <wx.DC.html>`_. All commands issued to the `wx.PseudoDC` are stored in a list. You can then 
play these commands back to a real DC object using the `DrawToDC <#DrawToDC>`_ method. 

Commands in the command list are indexed by ID. You can use this to clear the operations associated with a single ID and then re-draw the object associated with that ID.


Derived From
^^^^^^^^^^^^^

* `wx.Object <wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `BeginDrawing <#BeginDrawing>`_ 
* `Clear <#Clear>`_ 
* `ClearId <#ClearId>`_ 
* `CrossHair <#CrossHair>`_ 
* `CrossHairPoint <#CrossHairPoint>`_ 
* `DrawArc <#DrawArc>`_ 
* `DrawArcPoint <#DrawArcPoint>`_ 
* `DrawBitmap <#DrawBitmap>`_ 
* `DrawBitmapPoint <#DrawBitmapPoint>`_ 
* `DrawCheckMark <#DrawCheckMark>`_ 
* `DrawCheckMarkRect <#DrawCheckMarkRect>`_ 
* `DrawCircle <#DrawCircle>`_ 
* `DrawCirclePoint <#DrawCirclePoint>`_ 
* `DrawEllipse <#DrawEllipse>`_ 
* `DrawEllipsePointSize <#DrawEllipsePointSize>`_ 
* `DrawEllipseRect <#DrawEllipseRect>`_ 
* `DrawEllipticArc <#DrawEllipticArc>`_ 
* `DrawEllipticArcPointSize <#DrawEllipticArcPointSize>`_ 
* `DrawIcon <#DrawIcon>`_ 
* `DrawIconPoint <#DrawIconPoint>`_ 
* `DrawIdToDC <#DrawIdToDC>`_ 
* `DrawImageLabel <#DrawImageLabel>`_ 
* `DrawLabel <#DrawLabel>`_ 
* `DrawLine <#DrawLine>`_ 
* `DrawLinePoint <#DrawLinePoint>`_ 
* `DrawLines <#DrawLines>`_ 
* `DrawPoint <#DrawPoint>`_ 
* `DrawPointPoint <#DrawPointPoint>`_ 
* `DrawPolygon <#DrawPolygon>`_ 
* `DrawRectangle <#DrawRectangle>`_ 
* `DrawRectanglePointSize <#DrawRectanglePointSize>`_ 
* `DrawRectangleRect <#DrawRectangleRect>`_ 
* `DrawRotatedText <#DrawRotatedText>`_ 
* `DrawRotatedTextPoint <#DrawRotatedTextPoint>`_ 
* `DrawRoundedRectangle <#DrawRoundedRectangle>`_ 
* `DrawRoundedRectanglePointSize <#DrawRoundedRectanglePointSize>`_ 
* `DrawRoundedRectangleRect <#DrawRoundedRectangleRect>`_ 
* `DrawSpline <#DrawSpline>`_ 
* `DrawText <#DrawText>`_ 
* `DrawTextPoint <#DrawTextPoint>`_ 
* `DrawToDC <#DrawToDC>`_ 
* `DrawToDCClipped <#DrawToDCClipped>`_ 
* `DrawToDCClippedRgn <#DrawToDCClippedRgn>`_ 
* `EndDrawing <#EndDrawing>`_ 
* `FindObjects <#FindObjects>`_ 
* `FindObjectsByBBox <#FindObjectsByBBox>`_ 
* `FloodFill <#FloodFill>`_ 
* `FloodFillPoint <#FloodFillPoint>`_ 
* `GetIdBounds <#GetIdBounds>`_ 
* `GetIdGreyedOut <#GetIdGreyedOut>`_ 
* `GetLen <#GetLen>`_ 
* `RemoveAll <#RemoveAll>`_ 
* `RemoveId <#RemoveId>`_ 
* `SetBackground <#SetBackground>`_ 
* `SetBackgroundMode <#SetBackgroundMode>`_ 
* `SetBrush <#SetBrush>`_ 
* `SetFont <#SetFont>`_ 
* `SetId <#SetId>`_ 
* `SetIdBounds <#SetIdBounds>`_ 
* `SetIdGreyedOut <#SetIdGreyedOut>`_ 
* `SetLogicalFunction <#SetLogicalFunction>`_ 
* `SetPalette <#SetPalette>`_ 
* `SetPen <#SetPen>`_ 
* `SetTextBackground <#SetTextBackground>`_ 
* `SetTextForeground <#SetTextForeground>`_ 
* `TranslateId <#TranslateId>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `IdBounds <#IdBounds>`_ 
* `Len <#Len>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   Constructs a new `wx.Pseudo` device context for recording dc operations.

   |

   **Returns:**

   `wx.PseudoDC <wx.PseudoDC.html>`_
 

--------

.. method:: BeginDrawing()

   Allows for optimization of drawing code on platforms that need it. On other platforms this is just an empty function and is harmless. 

   To take advantage of this postential optimization simply enclose each group of calls to the drawing primitives within calls to
   `BeginDrawing <#BeginDrawing>`_ and `EndDrawing <#EndDrawing>`_.

--------

.. method:: Clear()

   Clears the device context using the current background brush.

--------

.. method:: ClearId(id)

   Removes all operations associated with `id` so the object can be redrawn.

   **Parameters:**

   * `id` (int)


--------

.. method:: CrossHair(x, y)

   Displays a cross hair using the current pen. 

   This is a vertical and horizontal line the height and width of the window, centred on the given point.

   **Parameters:**

   * `x` (int)
   * `y` (int)


--------

.. method:: CrossHairPoint(pt)

   Displays a cross hair using the current pen. 

   This is a vertical and horizontal line the height and width of the window, centred on the given point.

   **Parameters:**

   * `pt` (`wx.Point <wx.Point.html>`_)


--------

.. method:: DrawArc(x1, y1, x2, y2, xc, yc)

   Draws an arc of a circle, centred on the center point (`xc`, `yc`), from
   the first point to the second. The current pen is used for the outline
   and the current brush for filling the shape.
   
   The arc is drawn in an anticlockwise direction from the start point to the end point.

   **Parameters:**

   * `x1` (int)
   * `y1` (int)
   * `x2` (int)
   * `y2` (int)
   * `xc` (int)
   * `yc` (int)


--------

.. method:: DrawArcPoint(pt1, pt2, center)

   Draws an arc of a circle, centred on the `center` point, from
   the first point to the second. The current pen is used for the outline
   and the current brush for filling the shape.
   
   The arc is drawn in an anticlockwise direction from the start point to the end point.

   **Parameters:**

   * `pt1` (`wx.Point <wx.Point.html>`_)
   * `pt2` (`wx.Point <wx.Point.html>`_)
   * `center` (`wx.Point <wx.Point.html>`_)


--------

.. method:: DrawBitmap(bmp, x, y, useMask=False)

   Draw a bitmap on the device context at the specified point. 

   If `transparent` is ``True`` and the bitmap has a transparency mask, (or alpha channel on the platforms that support it) then the bitmap will
   be drawn transparently.

   **Parameters:**

   * `bmp` (`wx.Bitmap <wx.Bitmap.html>`_)
   * `x` (int)
   * `y` (int)
   * `useMask` (bool)


--------

.. method:: DrawBitmapPoint(bmp, pt, useMask=False)

   Draw a bitmap on the device context at the specified point. 

   If `transparent` is ``True`` and the bitmap has a transparency mask, (or alpha channel on the platforms that support it) then the bitmap will
   be drawn transparently.

   **Parameters:**

   * `bmp` (`wx.Bitmap <wx.Bitmap.html>`_)
   * `pt` (`wx.Point <wx.Point.html>`_)
   * `useMask` (bool)


--------

.. method:: DrawCheckMark(x, y, width, height)

   Draws a check mark inside the given rectangle.

   **Parameters:**

   * `x` (int)
   * `y` (int)
   * `width` (int)
   * `height` (int)


--------

.. method:: DrawCheckMarkRect(rect)

   Draws a check mark inside the given rectangle.

   **Parameters:**

   * `rect` (`wx.Rect <wx.Rect.html>`_)


--------

.. method:: DrawCircle(x, y, radius)

   Draws a circle with the given center point and radius. The current pen is used for the outline and the current brush for filling the shape.

   **Parameters:**

   * `x` (int)
   * `y` (int)
   * `radius` (int)


--------

.. method:: DrawCirclePoint(pt, radius)

   Draws a circle with the given center point and radius. The current pen is used for the outline and the current brush for filling the shape.

   **Parameters:**

   * `pt` (`wx.Point <wx.Point.html>`_)
   * `radius` (int)


--------

.. method:: DrawEllipse(x, y, width, height)

   Draws an ellipse contained in the specified rectangle. The current pen is used for the outline and the current brush for filling the shape.

   **Parameters:**

   * `x` (int)
   * `y` (int)
   * `width` (int)
   * `height` (int)


--------

.. method:: DrawEllipsePointSize(pt, sz)

   Draws an ellipse contained in the specified rectangle. The current pen is used for the outline and the current brush for filling the shape.

   **Parameters:**

   * `pt` (`wx.Point <wx.Point.html>`_)
   * `sz` (`wx.Size <wx.Size.html>`_)


--------

.. method:: DrawEllipseRect(rect)

   Draws an ellipse contained in the specified rectangle. The current pen is used for the outline and the current brush for filling the shape.

   **Parameters:**

   * `rect` (`wx.Rect <wx.Rect.html>`_)


--------

.. method:: DrawEllipticArc(x, y, w, h, start, end)

   Draws an arc of an ellipse, with the given rectangle defining the
   bounds of the ellipse. The current pen is used for drawing the arc and
   the current brush is used for drawing the pie.
   
   The `start` and `end` parameters specify the start and end of the arc
   relative to the three-o'clock position from the center of the
   rectangle. Angles are specified in degrees (360 is a complete
   circle). Positive values mean counter-clockwise motion. If `start` is
   equal to `end`, a complete ellipse will be drawn.

   **Parameters:**

   * `x` (int)
   * `y` (int)
   * `w` (int)
   * `h` (int)
   * `start` (double)
   * `end` (double)


--------

.. method:: DrawEllipticArcPointSize(pt, sz, start, end)

   Draws an arc of an ellipse, with the given rectangle defining the
   bounds of the ellipse. The current pen is used for drawing the arc and
   the current brush is used for drawing the pie.
   
   The `start` and `end` parameters specify the start and end of the arc
   relative to the three-o'clock position from the center of the
   rectangle. Angles are specified in degrees (360 is a complete
   circle). Positive values mean counter-clockwise motion. If `start` is
   equal to `end`, a complete ellipse will be drawn.

   **Parameters:**

   * `pt` (`wx.Point <wx.Point.html>`_)
   * `sz` (`wx.Size <wx.Size.html>`_)
   * `start` (double)
   * `end` (double)


--------

.. method:: DrawIcon(icon, x, y)

   Draw an icon on the display (does nothing if the device context is PostScript). 

   This can be the simplest way of drawing bitmaps on a window.

   **Parameters:**

   * `icon` (`wx.Icon <wx.Icon.html>`_)
   * `x` (int)
   * `y` (int)


--------

.. method:: DrawIconPoint(icon, pt)

   Draw an icon on the display (does nothing if the device context is PostScript). 

   This can be the simplest way of drawing bitmaps on a window.

   **Parameters:**

   * `icon` (`wx.Icon <wx.Icon.html>`_)
   * `pt` (`wx.Point <wx.Point.html>`_)


--------

.. method:: DrawIdToDC(id, dc)

   Draw recorded operations of `id` to `dc`.

   **Parameters:**

   * `id` (int)
   * `dc` (`wx.DC <wx.DC.html>`_)


--------

.. method:: DrawImageLabel(text, image, rect, alignment=wx.ALIGN_LEFT|wx.ALIGN_TOP, indexAccel=-1)

   Draw `text` and an image (which may be ``wx.NullBitmap`` to skip
   drawing it) within the specified rectangle, abiding by the alignment
   flags. Will additionally emphasize the character at `indexAccel` if
   it is not -1.

   **Parameters:**

   * `text` (string)
   * `image` (`wx.Bitmap <wx.Bitmap.html>`_)
   * `rect` (`wx.Rect <wx.Rect.html>`_)
   * `alignment` (int)
   * `indexAccel` (int)


--------

.. method:: DrawLabel(text, rect, alignment=wx.ALIGN_LEFT|wx.ALIGN_TOP, indexAccel=-1)

   Draw `text` within the specified rectangle, abiding by the alignment
   flags. Will additionally emphasize the character at `indexAccel` if
   it is not -1.

   **Parameters:**

   * `text` (string)
   * `rect` (`wx.Rect <wx.Rect.html>`_)
   * `alignment` (int)
   * `indexAccel` (int)


--------

.. method:: DrawLine(x1, y1, x2, y2)

   Draws a line from the first point to the second. The current pen is
   used for drawing the line. 

   **Parameters:**

   * `x1` (int)
   * `y1` (int)
   * `x2` (int)
   * `y2` (int)

.. note:: Note that the second point is **not** part of the line and is not drawn by this function (this is consistent with the behaviour of many other toolkits).

--------

.. method:: DrawLinePoint(pt1, pt2)

   Draws a line from the first point to the second. The current pen is
   used for drawing the line. 

   **Parameters:**

   * `pt1` (`wx.Point <wx.Point.html>`_)
   * `pt2` (`wx.Point <wx.Point.html>`_)

.. note:: Note that the second point is **not** part of the line and is not drawn by this function (this is consistent with the behaviour of many other toolkits).

--------

.. method:: DrawLines(points, xoffset=0, yoffset=0)

   Draws lines using a sequence of `wx.Point <wx.Point.html>`_ objects, adding the
   optional offset coordinate. The current pen is used for drawing the
   lines.

   **Parameters:**

   * `points` (list)
   * `xoffset` (int)
   * `yoffset` (int)


--------

.. method:: DrawPoint(x, y)

   Draws a point using the current pen.

   **Parameters:**

   * `x` (int)
   * `y` (int)


--------

.. method:: DrawPointPoint(pt)

   Draws a point using the current pen.

   **Parameters:**

   * `pt` (`wx.Point <wx.Point.html>`_)


--------

.. method:: DrawPolygon(points, xoffset=0, yoffset=0, fillStyle=wx.ODDEVEN_RULE)

   Draws a filled polygon using a sequence of `wx.Point <wx.Point.html>`_ objects, adding
   the optional offset coordinate. The last argument specifies the fill
   rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
   
   The current pen is used for drawing the outline, and the current brush
   for filling the shape. Using a transparent brush suppresses
   filling. 

   **Parameters:**

   * `points` (list)
   * `xoffset` (int)
   * `yoffset` (int)
   * `fillStyle` (int)

.. note:: Note that wxWidgets automatically closes the first and last points.

--------

.. method:: DrawRectangle(x, y, width, height)

   Draws a rectangle with the given top left corner, and with the given
   size. The current pen is used for the outline and the current brush
   for filling the shape.

   **Parameters:**

   * `x` (int)
   * `y` (int)
   * `width` (int)
   * `height` (int)


--------

.. method:: DrawRectanglePointSize(pt, sz)

   Draws a rectangle with the given top left corner, and with the given
   size. The current pen is used for the outline and the current brush
   for filling the shape.

   **Parameters:**

   * `pt` (`wx.Point <wx.Point.html>`_)
   * `sz` (`wx.Size <wx.Size.html>`_)


--------

.. method:: DrawRectangleRect(rect)

   Draws a rectangle with the given top left corner, and with the given
   size. The current pen is used for the outline and the current brush
   for filling the shape.

   **Parameters:**

   * `rect` (`wx.Rect <wx.Rect.html>`_)


--------

.. method:: DrawRotatedText(text, x, y, angle)

   Draws the text rotated by `angle` degrees, if supported by the platform.

   **Parameters:**

   * `text` (string)
   * `x` (int)
   * `y` (int)
   * `angle` (double)

.. note:: Under Win9x only TrueType fonts can be drawn by this function. In particular, a font different from ``wx.NORMAL_FONT`` should be used as 
   the it is not normally a TrueType font. ``wx.SWISS_FONT`` is an example of a font which is.

--------

.. method:: DrawRotatedTextPoint(text, pt, angle)

   Draws the text rotated by `angle` degrees, if supported by the platform.
   
   **Parameters:**

   * `text` (string)
   * `pt` (`wx.Point <wx.Point.html>`_)
   * `angle` (double)

.. note:: Under Win9x only TrueType fonts can be drawn by this function. In particular, a font different from ``wx.NORMAL_FONT`` should be used as 
   the it is not normally a TrueType font. ``wx.SWISS_FONT`` is an example of a font which is.

--------

.. method:: DrawRoundedRectangle(x, y, width, height, radius)

   Draws a rectangle with the given top left corner, and with the given
   size. The corners are quarter-circles using the given radius. The
   current pen is used for the outline and the current brush for filling
   the shape.
   
   If `radius` is positive, the value is assumed to be the radius of the
   rounded corner. If `radius` is negative, the absolute value is assumed
   to be the proportion of the smallest dimension of the rectangle. This
   means that the corner can be a sensible size relative to the size of
   the rectangle, and also avoids the strange effects X produces when the
   corners are too big for the rectangle.

   **Parameters:**

   * `x` (int)
   * `y` (int)
   * `width` (int)
   * `height` (int)
   * `radius` (double)


--------

.. method:: DrawRoundedRectanglePointSize(pt, sz, radius)

   Draws a rectangle with the given top left corner, and with the given
   size. The corners are quarter-circles using the given radius. The
   current pen is used for the outline and the current brush for filling
   the shape.
   
   If `radius` is positive, the value is assumed to be the radius of the
   rounded corner. If `radius` is negative, the absolute value is assumed
   to be the proportion of the smallest dimension of the rectangle. This
   means that the corner can be a sensible size relative to the size of
   the rectangle, and also avoids the strange effects X produces when the
   corners are too big for the rectangle.

   **Parameters:**

   * `pt` (`wx.Point <wx.Point.html>`_)
   * `sz` (`wx.Size <wx.Size.html>`_)
   * `radius` (double)


--------

.. method:: DrawRoundedRectangleRect(r, radius)

   Draws a rectangle with the given top left corner, and with the given
   size. The corners are quarter-circles using the given radius. The
   current pen is used for the outline and the current brush for filling
   the shape.
   
   If `radius` is positive, the value is assumed to be the radius of the
   rounded corner. If `radius` is negative, the absolute value is assumed
   to be the proportion of the smallest dimension of the rectangle. This
   means that the corner can be a sensible size relative to the size of
   the rectangle, and also avoids the strange effects X produces when the
   corners are too big for the rectangle.

   **Parameters:**

   * `r` (`wx.Rect <wx.Rect.html>`_)
   * `radius` (double)


--------

.. method:: DrawSpline(points)

   Draws a spline between all given control points, (a list of `wx.Point <wx.Point.html>`_
   objects) using the current pen. The spline is drawn using a series of
   lines, using an algorithm taken from the X drawing program 'XFIG'.

   **Parameters:**

   * `points` (list)


--------

.. method:: DrawText(text, x, y)

   Draws a text string at the specified point, using the current text
   font, and the current text foreground and background colours.
   
   The coordinates refer to the top-left corner of the rectangle bounding
   the string. See `wx.DC.GetTextExtent <wx.DC.html#GetTextExtent>`_ for how to get the dimensions of
   a text string, which can be used to position the text more precisely,
   (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
   not implement it.)
   
   **Parameters:**

   * `text` (string)
   * `x` (int)
   * `y` (int)


.. note:: Under wxGTK the current logical function is used by this function but it is ignored by wxMSW. Thus, you should avoid using
   logical functions with this function in portable programs.

--------

.. method:: DrawTextPoint(text, pt)

   Draws a text string at the specified point, using the current text
   font, and the current text foreground and background colours.
   
   The coordinates refer to the top-left corner of the rectangle bounding
   the string. See `wx.DC.GetTextExtent <wx.DC.html#GetTextExtent>`_ for how to get the dimensions of
   a text string, which can be used to position the text more precisely,
   (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
   not implement it.)
   
   **Parameters:**

   * `text` (string)
   * `pt` (`wx.Point <wx.Point.html>`_)

.. note:: Under wxGTK the current logical function is used by this function but it is ignored by wxMSW. Thus, you should avoid using
   logical functions with this function in portable programs.

--------

.. method:: DrawToDC(dc)

   Draws the recorded operations to `dc`.

   **Parameters:**

   * `dc` (`wx.DC <wx.DC.html>`_)


--------

.. method:: DrawToDCClipped(dc, rect)

   Draws the recorded operations to `dc` unless the operation is known to be outside `rect`.

   **Parameters:**

   * `dc` (`wx.DC <wx.DC.html>`_)
   * `rect` (`wx.Rect <wx.Rect.html>`_)


--------

.. method:: DrawToDCClippedRgn(dc, region)

   Draws the recorded operations to `dc` unless the operation is known to be outside `region`.

   **Parameters:**

   * `dc` (`wx.DC <wx.DC.html>`_)
   * `region` (`wx.Region <wx.Region.html>`_)


--------

.. method:: EndDrawing()

   Ends the group of drawing primitives started with `BeginDrawing <#BeginDrawing>`_, and
   invokes whatever optimization is available for this DC type on the
   current platform.

--------

.. method:: FindObjects(x, y, radius=1, bg=wx.WHITE)

   Returns a list of all the id's that draw a pixel with color not equal to bg within radius of (`x`, `y`).

   Returns an empty list if nothing is found. The list is in reverse drawing order so list[0] is the top id.

   **Parameters:**

   * `x` (int)
   * `y` (int)
   * `radius` (int)
   * `bg` (`wx.Colour <wx.Colour.html>`_)

   |

   **Returns:**

   `PyObject` 

--------

.. method:: FindObjectsByBBox(x, y)

   Returns a list of all the id's whose bounding boxes include (`x`, `y`).

   Returns an empty list if nothing is found. The list is in reverse drawing order so list[0] is the top id.

   **Parameters:**

   * `x` (int)
   * `y` (int)

   |

   **Returns:**

   `PyObject` 

--------

.. method:: FloodFill(x, y, col, style=wx.FLOOD_SURFACE)

   Flood fills the device context starting from the given point, using the *current brush colour*, and using a style:
   
   * ``wx.FLOOD_SURFACE``: the flooding occurs until a colour other than the given colour is encountered.
   * ``wx.FLOOD_BORDER``: the area to be flooded is bounded by the given colour.
   
   Returns ``False`` if the operation failed.
   
   **Parameters:**

   * `x` (int)
   * `y` (int)
   * `col` (`wx.Colour <wx.Colour.html>`_)
   * `style` (int)

   |

   **Returns:**

   `bool`


.. note:: The present implementation for non-Windows platforms may fail to find colour borders if the pixels do not match the 
   colour exactly. However the function will still return ``True``.

--------

.. method:: FloodFillPoint(pt, col, style=wx.FLOOD_SURFACE)

   Flood fills the device context starting from the given point, using the *current brush colour*, and using a style:
   
   * ``wx.FLOOD_SURFACE``: the flooding occurs until a colour other than the given colour is encountered.
   * ``wx.FLOOD_BORDER``: the area to be flooded is bounded by the given colour.
   
   Returns ``False`` if the operation failed.
   
   **Parameters:**

   * `pt` (`wx.Point <wx.Point.html>`_)
   * `col` (`wx.Colour <wx.Colour.html>`_)
   * `style` (int)

   |

   **Returns:**

   `bool`


.. note:: The present implementation for non-Windows platforms may fail to find colour borders if the pixels do not match the 
   colour exactly. However the function will still return ``True``.

--------

.. method:: GetIdBounds(id)

   Returns the bounding rectangle previouly set with `SetIdBounds <#SetIdBounds>`_.

   If no bounds have been set, it returns `wx.Rect(0, 0, 0, 0)`.

   **Parameters:**

   * `id` (int)

   |

   **Returns:**

   `wx.Rect <wx.Rect.html>`_
 

--------

.. method:: GetIdGreyedOut(id)

   Get whether an object is drawn greyed out or not.

   **Parameters:**

   * `id` (int)

   |

   **Returns:**

   `bool` 

--------

.. method:: GetLen()

   Returns the number of operations in the recorded list.

   |

   **Returns:**

   `int` 

--------

.. method:: RemoveAll()

   Removes all objects and operations from the recorded list.

--------

.. method:: RemoveId(id)

   Remove the object node (and all operations) associated with an id.

   **Parameters:**

   * `id` (int)


--------

.. method:: SetBackground(brush)

   Sets the current background brush for the DC.

   **Parameters:**

   * `brush` (`wx.Brush <wx.Brush.html>`_)


--------

.. method:: SetBackgroundMode(mode)

   `mode` may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``.

   This setting determines whether text will be drawn with a background colour or not.

   **Parameters:**

   * `mode` (int)


--------

.. method:: SetBrush(brush)

   Sets the current brush for the DC.
   
   If the argument is `wx.NullBrush`, the current brush is selected out of the device context, and the original brush restored, allowing the
   current brush to be destroyed safely.

   **Parameters:**

   * `brush` (`wx.Brush <wx.Brush.html>`_)


--------

.. method:: SetFont(font)

   Sets the current font for the DC. It must be a valid font, in particular you should not pass `wx.NullFont` to this method.

   **Parameters:**

   * `font` (`wx.Font <wx.Font.html>`_)


--------

.. method:: SetId(id)

   Sets the `id` to be associated with subsequent operations.

   **Parameters:**

   * `id` (int)


--------

.. method:: SetIdBounds(id, rect)

   Set the bounding rect of a given object. This will create an object node if one doesn't exist.

   **Parameters:**

   * `id` (int)
   * `rect` (`wx.Rect <wx.Rect.html>`_)


--------

.. method:: SetIdGreyedOut(id, greyout=True)

   Set whether an object is drawn greyed out or not.

   **Parameters:**

   * `id` (int)
   * `greyout` (bool)


--------

.. method:: SetLogicalFunction(function)

   Sets the current logical function for the device context. This
   determines how a source pixel (from a pen or brush colour, combines
   with a destination pixel in the current device context.
   
   The possible values and their meaning in terms of source and
   destination pixel values are as follows:
   
   =======================  ==========================
   Function Flag            Description
   =======================  ==========================
   ``wx.AND``               src AND dst
   ``wx.AND_INVERT``        (NOT src) AND dst
   ``wx.AND_REVERSE``       src AND (NOT dst)
   ``wx.CLEAR``             0
   ``wx.COPY``              src
   ``wx.EQUIV``             (NOT src) XOR dst
   ``wx.INVERT``            NOT dst
   ``wx.NAND``              (NOT src) OR (NOT dst)
   ``wx.NOR``               (NOT src) AND (NOT dst)
   ``wx.NO_OP``             dst
   ``wx.OR``                src OR dst
   ``wx.OR_INVERT``         (NOT src) OR dst
   ``wx.OR_REVERSE``        src OR (NOT dst)
   ``wx.SET``               1
   ``wx.SRC_INVERT``        NOT src
   ``wx.XOR``               src XOR dst
   =======================  ==========================
   
   The default is ``wx.COPY``, which simply draws with the current colour. The others combine the current colour and the background using a 
   logical operation.  

   ``wx.INVERT`` is commonly used for drawing rubber bands or moving outlines, since drawing twice reverts to the original colour.

   **Parameters:**

   * `function` (int)


--------

.. method:: SetPalette(palette)

   If this is a window DC or memory DC, assigns the given palette to the
   window or bitmap associated with the DC. If the argument is
   `wx.NullPalette`, the current palette is selected out of the device
   context, and the original palette restored.

   **Parameters:**

   * `palette` (`wx.Palette <wx.Palette.html>`_)


--------

.. method:: SetPen(pen)

   Sets the current pen for the DC.
   
   If the argument is `wx.NullPen`, the current pen is selected out of the
   device context, and the original pen restored.

   **Parameters:**

   * `pen` (`wx.Pen <wx.Pen.html>`_)


--------

.. method:: SetTextBackground(colour)

   Sets the current text background colour for the DC.

   **Parameters:**

   * `colour` (`wx.Colour <wx.Colour.html>`_)


--------

.. method:: SetTextForeground(colour)

   Sets the current text foreground colour for the DC.

   **Parameters:**

   * `colour` (`wx.Colour <wx.Colour.html>`_)


--------

.. method:: TranslateId(id, dx, dy)

   Translate the operations of id by `dx`, `dy`.

   **Parameters:**

   * `id` (int)
   * `dx` (int)
   * `dy` (int)


--------

Properties
^^^^^^^^^^


.. attribute:: IdBounds

   See `GetIdBounds <#GetIdBounds>`_ and `SetIdBounds <#SetIdBounds>`_

.. attribute:: Len

   See `GetLen <#GetLen>`_