pyqtribbon.titlewidget module

class pyqtribbon.titlewidget.RibbonApplicationButton

Bases: QToolButton

Application button in the ribbon bar.

addFileMenu() → RibbonMenu

Add a new ribbon menu to the application button.

Returns:

The new ribbon menu.

class pyqtribbon.titlewidget.RibbonTitleLabel

Bases: QLabel

Title label in the ribbon bar.

class pyqtribbon.titlewidget.RibbonTitleWidget(title='PyQtRibbon', parent=None)

class pyqtribbon.titlewidget.RibbonTitleWidget(parent=None)

Bases: QFrame

The title widget of the ribbon.

Initialize the ribbon title widget.

Parameters:

• title – The title of the ribbon.

• parent – The parent widget.

addQuickAccessButton(button: QToolButton)

Add a widget to the quick access bar.

Parameters:

button – The button to add.

addRightToolButton(button: QToolButton)

Add a widget to the right button bar.

Parameters:

button – The button to add.

addTitleWidget(widget: QWidget)

Add a widget to the title layout.

Parameters:

widget – The widget to add.

applicationButton() → RibbonApplicationButton

Return the application button.

collapseRibbonButton() → QToolButton

Return the collapse ribbon button.

Returns:

The collapse ribbon button.

collapseRibbonButtonClicked(bool)

Signal, the collapse button wa clicked.

helpButtonClicked(bool)

Signal, the help button was clicked.

helpRibbonButton() → QToolButton

Return the help ribbon button.

Returns:

The help ribbon button.

insertTitleWidget(index: int, widget: QWidget)

Insert a widget to the title layout.

Parameters:

• index – The index to insert the widget.

• widget – The widget to insert.

mouseDoubleClickEvent(self, a0: QMouseEvent | None)

mouseMoveEvent(self, a0: QMouseEvent | None)

mousePressEvent(self, a0: QMouseEvent | None)

quickAccessButtons() → List[QToolButton]

Return the quick access buttons of the ribbon.

Returns:

The quick access buttons of the ribbon.

quickAccessToolBar() → QToolBar

Return the quick access toolbar of the ribbon.

Returns:

The quick access toolbar of the ribbon.

removeCollapseButton()

Remove the min button from the ribbon.

removeHelpButton()

Remove the help button from the ribbon.

removeQuickAccessButton(button: QToolButton, action: QAction)

Remove a widget from the quick access bar.

Parameters:

• button – The button to remove.

• action – The widget action returned by the addQuickAccessButton method.

removeRightToolButton(button: QToolButton, action: QAction)

Remove a widget from the right button bar.

Parameters:

• button – The button to remove.

• action – The widget action returned by the addRightToolButton method.

removeTitleWidget(widget: QWidget)

Remove a widget from the title layout.

Parameters:

widget – The widget to remove.

rightToolBar() → QToolBar

Return the right toolbar of the ribbon.

Returns:

The right toolbar of the ribbon.

setApplicationIcon(icon: QIcon)

Set the application icon.

Parameters:

icon – The icon to set.

setCollapseButtonIcon(icon: QIcon)

Set the icon of the min button.

Parameters:

icon – The icon to set.

setHelpButtonIcon(icon: QIcon)

Set the icon of the help button.

Parameters:

icon – The icon to set.

setQuickAccessButtonHeight(height: int)

Set the height of the quick access buttons.

Parameters:

height – The height to set.

setRightToolBarHeight(height: int)

Set the height of the right buttons.

Parameters:

height – The height to set.

setTitle(title: str)

Set the title of the ribbon.

Parameters:

title – The title to set.

setTitleWidgetHeight(height: int)

Set the height of the title widget.

Parameters:

height – The height to set.

tabBar() → RibbonTabBar

Return the tab bar of the ribbon.

Returns:

The tab bar of the ribbon.

title() → str

Return the title of the ribbon.

Returns:

The title of the ribbon.

topLevelWidget() → QWidget