krita.sceditor.dockwidget.DockWidgetTitleBar Class Reference

Inheritance diagram for krita.sceditor.dockwidget.DockWidgetTitleBar:

Public Member Functions
	__init__ (self, dockWidget)
	featuresChanged (self, features)
	minimumSizeHint (self)
	paintEvent (self, event)
	resizeEvent (self, event)
	setCollapsed (self, collapsed)
	setCollapsedIcon (self, flag)
	sizeHint (self)
	toggleCollapsed (self)
	toggleFloating (self)
	togglePinned (self, checked)

Public Attributes
	closeButton
	closeIcon
	collapseButton
	featuresChanged
	floatButton
	openIcon
	pinButton
	pinIcon
	toggleCollapsed
	toggleFloating
	togglePinned

Detailed Description

Definition at line 80 of file dockwidget.py.

Constructor & Destructor Documentation

__init__()

krita.sceditor.dockwidget.DockWidgetTitleBar.__init__	(		self,
			dockWidget )

Definition at line 83 of file dockwidget.py.

    def __init__(self, dockWidget):
        QWidget.__init__(self, dockWidget)
        self.openIcon = QIcon(":arrow-down.png")
        self.closeIcon = QIcon(":arrow-right.png")
        self.pinIcon = QIcon(":pin.png")
        q = dockWidget
        self.floatButton = DockWidgetTitleBarButton(self)
        self.floatButton.setIcon(q.style().standardIcon(
            QStyle.StandardPixmap.SP_TitleBarNormalButton, None, q))
        self.floatButton.clicked.connect(self.toggleFloating)
        self.floatButton.setVisible(True)
        self.closeButton = DockWidgetTitleBarButton(self)
        self.closeButton.setIcon(q.style().standardIcon(
            QStyle.StandardPixmap.SP_TitleBarCloseButton, None, q))
        self.closeButton.clicked.connect(dockWidget.close)
        self.closeButton.setVisible(True)
        self.collapseButton = DockWidgetTitleBarButton(self)
        self.collapseButton.setIcon(self.openIcon)
        self.collapseButton.clicked.connect(self.toggleCollapsed)
        self.collapseButton.setVisible(True)
        self.pinButton = DockWidgetTitleBarButton(self)
        self.pinButton.setIcon(self.pinIcon)
        self.pinButton.setCheckable(True)
        self.pinButton.setChecked(True)
        self.pinButton.clicked.connect(self.togglePinned)
        self.pinButton.setVisible(True)
        dockWidget.featuresChanged.connect(self.featuresChanged)
        self.featuresChanged(0)
 

Member Function Documentation

featuresChanged()

krita.sceditor.dockwidget.DockWidgetTitleBar.featuresChanged	(		self,
			features )

Definition at line 277 of file dockwidget.py.

    def featuresChanged(self, features):
        q = self.parentWidget()
        self.closeButton.setVisible(hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetClosable))
        self.floatButton.setVisible(hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetFloatable))
        # self.resizeEvent(None)
 
 

References KisUtilityTitleBar.closeButton, KoDockWidgetTitleBar.closeButton, krita.excepthook_ui.Ui_ExceptHookDialog.closeButton, krita.sceditor.dockwidget.DockWidgetTitleBar.closeButton, KisUtilityTitleBar.floatButton, KoDockWidgetTitleBar.floatButton, krita.sceditor.dockwidget.DockWidgetTitleBar.floatButton, krita.sceditor.dockwidget.hasFeature(), and KisScratchPadEventFilter.parentWidget().

minimumSizeHint()

krita.sceditor.dockwidget.DockWidgetTitleBar.minimumSizeHint

(

self

)

Definition at line 112 of file dockwidget.py.

    def minimumSizeHint(self):
        return self.sizeHint()
 

References KisSliderSpinBoxPrivate< SpinBoxTypeTP, BaseSpinBoxTypeTP >.sizeHint(), TabletTester.sizeHint(), KisPopupPalette.sizeHint(), SectionLayout.sizeHint(), KoToolBoxLayout.sizeHint(), KoToolBoxScrollArea.sizeHint(), KisGenericGradientEditor.sizeHint(), KisGradientColorEditor.sizeHint(), KisSegmentGradientSlider.sizeHint(), KisStopGradientSlider.sizeHint(), KisCategorizedListView.sizeHint(), KisCmbGradient.sizeHint(), KisCollapsibleButtonGroup.sizeHint(), FullSizedListView.sizeHint(), KisColorFilterCombo.sizeHint(), KisColorLabelButton.sizeHint(), KisFilterTree.sizeHint(), KisLayerFilterWidget.sizeHint(), GroupItem.sizeHint(), KisTransportControls.sizeHint(), KisUtilityTitleBar.sizeHint(), KoDualColorButton.sizeHint(), CapNJoinMenu.sizeHint(), KisColorButton.sizeHint(), KisStackedWidget.sizeHint(), KisAngleSelectorSpinBox.sizeHint(), KisLevelsSlider.sizeHint(), KoAnchorSelectionWidget.sizeHint(), KoColorPatch.sizeHint(), KoColorPopupButton.sizeHint(), KoDialog.sizeHint(), KoDockWidgetTitleBarButton.sizeHint(), KoRuler.sizeHint(), KoSliderCombo.sizeHint(), KoVBox.sizeHint(), KisMultipliersDoubleSliderSpinBox.sizeHint(), KisSliderSpinBox.sizeHint(), KisDoubleSliderSpinBox.sizeHint(), KisClickableLabel.sizeHint(), KisSqueezedComboBox.sizeHint(), KisWrappableHBoxLayout.sizeHint(), KoItemToolTip.sizeHint(), KisShortcutsDialog.sizeHint(), KisEqualizerButton.sizeHint(), KisEqualizerSlider.sizeHint(), KisAnimCurvesValuesHeader.sizeHint(), DigitalMixerPatch.sizeHint(), KisGLImageWidget.sizeHint(), StoryboardView.sizeHint(), KisColorSourceToggle.sizeHint(), WGColorPatches.sizeHint(), KDcrawIface::RArrowClickLabel.sizeHint(), KDcrawIface::RAbstractSliderSpinBox.sizeHint(), KDcrawIface::RHBox.sizeHint(), KDcrawIface::RAdjustableLabel.sizeHint(), HorizontalPaintingStrategy.sizeHint(), VerticalPaintingStrategy.sizeHint(), PaintingStrategy.sizeHint(), KisResourceItemDelegate.sizeHint(), KisStorageChooserDelegate.sizeHint(), FileItemDelegate.sizeHint(), KisWorkspaceDelegate.sizeHint(), RecentItemDelegate.sizeHint(), KisPresetDelegate.sizeHint(), KisPaletteChooserPrivate::Delegate.sizeHint(), KisPaletteDelegate.sizeHint(), KisGamutMaskDelegate.sizeHint(), KisBrushDelegate.sizeHint(), KisInputEditorDelegate.sizeHint(), KisCategorizedItemDelegate.sizeHint(), KisNewsDelegate.sizeHint(), KoLineStyleItemDelegate.sizeHint(), KoMarkerItemDelegate.sizeHint(), PinnedFontsSeparator.sizeHint(), KisShortcutsEditorDelegate.sizeHint(), KisAnimCurvesKeyDelegate.sizeHint(), NodeDelegate.sizeHint(), NodeViewVisibilityDelegate.sizeHint(), CommentDelegate.sizeHint(), StoryboardDelegate.sizeHint(), KisTasksetDelegate.sizeHint(), TableDelegate.sizeHint(), DlgBundleManager::ItemDelegate.sizeHint(), KisAnimCurvesChannelDelegate.sizeHint(), krita.sceditor.dockwidget.DockWidgetTitleBarButton.sizeHint(), krita.sceditor.dockwidget.DockWidgetTitleBar.sizeHint(), comics_project_management_tools.comics_project_page_viewer.page_viewer.sizeHint(), photobash_images.photobash_images_modulo.Photobash_Display.sizeHint(), photobash_images.photobash_images_modulo.Photobash_Button.sizeHint(), scripter.ui_scripter.editor.debugarea.DebugArea.sizeHint(), scripter.ui_scripter.editor.linenumberarea.LineNumberArea.sizeHint(), scripter.ui_scripter.editor.statusbar.StatusBar.sizeHint(), and workflow_buttons.flow_layout.FlowLayout.sizeHint().

paintEvent()

krita.sceditor.dockwidget.DockWidgetTitleBar.paintEvent	(		self,
			event )

Definition at line 142 of file dockwidget.py.

    def paintEvent(self, event):
        p = QStylePainter(self)
        q = self.parentWidget()
        if hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetVerticalTitleBar):
            fw = 1 or q.isFloating() and q.style().pixelMetric(
                QStyle.PM_DockWidgetFrameWidth, None, q) or 0
            mw = q.style().pixelMetric(QStyle.PM_DockWidgetTitleMargin, None, q)
            titleOpt = QStyleOptionDockWidget()
            titleOpt.initFrom(q)
            titleOpt.verticalTitleBar = True
            titleOpt.rect = QRect(
                QPoint(fw, fw + mw +
                       self.collapseButton.size().height() + self.pinButton.size().height()),
                QSize(
                    self.geometry().width() - (fw * 2),
                    self.geometry().height() - (fw * 2) -
                    mw - self.collapseButton.size().height() - self.pinButton.size().height()))
            titleOpt.title = q.windowTitle()
            titleOpt.closable = hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetClosable)
            titleOpt.floatable = hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetFloatable)
            p.drawControl(QStyle.CE_DockWidgetTitle, titleOpt)
        else:
            fw = q.isFloating() and q.style().pixelMetric(
                QStyle.PM_DockWidgetFrameWidth, None, q) or 0
            mw = q.style().pixelMetric(QStyle.PixelMetric.PM_DockWidgetTitleMargin, None, q)
            titleOpt = QStyleOptionDockWidget()
            titleOpt.initFrom(q)
            titleOpt.rect = QRect(
                QPoint(fw + mw +
                       self.collapseButton.size().width() + self.pinButton.size().width(), fw),
                QSize(
                    self.geometry().width() - (fw * 2) -
                    mw - self.collapseButton.size().width() - self.pinButton.size().width(),
                    self.geometry().height() - (fw * 2)))
            titleOpt.title = q.windowTitle()
            titleOpt.closable = hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetClosable)
            titleOpt.floatable = hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetFloatable)
            p.drawControl(QStyle.ControlElement.CE_DockWidgetTitle, titleOpt)
 

References krita.sceditor.dockwidget.DockWidgetTitleBar.collapseButton, KisWindowLayoutResource::Private::Window.geometry, krita.sceditor.dockwidget.hasFeature(), KisScratchPadEventFilter.parentWidget(), and krita.sceditor.dockwidget.DockWidgetTitleBar.pinButton.

resizeEvent()

krita.sceditor.dockwidget.DockWidgetTitleBar.resizeEvent	(		self,
			event )

Definition at line 181 of file dockwidget.py.

    def resizeEvent(self, event):
        q = self.parentWidget()
        if hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetVerticalTitleBar):
            fh = q.isFloating() and q.style().pixelMetric(
                QStyle.PixelMetric.PM_DockWidgetFrameWidth, None, q) or 0
            opt = QStyleOptionDockWidget()
            opt.initFrom(q)
            opt.verticalTitleBar = True
            opt.rect = QRect(
                QPoint(fh, 40),  # self.geometry().height() - (fh * 3)),
                QSize(
                    self.geometry().width() - (fh * 2),
                    fh * 2))
            opt.title = q.windowTitle()
            opt.closable = hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetClosable)
            opt.floatable = hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetFloatable)
            floatRect = q.style().subElementRect(
                QStyle.SubElement.SubElement.SE_DockWidgetFloatButton, opt, q)
            if not floatRect.isNull():
                self.floatButton.setGeometry(floatRect)
            closeRect = q.style().subElementRect(
                QStyle.SubElement.SubElement.SE_DockWidgetCloseButton, opt, q)
            if not closeRect.isNull():
                self.closeButton.setGeometry(closeRect)
            top = fh
            if not floatRect.isNull():
                top = floatRect.x()
            elif not closeRect.isNull():
                top = closeRect.x()
            size = self.collapseButton.size()
            if not closeRect.isNull():
                size = self.closeButton.size()
            elif not floatRect.isNull():
                size = self.floatButton.size()
            collapseRect = QRect(QPoint(top, fh), size)
            self.collapseButton.setGeometry(collapseRect)
            pinRect = QRect(QPoint(top, fh + collapseRect.height() + 1), size)
            self.pinButton.setGeometry(pinRect)
        else:
            fw = q.isFloating() and q.style().pixelMetric(
                QStyle.PixelMetric.PixelMetric.PM_DockWidgetFrameWidth, None, q) or 0
            opt = QStyleOptionDockWidget()
            opt.initFrom(q)
            opt.rect = QRect(
                QPoint(fw, fw),
                QSize(
                    self.geometry().width() - (fw * 2),
                    self.geometry().height() - (fw * 2)))
            opt.title = q.windowTitle()
            opt.closable = hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetFeature.DockWidgetClosable)
            opt.floatable = hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetFeature.DockWidgetFloatable)
            floatRect = q.style().subElementRect(
                QStyle.SubElement.SE_DockWidgetFloatButton, opt, q)
            if not floatRect.isNull():
                self.floatButton.setGeometry(floatRect)
            closeRect = q.style().subElementRect(
                QStyle.SubElement.SE_DockWidgetCloseButton, opt, q)
            if not closeRect.isNull():
                self.closeButton.setGeometry(closeRect)
            top = fw
            if not floatRect.isNull():
                top = floatRect.y()
            elif not closeRect.isNull():
                top = closeRect.y()
            size = self.collapseButton.size()
            if not closeRect.isNull():
                size = self.closeButton.size()
            elif not floatRect.isNull():
                size = self.floatButton.size()
            collapseRect = QRect(QPoint(fw, top), size)
            self.collapseButton.setGeometry(collapseRect)
            pinRect = QRect(QPoint(fw + collapseRect.width() + 1, top), size)
            self.pinButton.setGeometry(pinRect)
 

References KisUtilityTitleBar.closeButton, KoDockWidgetTitleBar.closeButton, krita.excepthook_ui.Ui_ExceptHookDialog.closeButton, krita.sceditor.dockwidget.DockWidgetTitleBar.closeButton, krita.sceditor.dockwidget.DockWidgetTitleBar.collapseButton, KisUtilityTitleBar.floatButton, KoDockWidgetTitleBar.floatButton, krita.sceditor.dockwidget.DockWidgetTitleBar.floatButton, KisWindowLayoutResource::Private::Window.geometry, krita.sceditor.dockwidget.hasFeature(), KisScratchPadEventFilter.parentWidget(), and krita.sceditor.dockwidget.DockWidgetTitleBar.pinButton.

setCollapsed()

krita.sceditor.dockwidget.DockWidgetTitleBar.setCollapsed	(		self,
			collapsed )

Definition at line 255 of file dockwidget.py.

    def setCollapsed(self, collapsed):
        q = self.parentWidget()
        if q and q.widget() and q.widget().isHidden() != collapsed:
            self.toggleCollapsed()
 

References KisScratchPadEventFilter.parentWidget(), krita.sceditor.dockwidget.DockWidgetTitleBar.toggleCollapsed, krita.sceditor.dockwidget.DockWidgetTitleBar.toggleCollapsed(), and krita.sceditor.dockwidget.DockWidget.toggleCollapsed().

setCollapsedIcon()

krita.sceditor.dockwidget.DockWidgetTitleBar.setCollapsedIcon	(		self,
			flag )

Definition at line 271 of file dockwidget.py.

    def setCollapsedIcon(self, flag):
        self.collapseButton.setIcon(flag and self.openIcon or self.closeIcon)
 

References krita.sceditor.dockwidget.DockWidgetTitleBar.closeIcon, krita.sceditor.dockwidget.DockWidgetTitleBar.collapseButton, and krita.sceditor.dockwidget.DockWidgetTitleBar.openIcon.

sizeHint()

krita.sceditor.dockwidget.DockWidgetTitleBar.sizeHint

(

self

)

Definition at line 115 of file dockwidget.py.

    def sizeHint(self):
        q = self.parentWidget()
        mw = q.style().pixelMetric(QStyle.PixelMetric.PM_DockWidgetTitleMargin, None, q)
        fw = q.style().pixelMetric(QStyle.PixelMetric.PM_DockWidgetFrameWidth, None, q)
        closeSize = QSize(0, 0)
        if self.closeButton:
            closeSize = self.closeButton.sizeHint()
        floatSize = QSize(0, 0)
        if self.floatButton:
            floatSize = self.floatButton.sizeHint()
        hideSize = QSize(0, 0)
        if self.collapseButton:
            hideSize = self.collapseButton.sizeHint()
        pinSize = QSize(0, 0)
        if self.pinButton:
            pinSize = self.pinButton.sizeHint()
        buttonHeight = max(max(closeSize.height(), floatSize.height()),
                           hideSize.height(), pinSize.height()) + 2
        buttonWidth = closeSize.width() + floatSize.width() + hideSize.width() + pinSize.width()
        titleFontMetrics = q.fontMetrics()
        fontHeight = titleFontMetrics.lineSpacing() + 2 * mw
        height = max(buttonHeight, fontHeight)
        width = buttonWidth + height + 4 * mw + 2 * fw
        if hasFeature(q, QDockWidget.DockWidgetFeature.DockWidgetVerticalTitleBar):
            width, height = height, width
        return QSize(width, height)
 

References KisUtilityTitleBar.closeButton, KoDockWidgetTitleBar.closeButton, krita.excepthook_ui.Ui_ExceptHookDialog.closeButton, krita.sceditor.dockwidget.DockWidgetTitleBar.closeButton, krita.sceditor.dockwidget.DockWidgetTitleBar.collapseButton, KisUtilityTitleBar.floatButton, KoDockWidgetTitleBar.floatButton, krita.sceditor.dockwidget.DockWidgetTitleBar.floatButton, krita.sceditor.dockwidget.hasFeature(), KisScratchPadEventFilter.parentWidget(), krita.sceditor.dockwidget.DockWidgetTitleBar.pinButton, and krita.sceditor.dockwidget.DockWidgetTitleBar.sizeHint().

toggleCollapsed()

krita.sceditor.dockwidget.DockWidgetTitleBar.toggleCollapsed

(

self

)

Definition at line 264 of file dockwidget.py.

    def toggleCollapsed(self):
        q = self.parentWidget()
        if not q:
            return
        q.toggleCollapsed()
        self.setCollapsedIcon(q.isCollapsed())
 

References KisScratchPadEventFilter.parentWidget(), and krita.sceditor.dockwidget.DockWidgetTitleBar.setCollapsedIcon().

toggleFloating()

krita.sceditor.dockwidget.DockWidgetTitleBar.toggleFloating

(

self

)

Definition at line 260 of file dockwidget.py.

    def toggleFloating(self):
        q = self.parentWidget()
        q.setFloating(not q.isFloating())
 

References KisScratchPadEventFilter.parentWidget().

togglePinned()

krita.sceditor.dockwidget.DockWidgetTitleBar.togglePinned	(		self,
			checked )

Definition at line 274 of file dockwidget.py.

    def togglePinned(self, checked):
        self.parent().setPinned(checked)
 

References KoShape.parent(), KisNodeDummy.parent(), KUndo2Model.parent(), KoShape::Private.parent, KoToolProxyPrivate.parent, KisForestDetail::RootNodeImpl< Node< T > >.parent, KisForestDetail::RootNodeImpl< Node< T > >< T >.parent, KisForestDetail::RootNodeImpl< Node< T > >< KoSvgTextContentElement >.parent, KisForestDetail::RootNodeImpl< Base >.parent, KisForestDetail::RootNodeImpl< Node< T > >< FontFamilyNode >.parent, KisLayerUtils::RemoveNodeHelper::ReplacementNode.parent, KisNode.parent, KisPaintDevice::Private.parent, KisMementoItem.parent(), StoryboardChild.parent(), EnhancedPathParameter.parent(), KoPathPoint.parent(), KoRTree< KoShape * >::Node.parent(), KoRTree< T >::Node.parent(), KisNode.parent(), KisProjectionLeaf.parent(), KisForestDetail::ChildIterator< T, is_const >.parent, KoFileDialog.parent, KDEPrivate::ToolBarHandler::Private.parent, FontStyleModel.parent(), KoFontGlyphModel.parent(), KisFiltersModel.parent(), KoZoomAction.parent, KisKXMLGUI::ContainerNode.parent, KisAnimCurvesChannelsModel.parent(), KisUndoModel.parent(), FontAxesModel.parent(), KisNodeModel.parent(), StoryboardModel.parent(), OpenTypeFeatureModel.parent(), mikro.PyQtClass.parent(), ExrLayerInfoBase.parent, KDcrawIface::RExpanderBox.parent, channels2layers.channels2layers.ChannelsToLayers.parent, filtermanager.components.filtermanagertreeitem.FilterManagerTreeItem.parent(), plugin_importer.plugin_importer_extension.PluginImporterExtension.parent, scripter.ui_scripter.actions.closeaction.closeaction.CloseAction.parent(), scripter.ui_scripter.actions.debugaction.debugaction.DebugAction.parent(), scripter.ui_scripter.actions.newaction.newaction.NewAction.parent(), scripter.ui_scripter.actions.openaction.openaction.OpenAction.parent(), scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.parent(), scripter.ui_scripter.actions.runaction.runaction.RunAction.parent(), scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.parent(), scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.parent(), scripter.ui_scripter.actions.settingsaction.settingsaction.SettingsAction.parent(), filtermanager.components.filtermanagertreemodel.FilterManagerTreeModel.parent(), DefaultToolTextPropertiesInterface.parent, SvgTextCursorPropertyInterface::Private.parent, and TagFilterProxyModelQmlWrapper::Private.parent.

Member Data Documentation

closeButton

krita.sceditor.dockwidget.DockWidgetTitleBar.closeButton

Definition at line 94 of file dockwidget.py.

closeIcon

krita.sceditor.dockwidget.DockWidgetTitleBar.closeIcon

Definition at line 86 of file dockwidget.py.

collapseButton

krita.sceditor.dockwidget.DockWidgetTitleBar.collapseButton

Definition at line 99 of file dockwidget.py.

featuresChanged

krita.sceditor.dockwidget.DockWidgetTitleBar.featuresChanged

Definition at line 109 of file dockwidget.py.

floatButton

krita.sceditor.dockwidget.DockWidgetTitleBar.floatButton

Definition at line 89 of file dockwidget.py.

openIcon

krita.sceditor.dockwidget.DockWidgetTitleBar.openIcon

Definition at line 85 of file dockwidget.py.

pinButton

krita.sceditor.dockwidget.DockWidgetTitleBar.pinButton

Definition at line 103 of file dockwidget.py.

pinIcon

krita.sceditor.dockwidget.DockWidgetTitleBar.pinIcon

Definition at line 87 of file dockwidget.py.

toggleCollapsed

krita.sceditor.dockwidget.DockWidgetTitleBar.toggleCollapsed

Definition at line 101 of file dockwidget.py.

toggleFloating

krita.sceditor.dockwidget.DockWidgetTitleBar.toggleFloating

Definition at line 92 of file dockwidget.py.

togglePinned

krita.sceditor.dockwidget.DockWidgetTitleBar.togglePinned

Definition at line 107 of file dockwidget.py.

---

The documentation for this class was generated from the following file:

• plugins/extensions/pykrita/plugin/krita/sceditor/dockwidget.py