Package node_manager_fkie :: Module capability_table :: Class CapabilityHeader
[frames] | no frames]

Class CapabilityHeader

source code

       object --+                                
                |                                
sip.simplewrapper --+                            
                    |                            
          sip.wrapper --+                        
                        |                        
     PyQt5.QtCore.QObject --+                    
                            |                    
           object --+       |                    
                    |       |                    
    sip.simplewrapper --+   |                    
                        |   |                    
 PyQt5.QtGui.QPaintDevice --+                    
                            |                    
      PyQt5.QtWidgets.QWidget --+                
                                |                
           PyQt5.QtWidgets.QFrame --+            
                                    |            
  PyQt5.QtWidgets.QAbstractScrollArea --+        
                                        |        
        PyQt5.QtWidgets.QAbstractItemView --+    
                                            |    
                  PyQt5.QtWidgets.QHeaderView --+
                                                |
                                               CapabilityHeader

This class is used for visualization of robots or capabilities in header of the capability table. It is also used to manage the displayed robots or capabilities. Furthermore QtGui.QHeaderView.paintSection() method is overridden to paint the images in background of the cell.

Nested Classes

Inherited from PyQt5.QtWidgets.QHeaderView: ResizeMode

Inherited from PyQt5.QtWidgets.QAbstractItemView: CursorAction, DragDropMode, DropIndicatorPosition, EditTrigger, EditTriggers, ScrollHint, ScrollMode, SelectionBehavior, SelectionMode, State

Inherited from PyQt5.QtWidgets.QAbstractScrollArea: SizeAdjustPolicy

Inherited from PyQt5.QtWidgets.QFrame: Shadow, Shape, StyleMask

Inherited from PyQt5.QtWidgets.QWidget: RenderFlag, RenderFlags

Inherited from PyQt5.QtGui.QPaintDevice: PaintDeviceMetric

Instance Methods
 
description_requested_signal(...)
the signal is emitted by click on a header to show a description.
source code
 
__init__(self, orientation, parent=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
int
index(self, name)
Returns the index of the object stored with given name
source code
 
paintSection(self, painter, rect, logicalIndex)
The method paint the robot or capability images in the backgroud of the cell.
source code
 
mousePressEvent(self, event)
Interpret the mouse events to send the description of a robot or capability if the user click on the header.
source code
 
setDescription(self, index, cfg, name, displayed_name, robot_type, description, images)
Sets the values of an existing item to the given items.
source code
 
updateDescription(self, index, cfg, name, displayed_name, robot_type, description, images)
Sets the values of an existing item to the given items only if the current value is empty.
source code
 
removeDescription(self, index)
Removes an existing value from the header.
source code
 
insertItem(self, index)
Inserts an item at the given index into the header.
source code
int
insertSortedItem(self, name, displayed_name)
Insert the new item with given name at the sorted position and return the index of the item.
source code
[int]
removeCfg(self, cfg)
Removes the configuration entries from objects and returns the list with indexes, where the configuration was removed.
source code
int
count(self)
Returns: The count of items in the header.
source code
str
getConfigs(self, index)
Returns: The configurations assigned to the item at the given index
source code

Inherited from PyQt5.QtWidgets.QHeaderView: __len__, cascadingSectionResizes, currentChanged, dataChanged, defaultAlignment, defaultSectionSize, event, geometriesChanged, headerDataChanged, hiddenSectionCount, hideSection, highlightSections, horizontalOffset, indexAt, initStyleOption, initialize, initializeSections, isIndexHidden, isSectionHidden, isSortIndicatorShown, length, logicalIndex, logicalIndexAt, maximumSectionSize, minimumSectionSize, mouseDoubleClickEvent, mouseMoveEvent, mouseReleaseEvent, moveCursor, moveSection, offset, orientation, paintEvent, reset, resetDefaultSectionSize, resizeContentsPrecision, resizeSection, resizeSections, restoreState, rowsInserted, saveState, scrollContentsBy, scrollTo, sectionClicked, sectionCountChanged, sectionDoubleClicked, sectionEntered, sectionHandleDoubleClicked, sectionMoved, sectionPosition, sectionPressed, sectionResizeMode, sectionResized, sectionSize, sectionSizeFromContents, sectionSizeHint, sectionViewportPosition, sectionsAboutToBeRemoved, sectionsClickable, sectionsHidden, sectionsInserted, sectionsMovable, sectionsMoved, setCascadingSectionResizes, setDefaultAlignment, setDefaultSectionSize, setHighlightSections, setMaximumSectionSize, setMinimumSectionSize, setModel, setOffset, setOffsetToLastSection, setOffsetToSectionPosition, setResizeContentsPrecision, setSectionHidden, setSectionResizeMode, setSectionsClickable, setSectionsMovable, setSelection, setSortIndicator, setSortIndicatorShown, setStretchLastSection, setVisible, showSection, sizeHint, sortIndicatorChanged, sortIndicatorOrder, sortIndicatorSection, stretchLastSection, stretchSectionCount, swapSections, updateGeometries, updateSection, verticalOffset, viewportEvent, visualIndex, visualIndexAt, visualRect, visualRegionForSelection

Inherited from PyQt5.QtWidgets.QAbstractItemView: activated, alternatingRowColors, autoScrollMargin, clearSelection, clicked, closeEditor, closePersistentEditor, commitData, currentIndex, defaultDropAction, dirtyRegionOffset, doubleClicked, dragDropMode, dragDropOverwriteMode, dragEnabled, dragEnterEvent, dragLeaveEvent, dragMoveEvent, dropEvent, dropIndicatorPosition, edit, editTriggers, editorDestroyed, entered, executeDelayedItemsLayout, focusInEvent, focusNextPrevChild, focusOutEvent, hasAutoScroll, horizontalScrollMode, horizontalScrollbarAction, horizontalScrollbarValueChanged, iconSize, iconSizeChanged, indexWidget, inputMethodEvent, inputMethodQuery, itemDelegate, itemDelegateForColumn, itemDelegateForRow, keyPressEvent, keyboardSearch, model, openPersistentEditor, pressed, resizeEvent, rootIndex, rowsAboutToBeRemoved, scheduleDelayedItemsLayout, scrollDirtyRegion, scrollToBottom, scrollToTop, selectAll, selectedIndexes, selectionBehavior, selectionChanged, selectionCommand, selectionMode, selectionModel, setAlternatingRowColors, setAutoScroll, setAutoScrollMargin, setCurrentIndex, setDefaultDropAction, setDirtyRegion, setDragDropMode, setDragDropOverwriteMode, setDragEnabled, setDropIndicatorShown, setEditTriggers, setHorizontalScrollMode, setIconSize, setIndexWidget, setItemDelegate, setItemDelegateForColumn, setItemDelegateForRow, setRootIndex, setSelectionBehavior, setSelectionMode, setSelectionModel, setState, setTabKeyNavigation, setTextElideMode, setVerticalScrollMode, showDropIndicator, sizeHintForColumn, sizeHintForIndex, sizeHintForRow, startDrag, state, tabKeyNavigation, textElideMode, timerEvent, update, updateEditorData, updateEditorGeometries, verticalScrollMode, verticalScrollbarAction, verticalScrollbarValueChanged, viewOptions, viewportEntered, viewportSizeHint

Inherited from PyQt5.QtWidgets.QAbstractScrollArea: addScrollBarWidget, contextMenuEvent, cornerWidget, eventFilter, horizontalScrollBar, horizontalScrollBarPolicy, maximumViewportSize, minimumSizeHint, scrollBarWidgets, setCornerWidget, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setSizeAdjustPolicy, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportMargins, setupViewport, sizeAdjustPolicy, verticalScrollBar, verticalScrollBarPolicy, viewport, viewportMargins, wheelEvent

Inherited from PyQt5.QtWidgets.QFrame: changeEvent, drawFrame, frameRect, frameShadow, frameShape, frameStyle, frameWidth, lineWidth, midLineWidth, setFrameRect, setFrameShadow, setFrameShape, setFrameStyle, setLineWidth, setMidLineWidth

Inherited from PyQt5.QtWidgets.QWidget: acceptDrops, accessibleDescription, accessibleName, actionEvent, actions, activateWindow, addAction, addActions, adjustSize, autoFillBackground, backgroundRole, baseSize, childAt, childrenRect, childrenRegion, clearFocus, clearMask, close, closeEvent, contentsMargins, contentsRect, contextMenuPolicy, create, createWindowContainer, cursor, customContextMenuRequested, destroy, devType, effectiveWinId, ensurePolished, enterEvent, find, focusNextChild, 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, inputMethodHints, 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, mouseGrabber, move, moveEvent, nativeEvent, nativeParentWidget, nextInFocusChain, normalGeometry, overrideWindowFlags, overrideWindowState, paintEngine, 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, showEvent, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeIncrement, sizePolicy, stackUnder, statusTip, style, styleSheet, tabletEvent, testAttribute, toolTip, toolTipDuration, underMouse, ungrabGesture, unsetCursor, unsetLayoutDirection, unsetLocale, updateGeometry, updateMicroFocus, updatesEnabled, visibleRegion, whatsThis, 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, 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.QHeaderView: Custom, Fixed, Interactive, ResizeToContents, Stretch

Inherited from PyQt5.QtWidgets.QAbstractItemView: AboveItem, AllEditTriggers, AnimatingState, AnyKeyPressed, BelowItem, CollapsingState, ContiguousSelection, CurrentChanged, DoubleClicked, DragDrop, DragOnly, DragSelectingState, DraggingState, DropOnly, EditKeyPressed, EditingState, EnsureVisible, ExpandingState, ExtendedSelection, InternalMove, MoveDown, MoveEnd, MoveHome, MoveLeft, MoveNext, MovePageDown, MovePageUp, MovePrevious, MoveRight, MoveUp, MultiSelection, NoDragDrop, NoEditTriggers, NoSelection, NoState, OnItem, OnViewport, PositionAtBottom, PositionAtCenter, PositionAtTop, ScrollPerItem, ScrollPerPixel, SelectColumns, SelectItems, SelectRows, SelectedClicked, SingleSelection

Inherited from PyQt5.QtWidgets.QAbstractScrollArea: AdjustIgnored, AdjustToContents, AdjustToContentsOnFirstShow

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

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, orientation, parent=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

index(self, name)

source code 

Returns the index of the object stored with given name

Parameters:
  • name (str) - the name of the item
Returns: int
the index or -1 if the item was not found

paintSection(self, painter, rect, logicalIndex)

source code 

The method paint the robot or capability images in the backgroud of the cell.

Overrides: PyQt5.QtWidgets.QHeaderView.paintSection

mousePressEvent(self, event)

source code 

Interpret the mouse events to send the description of a robot or capability if the user click on the header.

Overrides: PyQt5.QtWidgets.QWidget.mousePressEvent

removeDescription(self, index)

source code 

Removes an existing value from the header.

Parameters:
  • index (int) - the index of the item to remove.

insertItem(self, index)

source code 

Inserts an item at the given index into the header.

Parameters:
  • index (int) - the index

insertSortedItem(self, name, displayed_name)

source code 

Insert the new item with given name at the sorted position and return the index of the item.

Parameters:
  • name (str) - the name of the new item
Returns: int
index of the inserted item

removeCfg(self, cfg)

source code 

Removes the configuration entries from objects and returns the list with indexes, where the configuration was removed.

Parameters:
  • cfg (str) - configuration to remove
Returns: [int]
the list the indexes, where the configuration was removed

count(self)

source code 
Returns: int
The count of items in the header.
Overrides: PyQt5.QtWidgets.QHeaderView.count

getConfigs(self, index)

source code 
Returns: str
The configurations assigned to the item at the given index