Package schrodinger :: Package utils :: Module openpdf
[hide private]
[frames] | no frames]

Module openpdf

Display a PDF file.

Copyright Schrodinger, LLC. All rights reserved.

Functions [hide private]
 
warning(message)
 
open_pdf(page, framework=None, must_be_acro=False)
Open a PDF file in a PDF reader.
Variables [hide private]
  __doc__ = ...
  maestro = None
hash(x)
  _pdf_viewers = ['kpdf', 'acroread', 'evince', 'xpdf', 'ggv']
  __package__ = 'schrodinger.utils'
Function Details [hide private]

open_pdf(page, framework=None, must_be_acro=False)

 

Open a PDF file in a PDF reader.

- It first checks environment variable SCHRODINGER_PDF_VIEWER
  If it can find the program, use it.
- If it cannot, then have it try to use the following in the following
  order listed in the _pdf_viewers variable, except on Mac OS X, where
  it will use the default application, usually Preview.app.

@type page: str
@param page: path to a .pdf file to open

@type framework: schrodinger.ui.qt.appframework.AppFramework instance
@param framework: If this is running under an AppFramework gui outside 
of Maestro, this is the gui Instance that has a 'warning' method used 
to display warning messages.  Leave as the default None if running 
under Maestro or without an AppFramework (or some other GUI with 
a 'warning' method to display warnings) instance.

@type must_be_acro: bool
@param must_be_acro: True if this routine should only use AcroReader to
open the file - useful for .pdx search files that only AcroReader reads.

@rtype: bool
@return: True if the file was successfully opened, False if not


Variables Details [hide private]

__doc__

Value:
"""
Display a PDF file.

Copyright Schrodinger, LLC. All rights reserved.
"""