Trees       Indices       Help   
2016-4 Schrodinger Python API
Package schrodinger :: Package application :: Package bioluminate :: Module protein_report_widget :: Class ReportFrame
[hide private]
[frames] | no frames]

Class ReportFrame

       object --+                    
                |                    
sip.simplewrapper --+                
                    |                
          sip.wrapper --+            
                        |            
     PyQt4.QtCore.QObject --+        
                            |        
           object --+       |        
                    |       |        
    sip.simplewrapper --+   |        
                        |   |        
 PyQt4.QtGui.QPaintDevice --+        
                            |        
          PyQt4.QtGui.QWidget --+    
                                |    
               PyQt4.QtGui.QFrame --+
                                    |
                                   ReportFrame
Known Subclasses:

A QtWidgets.QFrame that contains a Protein Report

Nested Classes [hide private]

Inherited from PyQt4.QtGui.QFrame: Shadow, Shape, StyleMask

Inherited from PyQt4.QtGui.QWidget: RenderFlag, RenderFlags

Inherited from PyQt4.QtGui.QPaintDevice: PaintDeviceMetric

Instance Methods [hide private]
 
__init__(self, parent_layout=None, update_button=True, app_parent=None, load_proteins=True)
Create a ReportFrame object
list
getSelectedDataTitles(self, model)
Returns a list of selected data titles (the value in the first column)
 
selectionChangedCallback(self, selected=None, deselected=None)
Called when table selection is changed
DataModel
getDataModelClass(self)
Returns the proper data model class to use, allows easy subclassing of the Model in report subclasses
schrodinger.structure.Structure
getStructure(self, entry_id=None)
Return the structure to report on.
 
updateTables(self, entry_id=None)
Calculate new data for the requested structure and load the data into the table.
 
exportTables(self, filename, tables_to_write)
Export the specified tables to the <filename> file.
 
setChanged(self, selected_title)
Callback for when a new set of data is requested.
 
exportCurrentTable(self)
Export only the current table.
 
exportAllTables(self)
Export all tables.
 
openHelp(self)
Display the help topic
 
closePanel(self)
Hide the panel
 
workspaceChanged(self, changed)
Keep track of when something changes in the workspace that would invalidate the current data.
 
close(self)
Close the frame, and clean up anything that needs to happen upon closing

Inherited from PyQt4.QtGui.QFrame: changeEvent, drawFrame, event, frameRect, frameShadow, frameShape, frameStyle, frameWidth, lineWidth, midLineWidth, paintEvent, setFrameRect, setFrameShadow, setFrameShape, setFrameStyle, setLineWidth, setMidLineWidth, sizeHint

Inherited from PyQt4.QtGui.QWidget: acceptDrops, accessibleDescription, accessibleName, actionEvent, actions, activateWindow, addAction, addActions, adjustSize, autoFillBackground, backgroundRole, baseSize, childAt, childrenRect, childrenRegion, clearFocus, clearMask, closeEvent, contentsMargins, contentsRect, contextMenuEvent, contextMenuPolicy, create, cursor, customContextMenuRequested, destroy, devType, dragEnterEvent, dragLeaveEvent, dragMoveEvent, dropEvent, effectiveWinId, enabledChange, ensurePolished, enterEvent, find, focusInEvent, focusNextChild, focusNextPrevChild, focusOutEvent, focusPolicy, focusPreviousChild, focusProxy, focusWidget, font, fontChange, fontInfo, fontMetrics, foregroundRole, frameGeometry, frameSize, geometry, getContentsMargins, grabGesture, grabKeyboard, grabMouse, grabShortcut, graphicsEffect, graphicsProxyWidget, handle, hasFocus, hasMouseTracking, height, heightForWidth, hide, hideEvent, inputContext, inputMethodEvent, inputMethodHints, inputMethodQuery, insertAction, insertActions, isActiveWindow, isAncestorOf, isEnabled, isEnabledTo, isEnabledToTLW, isFullScreen, isHidden, isLeftToRight, isMaximized, isMinimized, isModal, isRightToLeft, isTopLevel, isVisible, isVisibleTo, isWindow, isWindowModified, keyPressEvent, keyReleaseEvent, keyboardGrabber, languageChange, layout, layoutDirection, leaveEvent, locale, lower, mapFrom, mapFromGlobal, mapFromParent, mapTo, mapToGlobal, mapToParent, mask, maximumHeight, maximumSize, maximumWidth, metric, minimumHeight, minimumSize, minimumSizeHint, minimumWidth, mouseDoubleClickEvent, mouseGrabber, mouseMoveEvent, mousePressEvent, mouseReleaseEvent, move, moveEvent, nativeParentWidget, nextInFocusChain, normalGeometry, overrideWindowFlags, overrideWindowState, paintEngine, palette, paletteChange, parentWidget, pos, previousInFocusChain, raise_, rect, releaseKeyboard, releaseMouse, releaseShortcut, removeAction, render, repaint, resetInputContext, resize, resizeEvent, restoreGeometry, saveGeometry, scroll, setAcceptDrops, setAccessibleDescription, setAccessibleName, setAttribute, setAutoFillBackground, setBackgroundRole, setBaseSize, setContentsMargins, setContextMenuPolicy, setCursor, setDisabled, setEnabled, setFixedHeight, setFixedSize, setFixedWidth, setFocus, setFocusPolicy, setFocusProxy, setFont, setForegroundRole, setGeometry, setGraphicsEffect, setHidden, setInputContext, setInputMethodHints, setLayout, setLayoutDirection, setLocale, setMask, setMaximumHeight, setMaximumSize, setMaximumWidth, setMinimumHeight, setMinimumSize, setMinimumWidth, setMouseTracking, setPalette, setParent, setShortcutAutoRepeat, setShortcutEnabled, setShown, setSizeIncrement, setSizePolicy, setStatusTip, setStyle, setStyleSheet, setTabOrder, setToolTip, setUpdatesEnabled, setVisible, setWhatsThis, setWindowFilePath, setWindowFlags, setWindowIcon, setWindowIconText, setWindowModality, setWindowModified, setWindowOpacity, setWindowRole, setWindowState, setWindowTitle, show, showEvent, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeIncrement, sizePolicy, stackUnder, statusTip, style, styleSheet, tabletEvent, testAttribute, toolTip, topLevelWidget, underMouse, ungrabGesture, unsetCursor, unsetLayoutDirection, unsetLocale, update, updateGeometry, updateMicroFocus, updatesEnabled, visibleRegion, whatsThis, wheelEvent, width, winId, window, windowActivationChange, windowFilePath, windowFlags, windowIcon, windowIconText, windowModality, windowOpacity, windowRole, windowState, windowTitle, windowType, x, x11Info, x11PictureHandle, y

Inherited from PyQt4.QtCore.QObject: __getattr__, blockSignals, childEvent, children, connect, connectNotify, customEvent, deleteLater, destroyed, disconnect, disconnectNotify, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, emit, eventFilter, findChild, findChildren, inherits, installEventFilter, isWidgetType, killTimer, metaObject, moveToThread, objectName, parent, property, pyqtConfigure, receivers, removeEventFilter, sender, senderSignalIndex, setObjectName, setProperty, signalsBlocked, startTimer, thread, timerEvent, tr, trUtf8

Inherited from PyQt4.QtGui.QPaintDevice: colorCount, depth, heightMM, logicalDpiX, logicalDpiY, numColors, paintingActive, physicalDpiX, physicalDpiY, widthMM

Inherited from sip.simplewrapper: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from PyQt4.QtGui.QFrame: Box, HLine, NoFrame, Panel, Plain, Raised, Shadow_Mask, Shape_Mask, StyledPanel, Sunken, VLine, WinPanel

Inherited from PyQt4.QtGui.QWidget: DrawChildren, DrawWindowBackground, IgnoreMask

Inherited from PyQt4.QtCore.QObject: staticMetaObject

Inherited from PyQt4.QtGui.QPaintDevice: PdmDepth, PdmDpiX, PdmDpiY, PdmHeight, PdmHeightMM, PdmNumColors, PdmPhysicalDpiX, PdmPhysicalDpiY, PdmWidth, PdmWidthMM

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, parent_layout=None, update_button=True, app_parent=None, load_proteins=True)
(Constructor)

 

Create a ReportFrame object

Parameters:
  • parent_layout (QLayout or None) - If given the ReportFrame will add itself to this layout
  • update_button (bool) - True if the report should have an update button, False if not.
  • app_parent (schrodinger.ui.qt.appframework.AppFramework widget) - if given will be used to supply GUI dialog boxes and busy cursors
  • load_proteins (bool) - If True, the panel will attempt to load proteins when created. If False (default), not attempt is made - the widgets are merely created.
Overrides: object.__init__

getSelectedDataTitles(self, model)

 

Returns a list of selected data titles (the value in the first column)

Parameters:
  • model (DataModel) - The model the data comes from
Returns: list
list of data titles (the value in the first column) for each selected row

selectionChangedCallback(self, selected=None, deselected=None)

 

Called when table selection is changed

Parameters:
  • selected (QItemSelection) - Unused callback-required parameters
  • deselected (QItemSelection) - Unused callback-required parameters

getDataModelClass(self)

 

Returns the proper data model class to use, allows easy subclassing of the Model in report subclasses

Returns: DataModel
The CLASS used for the table data model in the report. Does not return a class instance, only the class itself.

getStructure(self, entry_id=None)

 

Return the structure to report on.

Parameters:
  • entry_id (str or None) - Entry ID of the structure to use, or None (default) if the workspace structure is to be used. If entry_id is given, the structure is taken from the project table row for that entry_id (which may be different from the current workspace structure). If entry_id is None, the workspace structure is used, but crystal structure properties are taken from the included project table row
Returns: schrodinger.structure.Structure
The structure requested

updateTables(self, entry_id=None)

 

Calculate new data for the requested structure and load the data into the table.

Parameters:
  • entry_id (str or None) - Entry ID of the structure to use, or None (default) if the workspace structure is to be used. If entry_id is given, the structure is taken from the project table row for that entry_id (which may be different from the current workspace structure). If entry_id is None, the workspace structure is used, but crystal structure properties are taken from the included project table row

exportTables(self, filename, tables_to_write)

 

Export the specified tables to the <filename> file.

Parameters:
  • filename (str) - the path to the output file
  • tables_to_write (str) - the name of the set of data to write out

setChanged(self, selected_title)

 

Callback for when a new set of data is requested. Changes the data displayed in the table. This also changes the underlying model the table uses.

Parameters:
  • selected_title (str) - The name of the set of data requested

workspaceChanged(self, changed)

 

Keep track of when something changes in the workspace that would invalidate the current data.

Parameters:
  • changed (str) - What changed in the workspace

close(self)

 

Close the frame, and clean up anything that needs to happen upon closing

Overrides: PyQt4.QtGui.QWidget.close

   Trees       Indices       Help   
2016-4 Schrodinger Python API
Generated by Epydoc 3.0.1 on Wed Oct 26 00:59:38 2016 http://epydoc.sourceforge.net