***********
wx.ScreenDC
***********

Inheritance diagram for `wx.ScreenDC`:

|

.. inheritance-diagram:: wx.ScreenDC

|

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

A `wx.ScreenDC` can be used to paint on the screen. This should normally be constructed as a temporary stack object; don't store a `wx.ScreenDC` object.


.. seealso:: `wx.DC <wx.DC.html>`_, `wx.MemoryDC <wx.MemoryDC.html>`_, `wx.PaintDC <wx.PaintDC.html>`_, `wx.ClientDC <wx.ClientDC.html>`_, `wx.WindowDC <wx.WindowDC.html>`_


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

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


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

* `__init__ <#__init__>`_ 
* `EndDrawingOnTop <#EndDrawingOnTop>`_ 
* `StartDrawingOnTop <#StartDrawingOnTop>`_ 
* `StartDrawingOnTopWin <#StartDrawingOnTopWin>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   A `wx.ScreenDC` can be used to paint anywhere on the screen. This should
   normally be constructed as a temporary stack object; don't store a
   `wx.ScreenDC` object.
   
   |

   **Returns:**

   `wx.ScreenDC <wx.ScreenDC.html>`_
 

--------

.. method:: EndDrawingOnTop()

   Use this in conjunction with `StartDrawingOnTop <#StartDrawingOnTop>`_ or `StartDrawingOnTopWin <#StartDrawingOnTopWin>`_ to ensure 
   that drawing to the screen occurs on top of existing windows. Without this, some window systems (such as X) only allow drawing to take 
   place underneath other windows.

   You might use this pair of functions when implementing a drag feature, for example as in the `wx.SplitterWindow <wx.SplitterWindow.html>`_ implementation.

   |  

   **Returns:**

   `bool` 


.. note:: This function is probably obsolete since the X implementations allow drawing directly on the screen now. However, the fact that 
   this function allows the screen to be refreshed afterwards, may be useful to some applications.


--------

.. method:: StartDrawingOnTop(rect=None)

   Use this in conjunction with `EndDrawingOnTop <#EndDrawingOnTop>`_ to ensure that drawing to the screen occurs on top of existing windows. 
   Without this, some window systems (such as X) only allow drawing to take place underneath other windows.

   An application can specify an area of the screen which is to be drawn on. If ``None`` is passed, the whole screen is available.

   It is recommended that an area of the screen is specified because with large regions, flickering effects are noticeable when destroying the 
   temporary transparent window used to implement this feature.
   
   You might use this pair of functions when implementing a drag feature, for example as in the `wx.SplitterWindow <wx.SplitterWindow.html>`_ implementation.

   **Parameters:**

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

   |  

   **Returns:**

   `bool` 


.. note:: This function is probably obsolete since the X implementations allow drawing directly on the screen now. However, the fact that 
   this function allows the screen to be refreshed afterwards, may be useful to some applications.
  

.. seealso:: `EndDrawingOnTop <#EndDrawingOnTop>`_


--------

.. method:: StartDrawingOnTopWin(window)

   Specify that the area of the screen to be drawn upon coincides with
   the given window.
   
   
   **Parameters:**

   * `window` (`wx.Window <wx.Window.html>`_)

   |

   **Returns:**

   `bool` 


.. note:: This function is probably obsolete since the X implementations allow drawing directly on the screen now. However, the fact that 
   this function allows the screen to be refreshed afterwards, may be useful to some applications.


.. seealso:: `EndDrawingOnTop <#EndDrawingOnTop>`_