Package node_manager_fkie :: Module parameter_dialog :: Class ParameterDialog
[frames] | no frames]

Class ParameterDialog

source code

       object --+                    
                |                    
sip.simplewrapper --+                
                    |                
          sip.wrapper --+            
                        |            
     PyQt5.QtCore.QObject --+        
                            |        
           object --+       |        
                    |       |        
    sip.simplewrapper --+   |        
                        |   |        
 PyQt5.QtGui.QPaintDevice --+        
                            |        
      PyQt5.QtWidgets.QWidget --+    
                                |    
          PyQt5.QtWidgets.QDialog --+
                                    |
                                   ParameterDialog
Known Subclasses:

This dialog creates an input mask for the given parameter and their types.

Nested Classes

Inherited from PyQt5.QtWidgets.QDialog: DialogCode

Inherited from PyQt5.QtWidgets.QWidget: RenderFlag, RenderFlags

Inherited from PyQt5.QtGui.QPaintDevice: PaintDeviceMetric

Instance Methods
 
__init__(self, params={}, buttons=<PyQt5.QtWidgets.StandardButtons object>, sidebar_var='', parent=None)
Creates an input dialog.
source code
 
__del__(self) source code
 
showLoadSaveButtons(self) source code
 
setFilterVisible(self, val)
Shows or hides the filter row.
source code
 
add_warning(self, message) source code
 
setText(self, text)
Adds a label to the dialog's layout and shows the given text.
source code
 
setInfoActive(self, val)
Activates or deactivates the info field of this dialog.
source code
 
setFocusField(self, field_label) source code
dict(str(param) : str(value))
getKeywords(self, only_changed=False)
Returns: a directory with parameter and value for all entered fields.
source code
 
keywords2params(self, keywords)
Resolves the dictionary values to ROS parameter names.
source code
 
accept(self) source code
 
reject(self) source code
 
hideEvent(self, event) source code
 
closeEvent(self, event)
Test the open files for changes and save this if needed.
source code

Inherited from PyQt5.QtWidgets.QDialog: accepted, contextMenuEvent, done, eventFilter, exec_, finished, isSizeGripEnabled, keyPressEvent, minimumSizeHint, open, rejected, resizeEvent, result, setModal, setResult, setSizeGripEnabled, setVisible, showEvent, sizeHint

Inherited from PyQt5.QtWidgets.QWidget: acceptDrops, accessibleDescription, accessibleName, actionEvent, actions, activateWindow, addAction, addActions, adjustSize, autoFillBackground, backgroundRole, baseSize, changeEvent, childAt, childrenRect, childrenRegion, clearFocus, clearMask, close, contentsMargins, contentsRect, contextMenuPolicy, create, createWindowContainer, cursor, customContextMenuRequested, destroy, devType, dragEnterEvent, dragLeaveEvent, dragMoveEvent, dropEvent, effectiveWinId, ensurePolished, enterEvent, event, 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, 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, setWindowModality, setWindowModified, setWindowOpacity, setWindowRole, setWindowState, setWindowTitle, 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, 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

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, PdmDpiX, PdmDpiY, PdmHeight, PdmHeightMM, PdmNumColors, PdmPhysicalDpiX, PdmPhysicalDpiY, PdmWidth, PdmWidthMM

Properties

Inherited from object: __class__

Method Details

__init__(self, params={}, buttons=<PyQt5.QtWidgets.StandardButtons object>, sidebar_var='', parent=None)
(Constructor)

source code 

Creates an input dialog.

Parameters:
  • params (dict(str:(str, {value, [..], dict()}))) - a dictionary with parameter names and (type, values). The value, can be a primitive value, a list with values or parameter dictionary to create groups. In this case the type is the name of the group.
Overrides: object.__init__

setText(self, text)

source code 

Adds a label to the dialog's layout and shows the given text.

Parameters:
  • text (str) - the text to add to the dialog

setInfoActive(self, val)

source code 

Activates or deactivates the info field of this dialog. If info field is activated, the filter frame and the input field are deactivated.

Parameters:
  • val (bool)

getKeywords(self, only_changed=False)

source code 
Parameters:
  • only_changed (bool (Default: False)) - requests only changed parameter
Returns: dict(str(param) : str(value))
a directory with parameter and value for all entered fields.

keywords2params(self, keywords)

source code 

Resolves the dictionary values to ROS parameter names.

Parameters:
  • keywords - the result of the getKeywords
Returns:
dictionary of (ROS parameter name : value)

accept(self)

source code 
Overrides: PyQt5.QtWidgets.QDialog.accept

reject(self)

source code 
Overrides: PyQt5.QtWidgets.QDialog.reject

hideEvent(self, event)

source code 
Overrides: PyQt5.QtWidgets.QWidget.hideEvent

closeEvent(self, event)

source code 

Test the open files for changes and save this if needed.

Overrides: PyQt5.QtWidgets.QWidget.closeEvent