| Trees | Indices | Help |
|
|---|
|
|
object --+
|
sip.simplewrapper --+
|
sip.wrapper --+
|
PyQt4.QtCore.QObject --+
|
object --+ |
| |
sip.simplewrapper --+ |
| |
PyQt4.QtGui.QPaintDevice --+
|
PyQt4.QtGui.QWidget --+
|
PyQt4.QtGui.QMainWindow --+
|
AppFramework
The AppFramework class is basically a hull for applications.
With its own instance of a DialogParameters class, Application manages
Schrodinger dialogs like start, read, and write so that the programmer is
free to worry about other things. The dialogs can be manipulated at
anytime to fit the needs of the programmer (please see the DialogParameters
class below).
The Application class also comes with an instance of the JobParameters
class (jobparam). This object is intended to be used to store all GUI
settings. Please see the JobParameters class below for more information
on proper usage.
In addition to these features, the AppFramework class can take arguments
for Main Menu creation.
Supposing I wanted a menu of the form:
File Edit Help
^Save ^Options ^About
^Close ^^First Option
^^Second Option
When I create my AppFramework instance, I would pass the following keyword,
value pair:
menu = {1: ["File", "Edit", "Help"],
"File": {"Save": {"command": <command_here>},
"Close": {"command": <command_here>},
},
"Edit": {"Options": {"First Option": {"command": <command_here>},
"Second Option": {"command": <command_here>},
},
},
"Help": {"About": {"command": <command_here>},
},
}
The dictionary key 1 (int form, not string form) is the key for an ordering
list. Because dictionaries are not ordered, this is needed to specify your
prefered order.
AppFramework also manages the Bottom Button Bar. One more keyword for the
AppFramework instance is "buttons", and would appear like:
buttons = {"start": {"command": <command_here>},
"dialog": <boolean_show_dialog?>},
"read": {"command": <command_here>},
"write": {"command": <command_here>,
"dialog": <boolean_show_dialog?>},
"reset": {"command": <command_here>},
"close": {"command": <command_here>},
"help": {"command": <command_here>},
}
The six supported buttons are "start", "read", "write", "reset", "close",
and "help". Any button name for which you supply a command will be
created and placed in the correct location.
Non-default button names can be used by supplying a 'text' keyword.
You can also specify a command for start, read, and write buttons
that will be called when the button is pressed before displaying
the dialog with the 'precommand' keyword.
For example, you may want to check an input before allowing
the start dialog to appear. These functions should return 0
unless the dialog should not be displayed (nor the specified
start/read/write function called). Any function that returns a
non-zero value will halt the dialog process, and return to the GUI.
If "checkcommand" is specified, then this function will be called when
the user clicks on the Start/Write button (before closing the dialog),
and if the function returns a non-zero value, the dialog will not close.
The only argument that is given is a job name.
This callback is typically used to check for existing files based on
the user-specified jobname.
IMPORTANT: If the function returns 0, and <jobname>.maegz exists,
AppFramework will overwrite the file without asking the user. It is
up to your application to make sure the user is okay with that file
being overwritten.
Before the user supplied command is called, if there is an associated
dialog, the AppFramework presents the dialog, saves the input in the
jobparam object mentioned above. Then AppFramework calls the command.
Button configuration options are:
command - Required callback function.
precommand - Optional command called prior to displaying dialog.
Available for Start, Read, and Write dialogs.
dialog - If False, the Start or Write dialog is not displayed.
text - If used, overrides the text of the button.
Finally, there is an Input Frame that can be used. Please see that class
below for information on proper use.
@type subwindow: bool
@param subwindow: If subwindow is True, this panel will not try to start
a new QApplication instance even if running outside of Maestro (useful for
subwindows when a main window is already running).
@type dockable: bool
@param dockable: If True this instance will be dockable in Maestro.
@type dockarea: Qt QFlags (See constants at top of this module)
@param dockarea: By default this is to the right, but you can specify any
of the *DOCK_AREA constants specified in this module.
@type periodic_callback: callable
@param periodic_callback: If specified, this function will be called
periodically, a few times a second (frequency is not guaranteed).
@type config_dialog_class: ConfigDialog class or subclass of ConfigDialog
@param config_dialog_class:
This allows you to pass in custom dialogs to be used to configure your
panel.
@type help_topic: str
@param help_topic: If given, a help button will be created and connected to
the specified topic. Note that if help_topic is given, then
buttons['help']['command'] will be ignored.
@type help_product: str
@param help_product: The help product to access for help_topic. Defaults to
"Maestro". This parameter is ignored if help_topic is not given.
@type show_desres_icon: bool
@param show_desres_icon: A large amount of panels are contractually bound
to show a DE Shaw Research icon, turning this to True will automatically
add it to the bottom of the panel.
@type product_text: str
@param product_text: In panels where DE Shaw Research requires an icon
(see above), we also sometimes need to specify that parts of the technology
present were developed by Schrodinger. This option will only be used if
show_desres_icon==True.
|
|||
|
Inherited from Inherited from Inherited from |
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
| str |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
| None |
|
||
| None |
|
||
| None |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Inherited from Inherited from Inherited from Inherited from Inherited from Inherited from |
|||
|
|||
|
|||
See class docstring.
|
Returns True if the PyQt panel can be docked into Maestro mainwindow. Otherwise returns false. This function should be called only after parsing the 'dockable' argument inside the constructor. |
sets the job viewname used to filter in the monitor panel. this name defaults to the __name__ of the panel. |
Redefine the show() method to deiconize if necessary and also raise_() the panel if 'also_raise' is specified as True.
|
Setup the item <itemname> of menu <menu>. Creates the item or cascading menu. |
Sets defaults for unspecified button options and adds ellipses to the button text if it brings up a dialog. Raises a SyntaxError if no command is specified for the button in the button dictionary. |
If requested, this function adds the DESRES icon and potentially Schrodinger text information.
|
Adds a button to the bottom bar, to go to the right of Job Start buttons. Useful when you need a button on the bottom which is not standard job launching. Buttons are added from left to right in the order that this function is called.. @param text text that goes on the button @type text str @param command the slot that the button will run @param callable
|
Method for start button. Show dialog, process results, call command. |
This is a wrapper for the start command, where we disable the run button and show a status message.
|
Method for read button. Show dialog, process results, call command. |
Method for write button. Show dialog, process results, call command. |
Method for reset button. Reset file input frame, call command. |
Set the state of the specified button, e.g., self.setButtonState('start', 'disabled') The standard state is 'normal'. Raises a RuntimeError if the button doesn't exist or if the requested state can't be set. Obsolete. Please use setButtonEnabled() method instead. |
Enable / disable the specified button, e.g., self.setButtonEnabled('start', False) Raises a RuntimeError if the button doesn't exist. |
Setups up the job parameters from the state of the input frame. Do not call directly from your script. Returns True if success, False on error (after displaying an error message). |
Return the selected input source. Available values (module constants): WORKSPACE SELECTED_ENTRIES INCLUDED_ENTRIES INCLUDED_ENTRY FILE If the panel has no input frame, raises RuntimeError. |
Return the selected input file path (Python string). If the panel has no input frame, raises RuntimeError. If FILE source is not allowed, raises RuntimeError. |
Monitor the given jobid and show the monitor panel; if in maestro.
jobid - jobid of the job to monitor
showpanel - whether to bring up the Monitor panel. By default, the panel
will open if the "Open Monitor panel" preference is set.
Example:
After launching the job, use the jobid to issue the command:
<AppFramework_instance>.monitorJob(<jobid>)
|
Run the specified command under job control without freezing Maestro.
While the job is run, all panel's widgets are disabled.
Raises a RuntimeError if the job failed to complete.
If the specified program already supports running under job control,
do not specify the jobname.
If the program does NOT support running under job control, specify a
jobname to use. The job will be run in the local directory, and
stdout/stderr will be saved to <jobname>.log.
<monitor> - Whether to bring up the monitor dialog box (if the
"Open Monitor panel" Maestro preference is set)
|
Display a warning dialog with the specified text. If preferences and key are both supplied, then the dialog will contain a "Don't show this again" checkbox. Future invocations of this dialog with the same preferences and key values will obey the user's show preference.
|
Display an information dialog with the specified text. If preferences and key are both supplied, then the dialog will contain a "Don't show this again" checkbox. Future invocations of this dialog with the same preferences and key values will obey the user's show preference.
|
Display an error dialog with the specified text. If preferences and key are both supplied, then the dialog will contain a "Don't show this again" checkbox. Future invocations of this dialog with the same preferences and key values will obey the user's show preference.
|
Display a prompt dialog window with specified text. Returns True if first button (default OK) is pressed, False otherwise. |
Display a dialog asking the user whether to overwrite existing files. Returns True if user chose to overwrite, False otherwise. Optionally specify a list of files that will be overwritten if the user presses the Overwrite button. |
If any of the files in the <files> list exists, will bring up a dialog box asking the user whether they want to overwrite them. Returns True if the user chose to overwrite or if specified files do not exist. Returns False if the user cancelled. |
Open the config dialog. If settings are accepted (okay), returns the StartDialogParams, otherwise returns None. |
Set the cursor to the wait cursor. This will be an hourglass, clock or similar. Call restoreCursor() to return to the default cursor. If 'app_wide' is True then it will apply to the entire application (including Maestro if running there). If it's False then it will apply only to this panel. |
Restore the application level cursor to the default. If 'app_wide' is True then if will be restored for the entire application, if it's False, it will be just for this panel. |
Return QApplication instance which this panel is running under. If in Maestro, returns Maestro's global QApplication instance. |
Called by QApplication when the user clicked on the "x" button to close the window. Will call the user-specified close command (if specified).
|
Hide panel, if in Maestro. Otherwise close it. |
Quit the panel (even if in Maestro)
Note that the calling script needs to unset the variable that holds this
panel instance in order to truly delete the panel. For example, this
method should be subclassed as follows:
def quitPanel(self):
global mypanel # Where mypanel is the variable holding this object
appframework.AppFramework.quitPanel(self)
mypanel = None
|
Brings up an open file dialog box for selecting structure files. By default reads Maestro, SD, and PDB formats. Returns file path that is readable by StructureReader. Is user pressed cancel, empty string is returned. |
Display a progress dialog showing the progress of this job. (Any previously tracked job will no longer be tracked) job - a jobcontrol.Job object. |
Set the progress bar value (bottom of the panel) to <step> out of <total_steps> Set both to 0 to hide the progress bar. |
Method implemented for the self.timer created when jobs are run outside Maestro. This is implemented to have a periodic callback outside of the Maestro environment.
|
Override the normal processing when the panel is shown.
|
Display the help dialog (or a warning dialog if no help can be found). This function requires help_topic to have been given when the class was initialized. |
Update the job name in the panel
|
| Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Tue Apr 26 05:42:22 2016 | http://epydoc.sourceforge.net |