pyqtribbon.category

Module Contents

Classes

RibbonCategoryStyle	The button style of a category.
RibbonCategoryLayoutButton	Previous/Next buttons in the category when the
RibbonCategoryScrollArea	Scroll area for the gallery
RibbonCategoryScrollAreaContents	Scroll area contents for the gallery
RibbonCategoryLayoutWidget	The category layout widget's category scroll area to arrange the widgets in the category.
RibbonCategory	The RibbonCategory is the logical grouping that represents the contents of a ribbon tab.
RibbonNormalCategory	A normal category.
RibbonContextCategory	A context category.
RibbonContextCategories	A list of context categories.

class pyqtribbon.category.RibbonCategoryStyle

Bases: enum.IntEnum

The button style of a category.

class pyqtribbon.category.RibbonCategoryLayoutButton

Bases: qtpy.QtWidgets.QToolButton

Previous/Next buttons in the category when the size is not enough for the widgets.

class pyqtribbon.category.RibbonCategoryScrollArea

Bases: qtpy.QtWidgets.QScrollArea

Scroll area for the gallery

class pyqtribbon.category.RibbonCategoryScrollAreaContents

Bases: qtpy.QtWidgets.QFrame

Scroll area contents for the gallery

class pyqtribbon.category.RibbonCategoryLayoutWidget(parent=None)

Bases: qtpy.QtWidgets.QFrame

The category layout widget’s category scroll area to arrange the widgets in the category.

paintEvent(a0: qtpy.QtGui.QPaintEvent) → None

Override the paint event to draw the background.

resizeEvent(a0: qtpy.QtGui.QResizeEvent) → None

Override the resize event to resize the scroll area.

autoSetScrollButtonsVisible()

Set the visibility of the scroll buttons.

scrollPrevious()

Scroll the category to the previous widget.

scrollNext()

Scroll the category to the next widget.

addWidget(widget: qtpy.QtWidgets.QWidget)

Add a widget to the category layout.

Parameters:

widget – The widget to add.

removeWidget(widget: qtpy.QtWidgets.QWidget)

Remove a widget from the category layout.

Parameters:

widget – The widget to remove.

takeWidget(widget: qtpy.QtWidgets.QWidget) → qtpy.QtWidgets.QWidget

Remove and return a widget from the category layout.

Parameters:

widget – The widget to remove.

Returns:

The widget that was removed.

class pyqtribbon.category.RibbonCategory(title: str = '', style: RibbonCategoryStyle = RibbonCategoryStyle.Normal, color: qtpy.QtGui.QColor = None, parent=None)           RibbonCategory(parent=None)

Bases: RibbonCategoryLayoutWidget

The RibbonCategory is the logical grouping that represents the contents of a ribbon tab.

setMaximumRows(rows: int)

Set the maximum number of rows.

Parameters:

rows – The maximum number of rows.

title() → str

Return the title of the category.

setCategoryStyle(style: RibbonCategoryStyle)

Set the button style of the category.

Parameters:

style – The button style.

categoryStyle() → RibbonCategoryStyle

Return the button style of the category.

Returns:

The button style.

addPanelsBy(data: Dict[str, Dict]) → Dict[str, pyqtribbon.panel.RibbonPanel]

Add panels from a dictionary.

Parameters:

data –

The dictionary. The keys are the titles of the panels. The value is a dictionary of arguments. the argument showPanelOptionButton is a boolean to decide whether to show the panel option button, the rest arguments are passed to the RibbonPanel.addWidgetsBy() method. The dict is of the form:

{
    "panel-title": {
        "showPanelOptionButton": True,
        "widgets": {
            "widget-name": {
                "type": "Button",
                "arguments": {
                    "key1": "value1",
                    "key2": "value2"
                }
            },
        }
    },
}

Returns:

A dictionary of the newly created panels.

addPanel(title: str, showPanelOptionButton=True) → pyqtribbon.panel.RibbonPanel

Add a new panel to the category.

Parameters:

• title – The title of the panel.

• showPanelOptionButton – Whether to show the panel option button.

Returns:

The newly created panel.

removePanel(title: str)

Remove a panel from the category.

Parameters:

title – The title of the panel.

takePanel(title: str) → pyqtribbon.panel.RibbonPanel

Remove and return a panel from the category.

Parameters:

title – The title of the panel.

Returns:

The removed panel.

panel(title: str) → pyqtribbon.panel.RibbonPanel

Return a panel from the category.

Parameters:

title – The title of the panel.

Returns:

The panel.

panels() → Dict[str, pyqtribbon.panel.RibbonPanel]

Return all panels in the category.

Returns:

The panels.

class pyqtribbon.category.RibbonNormalCategory(title: str, parent: qtpy.QtWidgets.QWidget)

Bases: RibbonCategory

A normal category.

setCategoryStyle(style: RibbonCategoryStyle)

Set the button style of the category.

Parameters:

style – The button style.

class pyqtribbon.category.RibbonContextCategory(title: str, color: qtpy.QtGui.QColor, parent: qtpy.QtWidgets.QWidget)

Bases: RibbonCategory

A context category.

setCategoryStyle(style: RibbonCategoryStyle)

Set the button style of the category.

Parameters:

style – The button style.

color() → qtpy.QtGui.QColor

Return the color of the context category.

Returns:

The color of the context category.

setColor(color: qtpy.QtGui.QColor)

Set the color of the context category.

Parameters:

color – The color of the context category.

showContextCategory()

Show the given category, if it is not a context category, nothing happens.

hideContextCategory()

Hide the given category, if it is not a context category, nothing happens.

categoryVisible() → bool

Return whether the category is shown.

Returns:

Whether the category is shown.

setCategoryVisible(visible: bool)

Set the state of the category.

Parameters:

visible – The state.

class pyqtribbon.category.RibbonContextCategories(name: str, color: qtpy.QtGui.QColor, categories: Dict[str, RibbonContextCategory], ribbon)

Bases: Dict[str, RibbonContextCategory]

A list of context categories.

name() → str

Return the name of the context categories.

setName(name: str)

Set the name of the context categories.

color() → qtpy.QtGui.QColor

Return the color of the context categories.

setColor(color: qtpy.QtGui.QColor)

Set the color of the context categories.

showContextCategories()

Show the categories

hideContextCategories()

Hide the categories

categoriesVisible() → bool

Return whether the categories are shown.

setCategoriesVisible(visible: bool)

Set the state of the categories.