.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.PreviewCanvas:

==========================================================================================================================================
|phoenix_title|  **wx.PreviewCanvas**
==========================================================================================================================================

A preview canvas is the default canvas used by the print preview system to display the preview. 
         








         



.. seealso:: :ref:`wx.PreviewFrame`, :ref:`wx.PreviewControlBar`, :ref:`wx.PrintPreview`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>PreviewCanvas</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.PreviewCanvas_inheritance.svg" alt="Inheritance diagram of PreviewCanvas" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.PreviewCanvas.html" title="A preview canvas is the default canvas used by the print preview system to display the preview." alt="" coords="10,178,176,207"/> <area shape="rect" id="node2" href="Scrolled&lt; wxPanel &gt;.html" title="Scrolled&lt; wxPanel &gt;" alt="" coords="5,101,181,130"/> </map> 
   </p>
   </div>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.PreviewCanvas.__init__`                                               Constructor.
:meth:`~wx.PreviewCanvas.GetClassDefaultAttributes`                              
:meth:`~wx.PreviewCanvas.OnPaint`                                                Calls :meth:`wx.PrintPreview.PaintPage`   to refresh the canvas.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.PreviewCanvas(ScrolledWindow)

   **Possible constructors**::

       PreviewCanvas(preview : PrintPreview, parent : Window, pos:
                     Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name:
                     str="canvas") -> None
       
   
   A preview canvas is the default canvas used by the print preview
   system to display the preview.



   .. method:: __init__(self, preview : PrintPreview, parent : Window, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name: str="canvas")

      Constructor. 
                 


      :param `preview`: 
      :type `preview`: wx.PrintPreview
      :param `parent`: 
      :type `parent`: wx.Window
      :param `pos`: 
      :type `pos`: wx.Point
      :param `size`: 
      :type `size`: wx.Size
      :param `style`: 
      :type `style`: long
      :param `name`: 
      :type `name`: string




      :rtype: `None`     








   .. staticmethod:: GetClassDefaultAttributes(variant: WindowVariant=WINDOW_VARIANT_NORMAL)




      :param `variant`: 
      :type `variant`: wx.WindowVariant




      :rtype: :ref:`wx.VisualAttributes`








   .. method:: OnPaint(self, event : PaintEvent)

      Calls :meth:`wx.PrintPreview.PaintPage`   to refresh the canvas. 
                 


      :param `event`: 
      :type `event`: wx.PaintEvent




      :rtype: `None`