Package schrodinger :: Package ui :: Package qt :: Module appframework :: Class DontShowAgainDialog

Class DontShowAgainDialog

       object --+                        
                |                        
sip.simplewrapper --+                    
                    |                    
          sip.wrapper --+                
                        |                
     PyQt5.QtCore.QObject --+            
                            |            
           object --+       |            
                    |       |            
    sip.simplewrapper --+   |            
                        |   |            
 PyQt5.QtGui.QPaintDevice --+            
                            |            
      PyQt5.QtWidgets.QWidget --+        
                                |        
          PyQt5.QtWidgets.QDialog --+    
                                    |    
          PyQt5.QtWidgets.QMessageBox --+
                                        |
                                       DontShowAgainDialog

Dialog that displays information for the user and contains a Don't Show This again checkbox

To use this class from an AppFramework panel:

   from schrodinger.utils import preferences
   prefs = preferences.Preferences(preferences.SCRIPTS)
   prefs.beginGroup('my_script_name')
   self.warning('my message', preferences=prefs, key='large_st_warning')

To use this class outside of appframework:

   from schrodinger.utils import preferences
   prefs = preferences.Preferences(preferences.SCRIPTS)
   prefs.beginGroup('my_script_name')
   box = DontShowAgainDialog(parent=self, message='my message',
                             kind=appframework.WARNING,
                             preferences=prefs, key='large_st_warning')
   box.exec_()

Nested Classes

[hide private]

Inherited from PyQt5.QtWidgets.QMessageBox: ButtonRole, Icon, StandardButton, StandardButtons

Inherited from PyQt5.QtWidgets.QDialog: DialogCode

Inherited from PyQt5.QtWidgets.QWidget: RenderFlag, RenderFlags

Inherited from PyQt5.QtGui.QPaintDevice: PaintDeviceMetric

Instance Methods

[hide private]

__init__(self, parent=None, caption=None, message='', kind=None, preferences=None, key='')
Create a DontShowAgainDialog instance

accept(self)
Set the Show Again preference as the user requests.

int or None

exec_(self)
Show the dialog if the preference requests it

Inherited from PyQt5.QtWidgets.QMessageBox: about, aboutQt, addButton, button, buttonClicked, buttonRole, buttons, changeEvent, checkBox, clickedButton, closeEvent, critical, defaultButton, detailedText, escapeButton, event, icon, iconPixmap, information, informativeText, keyPressEvent, open, question, removeButton, resizeEvent, setCheckBox, setDefaultButton, setDetailedText, setEscapeButton, setIcon, setIconPixmap, setInformativeText, setStandardButtons, setText, setTextFormat, setTextInteractionFlags, setWindowModality, setWindowTitle, showEvent, standardButton, standardButtons, standardIcon, text, textFormat, textInteractionFlags, warning

Inherited from PyQt5.QtWidgets.QDialog: accepted, contextMenuEvent, done, eventFilter, finished, isSizeGripEnabled, minimumSizeHint, reject, rejected, result, setModal, setResult, setSizeGripEnabled, setVisible, sizeHint

Inherited from PyQt5.QtWidgets.QWidget: acceptDrops, accessibleDescription, accessibleName, actionEvent, actions, activateWindow, addAction, addActions, adjustSize, autoFillBackground, backgroundRole, baseSize, childAt, childrenRect, childrenRegion, clearFocus, clearMask, close, contentsMargins, contentsRect, contextMenuPolicy, create, createWindowContainer, cursor, customContextMenuRequested, destroy, devType, dragEnterEvent, dragLeaveEvent, dragMoveEvent, dropEvent, effectiveWinId, ensurePolished, enterEvent, find, focusInEvent, focusNextChild, focusNextPrevChild, focusOutEvent, focusPolicy, focusPreviousChild, focusProxy, focusWidget, font, fontInfo, fontMetrics, foregroundRole, frameGeometry, frameSize, geometry, getContentsMargins, grab, grabGesture, grabKeyboard, grabMouse, grabShortcut, graphicsEffect, graphicsProxyWidget, hasFocus, hasHeightForWidth, hasMouseTracking, height, heightForWidth, hide, hideEvent, initPainter, inputMethodEvent, inputMethodHints, inputMethodQuery, insertAction, insertActions, isActiveWindow, isAncestorOf, isEnabled, isEnabledTo, isFullScreen, isHidden, isLeftToRight, isMaximized, isMinimized, isModal, isRightToLeft, isVisible, isVisibleTo, isWindow, isWindowModified, keyReleaseEvent, keyboardGrabber, layout, layoutDirection, leaveEvent, locale, lower, mapFrom, mapFromGlobal, mapFromParent, mapTo, mapToGlobal, mapToParent, mask, maximumHeight, maximumSize, maximumWidth, metric, minimumHeight, minimumSize, minimumWidth, mouseDoubleClickEvent, mouseGrabber, mouseMoveEvent, mousePressEvent, mouseReleaseEvent, move, moveEvent, nativeEvent, nativeParentWidget, nextInFocusChain, normalGeometry, overrideWindowFlags, overrideWindowState, paintEngine, paintEvent, palette, parentWidget, pos, previousInFocusChain, raise_, rect, releaseKeyboard, releaseMouse, releaseShortcut, removeAction, render, repaint, resize, 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, setInputMethodHints, setLayout, setLayoutDirection, setLocale, setMask, setMaximumHeight, setMaximumSize, setMaximumWidth, setMinimumHeight, setMinimumSize, setMinimumWidth, setMouseTracking, setPalette, setParent, setShortcutAutoRepeat, setShortcutEnabled, setSizeIncrement, setSizePolicy, setStatusTip, setStyle, setStyleSheet, setTabOrder, setToolTip, setToolTipDuration, setUpdatesEnabled, setWhatsThis, setWindowFilePath, setWindowFlags, setWindowIcon, setWindowIconText, setWindowModified, setWindowOpacity, setWindowRole, setWindowState, sharedPainter, show, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeIncrement, sizePolicy, stackUnder, statusTip, style, styleSheet, tabletEvent, testAttribute, toolTip, toolTipDuration, underMouse, ungrabGesture, unsetCursor, unsetLayoutDirection, unsetLocale, update, updateGeometry, updateMicroFocus, updatesEnabled, visibleRegion, whatsThis, wheelEvent, width, winId, window, windowFilePath, windowFlags, windowHandle, windowIcon, windowIconChanged, windowIconText, windowIconTextChanged, windowModality, windowOpacity, windowRole, windowState, windowTitle, windowTitleChanged, windowType, x, y

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

Inherited from PyQt5.QtGui.QPaintDevice: colorCount, depth, devicePixelRatio, devicePixelRatioF, devicePixelRatioFScale, heightMM, logicalDpiX, logicalDpiY, 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 PyQt5.QtWidgets.QMessageBox: Abort, AcceptRole, ActionRole, Apply, ApplyRole, ButtonMask, Cancel, Close, Critical, Default, DestructiveRole, Discard, Escape, FirstButton, FlagMask, Help, HelpRole, Ignore, Information, InvalidRole, LastButton, No, NoAll, NoButton, NoIcon, NoRole, NoToAll, Ok, Open, Question, RejectRole, Reset, ResetRole, RestoreDefaults, Retry, Save, SaveAll, Warning, Yes, YesAll, YesRole, YesToAll

Inherited from PyQt5.QtWidgets.QDialog: Accepted, Rejected

Inherited from PyQt5.QtWidgets.QWidget: DrawChildren, DrawWindowBackground, IgnoreMask

Inherited from PyQt5.QtCore.QObject: staticMetaObject

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, parent=None, caption=None, message=`''`, kind=None, preferences=None, key=`''`)
(Constructor)

Create a DontShowAgainDialog instance

Parameters:

parent (QWidget) - The parent of this dialog
caption (str) - The window title. By default window title is Info, Warning, or Error for kind=INFO, WARNING or CRITICAL, and Message for kind=anything else.
message (str) - The information to display in the dialog
kind (str) - Module constants INFORMATION, WARNING or CRITICAL
preferences (schrodinger.utils.preferences.Preferences object) - The Preferences class to use to store the show/don't show preference for this dialog. Note that the Preferences object must currently be set to the preference group containing key.
key (str) - The key to store the preference under

Overrides: object.__init__

accept(self)

Set the Show Again preference as the user requests.

Overrides: PyQt5.QtWidgets.QDialog.accept

exec_(self)

Show the dialog if the preference requests it

Returns: int or None: 0 if the dialog was canceled, 1 if it was accepted, and None if the dialog was not shown due to user preference.
Overrides: PyQt5.QtWidgets.QDialog.exec_

Class DontShowAgainDialog

__init__(self, parent=None, caption=None, message='', kind=None, preferences=None, key='') (Constructor)

accept(self)

exec_(self)

init(self, parent=None, caption=None, message=`''`, kind=None, preferences=None, key=`''`)
(Constructor)