Fully qualify names for more links.

This commit is contained in:
Robin Dunn
2016-08-12 14:53:29 -07:00
parent 62e5198463
commit b4233d9299
4 changed files with 18 additions and 18 deletions

View File

@@ -13,13 +13,13 @@
#
#----------------------------------------------------------------------------
"""
:class:`~lib.pdfviewer.viewer.pdfViewer` class is derived from :class:`wx.ScrolledWindow` class
:class:`~wx.lib.pdfviewer.viewer.pdfViewer` class is derived from :class:`wx.ScrolledWindow` class
and can display and print PDF files.
Description
===========
The :class:`~lib.pdfviewer.viewer.pdfViewer` class is derived from :class:`wx.ScrolledWindow`
The :class:`~wx.lib.pdfviewer.viewer.pdfViewer` class is derived from :class:`wx.ScrolledWindow`
and can display and print PDF files. The whole file can be scrolled from
end to end at whatever magnification (zoom-level) is specified.
@@ -32,7 +32,7 @@ complete PDF rendering library that is GPL licenced.
Further details on PyMuPDF can be found via http://pythonhosted.org/PyMuPDF
PyPDF2 provides a PdfFileReader class that is used to read the content stream of a PDF
file which is subsequently rendered by :class:`~lib.pdfviewer.viewer.pdfViewer` itself.
file which is subsequently rendered by :class:`~wx.lib.pdfviewer.viewer.pdfViewer` itself.
Please note that this is not a complete implementation of the pdf specification and
will probably fail to display any random file you supply. However it does seem to
satisfactorily render files typically produced by ReportLab using Western languages.
@@ -40,8 +40,8 @@ The main limitation is that it doesn't currently support embedded fonts.
Additional details on PyPDF2 can be found via http://pythonhosted.org/PyPDF2
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
There is an optional :class:`~wx.lib.pdfviewer.buttonpanel.pdfButtonPanel` class, derived from
:class:`~wx.lib.agw.buttonpanel`, that can be placed, for example, at the top of the
scrolled viewer window, and which contains navigation and zoom controls.
Usage
@@ -92,21 +92,21 @@ Alternatively you can drive the viewer from controls in your own application.
Externally callable methods are:
:meth:`~lib.pdfviewer.viewer.pdfViewer.LoadFile`
:meth:`~wx.lib.pdfviewer.viewer.pdfViewer.LoadFile`
:meth:`~lib.pdfviewer.viewer.pdfViewer.Save`
:meth:`~wx.lib.pdfviewer.viewer.pdfViewer.Save`
:meth:`~lib.pdfviewer.viewer.pdfViewer.Print`
:meth:`~wx.lib.pdfviewer.viewer.pdfViewer.Print`
:meth:`~lib.pdfviewer.viewer.pdfViewer.SetZoom`
:meth:`~wx.lib.pdfviewer.viewer.pdfViewer.SetZoom`
:meth:`~lib.pdfviewer.viewer.pdfViewer.GoPage`
:meth:`~wx.lib.pdfviewer.viewer.pdfViewer.GoPage`
The viewer renders the pdf file content using Cairo if installed,
otherwise :class:`wx.GraphicsContext` is used. Printing is achieved by writing
directly to a :class:`wx.PrinterDC` and using :class:`wx.Printer`.
The icons used in :class:`~lib.pdfviewer.buttonpanel.pdfButtonPanel` are Free Icons
The icons used in :class:`~wx.lib.pdfviewer.buttonpanel.pdfButtonPanel` are Free Icons
by Axialis Software: http://www.axialis.com. You can freely use them in any project,
commercially or not, but you must keep the credits of the authors:
"Axialis Team", even if you modify them. See ./bitmaps/ReadMe.txt for further details.

View File

@@ -56,7 +56,7 @@ def calculate_bezier(p, steps = 30):
def compute_points(controlpoints, nsteps=30):
"""
Input 4 control points as :class:`RealPoint` and convert to vec2d instances.
Input 4 control points as :class:`wx.RealPoint` and convert to vec2d instances.
compute the nsteps points on the resulting curve and return them
as a list of :class:`wx.Point`
"""

View File

@@ -13,8 +13,8 @@
#
#----------------------------------------------------------------------------
"""
This module provides the :class:`~lib.pdfviewer.buttonpanel.pdfButtonPanel`
which can be used together with the :class:`~lib.pdfviewer.viewer.pdfViewer`.
This module provides the :class:`~wx.lib.pdfviewer.buttonpanel.pdfButtonPanel`
which can be used together with the :class:`~wx.lib.pdfviewer.viewer.pdfViewer`.
"""
import sys, os, time
@@ -24,7 +24,7 @@ import wx.lib.agw.buttonpanel as bp
class pdfButtonPanel(bp.ButtonPanel):
"""
:class:`~lib.pdfviewer.buttonpanel.pdfButtonPanel` is derived
:class:`~wx.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.
"""

View File

@@ -20,7 +20,7 @@
"""
This module provides the :class:`~lib.pdfviewer.viewer.pdfViewer` to view PDF
This module provides the :class:`~wx.lib.pdfviewer.viewer.pdfViewer` to view PDF
files.
"""
@@ -778,7 +778,7 @@ class pypdfProcessor(object):
def SetFont(self, pdfont, size):
"""
Returns :class:`Font` instance from supplied pdf font information.
Returns :class:`wx.Font` instance from supplied pdf font information.
"""
self.knownfont = True
pdfont = pdfont.lower()
@@ -1085,7 +1085,7 @@ class pdfPrintout(wx.Printout):
def PrintDirect(self, page):
"""
Provide the data for page by rendering the drawing commands
to the printer DC using :class:`~lib.pdfviewer.dcgraphics.dcGraphicsContext`.
to the printer DC using :class:`~wx.lib.pdfviewer.dcgraphics.dcGraphicsContext`.
"""
pageno = page - 1 # zero based
width = self.view.pagewidth