****************************
wx.richtext.RichTextPrintout
****************************

Inheritance diagram for `wx.richtext.RichTextPrintout`:

|

.. inheritance-diagram:: wx.richtext.RichTextPrintout

|

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

This class implements print layout for `wx.richtext.RichTextBuffer <wx.richtext.RichTextBuffer.html>`_. 
Instead of using it directly, you should normally use the `wx.richtext.RichTextPrinting <wx.richtext.RichTextPrinting.html>`_ class.


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

* `wx.Printout <../Widgets/wx.Printout.html>`_ 


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

* `__init__ <#__init__>`_ 
* `CalculateScaling <#CalculateScaling>`_ 
* `GetHeaderFooterData <#GetHeaderFooterData>`_ 
* `GetRichTextBuffer <#GetRichTextBuffer>`_ 
* `SetHeaderFooterData <#SetHeaderFooterData>`_ 
* `SetMargins <#SetMargins>`_ 
* `SetRichTextBuffer <#SetRichTextBuffer>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(title="Printout")

   Constructor.

   **Parameters:**

   * `title` (string)

   |

   **Returns:**

   `wx.richtext.RichTextPrintout <wx.richtext.RichTextPrintout.html>`_ 

--------

.. method:: CalculateScaling(dc, textRect, headerRect, footerRect)

   Calculates scaling and text, header and footer rectangles.

   **Parameters:**

   * `dc` (`wx.DC <../Widgets/wx.DC.html>`_) 
   * `textRect` (`wx.Rect <../Widgets/wx.Rect.html>`_) 
   * `headerRect` (`wx.Rect <../Widgets/wx.Rect.html>`_) 
   * `footerRect` (`wx.Rect <../Widgets/wx.Rect.html>`_) 

--------

.. method:: GetHeaderFooterData()

   Returns the header and footer data associated with the printout.

   |  

   **Returns:**

   `wx.richtext.RichTextHeaderFooterData`
 

--------

.. method:: GetRichTextBuffer()

   Returns a pointer to the buffer being rendered.

   |  

   **Returns:**

   `wx.richtext.RichTextBuffer <wx.richtext.RichTextBuffer.html>`_
 

--------

.. method:: SetHeaderFooterData(data)

   Sets the header and footer data associated with the printout.

   **Parameters:**

   * `data` (`wx.richtext.RichTextHeaderFooterData`) 

--------

.. method:: SetMargins(top=252, bottom=252, left=252, right=252)

   Sets margins in 10ths of millimetre. Defaults to 1 inch for margins.

   **Parameters:**

   * `top` (int) 
   * `bottom` (int) 
   * `left` (int) 
   * `right` (int) 

--------

.. method:: SetRichTextBuffer(buffer)

   Sets the buffer to print. 

   `wx.richtext.RichTextPrintout` does not manage this pointer; it should be managed by the calling code, such as 
   `wx.richtext.RichTextPrinting <wx.richtext.RichTextPrinting.html>`_.

   **Parameters:**

   * `buffer` (`wx.richtext.RichTextBuffer <wx.richtext.RichTextBuffer.html>`_)