.. include:: headings.inc



.. _PreviewControlBar:

==========================================================================================================================================
|phoenix_title|  **PreviewControlBar**
==========================================================================================================================================

This is the default implementation of the preview control bar, a panel with buttons and a zoom control.          

You can derive a new class from this and override some or all member functions to change the behaviour and appearance; or you can leave it as it is. 







         



.. seealso:: :ref:`PreviewFrame`, :ref:`PreviewCanvas`, :ref:`PrintPreview`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **PreviewControlBar**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/PreviewControlBar_inheritance.png" alt="Inheritance diagram of PreviewControlBar" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="16,5,88,35"/> <area shape="rect" id="node6" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="148,31,247,62"/> <area shape="rect" id="node2" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,58,99,89"/> <area shape="rect" id="node3" href="PreviewControlBar.html" title="This is the default implementation of the preview control bar, a panel with buttons and a zoom control." alt="" coords="547,31,704,62"/> <area shape="rect" id="node4" href="Panel.html" title="A panel is a window on which controls are placed." alt="" coords="427,31,499,62"/> <area shape="rect" id="node9" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="297,31,377,62"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~PreviewControlBar.__init__`                                              Constructor.
:meth:`~PreviewControlBar.CreateButtons`                                         Creates buttons, according to value of the button style flags.
:meth:`~PreviewControlBar.GetPrintPreview`                                       Gets the print preview object associated with the control bar.
:meth:`~PreviewControlBar.GetZoomControl`                                        Gets the current zoom setting in percent.
:meth:`~PreviewControlBar.SetZoomControl`                                        Sets the zoom control.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~PreviewControlBar.PrintPreview`                                          See :meth:`~PreviewControlBar.GetPrintPreview`
:attr:`~PreviewControlBar.ZoomControl`                                           See :meth:`~PreviewControlBar.GetZoomControl` and :meth:`~PreviewControlBar.SetZoomControl`
================================================================================ ================================================================================


|


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

.. class:: PreviewControlBar(Panel)

   This is the default implementation of the preview control bar, a panel with buttons and a zoom control.
   
   **Possible constructors**::

       PreviewControlBar(preview, buttons, parent, pos=DefaultPosition,
                         size=DefaultSize, style=0, name="panel")
       



   .. method:: __init__(self, preview, buttons, parent, pos=DefaultPosition, size=DefaultSize, style=0, name="panel")

      Constructor.                  

      The `buttons`  parameter may be a combination of the following, using the bitwise 'or' operator: 

  

      - ``PREVIEW_PRINT``: Create a print button.  
      - ``PREVIEW_NEXT``: Create a next page button.  
      - ``PREVIEW_PREVIOUS``: Create a previous page button.  
      - ``PREVIEW_ZOOM``: Create a zoom control.  
      - ``PREVIEW_DEFAULT``: Equivalent to a combination of  ``PREVIEW_PREVIOUS`` ,   ``PREVIEW_NEXT``   and   ``PREVIEW_ZOOM`` .     


                 


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







   .. method:: CreateButtons(self)

      Creates buttons, according to value of the button style flags.                  

                 



      .. todo:: which flags??    








   .. method:: GetPrintPreview(self)

      Gets the print preview object associated with the control bar.                  

      :rtype: :ref:`PrintPreview`








   .. method:: GetZoomControl(self)

      Gets the current zoom setting in percent.                  

      :rtype: `int`








   .. method:: SetZoomControl(self, percent)

      Sets the zoom control.                  


      :param `percent`: 
      :type `percent`: int







   .. attribute:: PrintPreview

      See :meth:`~PreviewControlBar.GetPrintPreview`


   .. attribute:: ZoomControl

      See :meth:`~PreviewControlBar.GetZoomControl` and :meth:`~PreviewControlBar.SetZoomControl`