1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.PreviewControlBar:
==========================================================================================================================================
|phoenix_title| **wx.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:`wx.PreviewFrame`, :ref:`wx.PreviewCanvas`, :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>PreviewControlBar</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.PreviewControlBar_inheritance.png" alt="Inheritance diagram of PreviewControlBar" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node2" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> <area shape="rect" id="node3" href="wx.PreviewControlBar.html" title="wx.PreviewControlBar" alt="" coords="25,315,183,344"/> <area shape="rect" id="node4" href="wx.Panel.html" title="wx.Panel" alt="" coords="66,237,141,267"/> <area shape="rect" id="node6" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PreviewControlBar.__init__` Constructor.
:meth:`~wx.PreviewControlBar.CreateButtons` Creates buttons, according to value of the button style flags.
:meth:`~wx.PreviewControlBar.GetPrintPreview` Gets the print preview object associated with the control bar.
:meth:`~wx.PreviewControlBar.GetZoomControl` Gets the current zoom setting in percent.
:meth:`~wx.PreviewControlBar.SetZoomControl` Sets the zoom control.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.PreviewControlBar.PrintPreview` See :meth:`~wx.PreviewControlBar.GetPrintPreview`
:attr:`~wx.PreviewControlBar.ZoomControl` See :meth:`~wx.PreviewControlBar.GetZoomControl` and :meth:`~wx.PreviewControlBar.SetZoomControl`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PreviewControlBar(Panel)
**Possible constructors**::
PreviewControlBar(preview, buttons, parent, pos=DefaultPosition,
size=DefaultSize, style=0, name="panel")
This is the default implementation of the preview control bar, a panel
with buttons and a zoom control.
.. 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:
- ``wx.PREVIEW_PRINT``: Create a print button.
- ``wx.PREVIEW_NEXT``: Create a next page button.
- ``wx.PREVIEW_PREVIOUS``: Create a previous page button.
- ``wx.PREVIEW_ZOOM``: Create a zoom control.
- ``wx.PREVIEW_DEFAULT``: Equivalent to a combination of ``PREVIEW_PREVIOUS`` , ``PREVIEW_NEXT`` and ``PREVIEW_ZOOM`` .
:param `preview`:
:type `preview`: wx.PrintPreview
:param `buttons`:
:type `buttons`: long
: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
.. 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:`wx.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:`~wx.PreviewControlBar.GetPrintPreview`
.. attribute:: ZoomControl
See :meth:`~wx.PreviewControlBar.GetZoomControl` and :meth:`~wx.PreviewControlBar.SetZoomControl`
|