More pdfviewer docstring patched from Werer

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@73780 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2013-04-05 04:04:29 +00:00
parent cf48eaed00
commit 87b3f4c01e
2 changed files with 14 additions and 12 deletions

View File

@@ -36,7 +36,7 @@ Additional details on pyPDF2 can be found:
- home page: http://knowah.github.com/PyPDF2/
- download: https://github.com/knowah/PyPDF2/
There is an optional :class:`~lib.pdfviewer.viewer.pdfButtonPanel` class, derived from
There is an optional :class:`~lib.pdfviewer.buttonpanel.pdfButtonPanel` class, derived from
:class:`~lib.agw.buttonpanel`, that can be placed, for example, at the top of the
scrolled viewer window, and which contains navigation and zoom controls.
@@ -88,16 +88,16 @@ Alternatively you can drive the viewer from controls in your own application.
Externally callable methods are:
:meth:`viewer.LoadFile(pathname) <~lib.pdfviewer.viewer.pdfViewer.LoadFile>`
:meth:`~lib.pdfviewer.viewer.pdfViewer.LoadFile`
:meth:`viewer.Save() <~lib.pdfviewer.viewer.pdfViewer.Save>`
:meth:`~lib.pdfviewer.viewer.pdfViewer.Save`
:meth:`viewer.Print() <~lib.pdfviewer.viewer.pdfViewer.Print>`
:meth:`~lib.pdfviewer.viewer.pdfViewer.Print`
:meth:`viewer.SetZoom(zoomscale) <~lib.pdfviewer.viewer.pdfViewer.SetZoom>`
:meth:`~lib.pdfviewer.viewer.pdfViewer.SetZoom`
:meth:`viewer.GoPage(pagenumber) <~lib.pdfviewer.viewer.pdfViewer.GoPage>`
:meth:`~lib.pdfviewer.viewer.pdfViewer.GoPage`
The viewer renders the pdf file content using Cairo if installed,
otherwise :class:`GraphicsContext` is used. Printing is achieved by writing
directly to a :class:`PrinterDC` and using :class:`Printer`.
@@ -109,10 +109,11 @@ produced by ReportLab that use Western languages. The biggest limitation is
probably that it doesn't (yet?) support embedded fonts and will substitute one
of the standard fonts instead.
The icons used in :class:`~lib.pdfviewer.viewer.pdfButtonPanel` are Free Icons
The icons used in :class:`~lib.pdfviewer.buttonpanel.pdfButtonPanel` are Free Icons
by Axialis Software: http://www.axialis.com
You can freely use them in any project or website, commercially or not.
TERMS OF USE:
You must keep the credits of the authors: "Axialis Team", even if you modify them.

View File

@@ -13,8 +13,8 @@
#
#----------------------------------------------------------------------------
"""
This module provides the :class:`~lib.pdfviewer.viewer.pdfButtonPanel` which can
be used together with the :class:`~lib.pdfviewer.viewer.pdfViewer`.
This module provides the :class:`~lib.pdfviewer.buttonpanel.pdfButtonPanel`
which can be used together with the :class:`~lib.pdfviewer.viewer.pdfViewer`.
"""
import sys, os, time
@@ -24,8 +24,9 @@ import wx.lib.agw.buttonpanel as bp
class pdfButtonPanel(bp.ButtonPanel):
"""
:class:`pdfButtonPanel` is derived from :class:`~lib.agw.buttonpanel` and provides
buttons to manipulate the viewed PDF, e.g. zoom, save, print etc.
:class:`~lib.pdfviewer.buttonpanel.pdfButtonPanel` is derived
from wx.lib.agw.buttonpanel and provides buttons to manipulate the viewed
PDF, e.g. zoom, save, print etc.
"""
def __init__(self, parent, id, pos, size, style):
"""