diff --git a/wx/lib/pdfviewer/__init__.py b/wx/lib/pdfviewer/__init__.py index db2da7cd..d2c162b9 100644 --- a/wx/lib/pdfviewer/__init__.py +++ b/wx/lib/pdfviewer/__init__.py @@ -13,13 +13,13 @@ # #---------------------------------------------------------------------------- """ -:class:`pdfViewer` class is derived from :class:`ScrolledWindow` class +:class:`~lib.pdfviewer.viewer.pdfViewer` class is derived from :class:`ScrolledWindow` class and can display and print PDF files. Description =========== -The :class:`pdfViewer` class is derived from :class:`ScrolledWindow` +The :class:`~lib.pdfviewer.viewer.pdfViewer` class is derived from :class:`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. @@ -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:`pdfButtonPanel` class, derived from +There is an optional :class:`~lib.pdfviewer.viewer.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. @@ -86,30 +86,31 @@ Sample usage:: Alternatively you can drive the viewer from controls in your own application. -Externally callable methods are: LoadFile, Save, Print, SetZoom, and GoPage +Externally callable methods are: -:meth:`viewer.LoadFile(pathname) ` +:meth:`viewer.LoadFile(pathname) <~lib.pdfviewer.viewer.pdfViewer.LoadFile>` -:meth:`viewer.Save() ` +:meth:`viewer.Save() <~lib.pdfviewer.viewer.pdfViewer.Save>` -:meth:`viewer.Print() ` +:meth:`viewer.Print() <~lib.pdfviewer.viewer.pdfViewer.Print>` -:meth:`viewer.SetZoom(zoomscale) ` +:meth:`viewer.SetZoom(zoomscale) <~lib.pdfviewer.viewer.pdfViewer.SetZoom>` -:meth:`viewer.GoPage(pagenumber) ` +:meth:`viewer.GoPage(pagenumber) <~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`. -Please note that :class:`pdfViewer` is a far from complete implementation of the -pdf specification and will probably fail to display any random file you supply. -However it does seem to be OK with the sort of files 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. +Please note that :class:`~lib.pdfviewer.viewer.pdfViewer` is a far from complete +implementation of the pdf specification and will probably fail to display any +random file you supply. However it does seem to be OK with the sort of files +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:`pdfButtonPanel` are Free Icons by Axialis Software: -http://www.axialis.com +The icons used in :class:`~lib.pdfviewer.viewer.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: diff --git a/wx/lib/pdfviewer/buttonpanel.py b/wx/lib/pdfviewer/buttonpanel.py index 99e99d45..52d5f1d6 100644 --- a/wx/lib/pdfviewer/buttonpanel.py +++ b/wx/lib/pdfviewer/buttonpanel.py @@ -13,8 +13,8 @@ # #---------------------------------------------------------------------------- """ -This module provides the :class:`pdfButtonPanel` which can be used together -with the :class:`pdfViewer`. +This module provides the :class:`~lib.pdfviewer.viewer.pdfButtonPanel` which can +be used together with the :class:`~lib.pdfviewer.viewer.pdfViewer`. """ import sys, os, time diff --git a/wx/lib/pdfviewer/viewer.py b/wx/lib/pdfviewer/viewer.py index 1686e1db..59c1f232 100644 --- a/wx/lib/pdfviewer/viewer.py +++ b/wx/lib/pdfviewer/viewer.py @@ -18,7 +18,8 @@ # #---------------------------------------------------------------------------- """ -This module provides the :class:`pdfViewer` to view PDF files. +This module provides the :class:`~lib.pdfviewer.viewer.pdfViewer` to view PDF +files. """ import sys, os, time, types