.. 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.PrintPageRange:
==========================================================================================================================================
|phoenix_title| **wx.PrintPageRange**
==========================================================================================================================================
This class represents a range of pages to be printed.
.. versionadded:: 4.3/wxWidgets-3.3.0
.. seealso:: :ref:`wx.PrintDialogData`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
PrintPageRange:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PrintPageRange.__init__` Default constructor creates an uninitialized range.
:meth:`~wx.PrintPageRange.GetNumberOfPages` Return the number of pages in this range if it is valid.
:meth:`~wx.PrintPageRange.IsValid` Return ``True`` if both components are initialized correctly.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.PrintPageRange.NumberOfPages` See :meth:`~wx.PrintPageRange.GetNumberOfPages`
:attr:`~wx.PrintPageRange.fromPage` A public C++ attribute of type ``int``.
:attr:`~wx.PrintPageRange.toPage` A public C++ attribute of type ``int``.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PrintPageRange(object)
**Possible constructors**::
PrintPageRange() -> None
PrintPageRange(_from, to) -> None
This class represents a range of pages to be printed.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self)`
Default constructor creates an uninitialized range.
:rtype: `None`
:html:`
`
**__init__** `(self, _from, to)`
Constructor creating a range from `from` to `to` (inclusive).
Parameters must be valid, i.e. `from` must be strictly positive and `to` must be greater or equal to `from`.
:param `from`:
:type `from`: int
:param `to`:
:type `to`: int
:rtype: `None`
:html:`
`
.. method:: GetNumberOfPages(self)
Return the number of pages in this range if it is valid.
:rtype: `int`
.. method:: IsValid(self)
Return ``True`` if both components are initialized correctly.
:rtype: `bool`
.. attribute:: NumberOfPages
See :meth:`~wx.PrintPageRange.GetNumberOfPages`
.. attribute:: fromPage
A public C++ attribute of type ``int``.
.. attribute:: toPage
A public C++ attribute of type ``int``.