PyQt Fluent Widgets

https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/
Admin
PyQt-Fluent-Widgets is a comprehensive fluent design widgets library based on PyQt5 that implements...
Tokens:231,749
Snippets:1,603
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Run Demo Example

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/quick-start.rst.txt

After installation, navigate to the examples directory and run the demo script to see the widgets in action.

```python
cd examples/gallery
python demo.py
```

--------------------------------

### Install Full-Featured Version

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/quick-start.rst.txt

Use this command to install the full-featured version of the library, which includes all components.

```shell
pip install "PyQt-Fluent-Widgets[full]" -i https://pypi.org/simple/
```

--------------------------------

### Install Lite Version

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/quick-start.rst.txt

Use this command to install the lite version of the library. The AcrylicLabel component will not be available.

```shell
pip install PyQt-Fluent-Widgets -i https://pypi.org/simple/
```

--------------------------------

### Apply Theme Stylesheet Dynamically

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/theme.md.txt

Inherit StyleSheetBase and override path() to apply different QSS files based on the current theme. This example shows how to set up a stylesheet that automatically loads light or dark versions.

```python
from enum import Enum
from qfluentwidgets import StyleSheetBase, Theme, isDarkTheme, qconfig


class StyleSheet(StyleSheetBase, Enum):
    """ Style sheet  """

    MAIN_WINDOW = "main_window"

    def path(self, theme=Theme.AUTO):
        theme = qconfig.theme if theme == Theme.AUTO else theme
        return f"app/resource/qss/{theme.value.lower()}/{self.value}.qss"


class MainWindow(QWidget):

    def __init__(self, parent=None):
        super().__init__(parent=parent)

        # apply style sheet to main window
        StyleSheet.MAIN_WINDOW.apply(self)
```

--------------------------------

### Displaying a Multiline Alert String

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/common/index.html

Example of a multiline string used for displaying tips or alerts.

```python
"""
[1;33m📢 Tips:[0m QFluentWidgets Pro is now released. Click [1;96mhttps://qfluentwidgets.com/pages/pro[0m to learn more about it.
"""
```

--------------------------------

### Teaching Tip Widget

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/index.rst.txt

Documentation for the TeachingTip widget, used for guiding users through features or workflows.

```APIDOC
## Teaching Tip Widget

- **TeachingTip**: A widget used to provide guidance or highlight features to the user.
```

--------------------------------

### qconfig Configuration

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/index.rst.txt

Provides methods to get, set, and manage configuration items for the application.

```APIDOC
## qconfig

### Description
Global configuration object for the application.

### Methods
#### get(item)
Get the value of a configuration item.

#### set(item, value, save=True, copy=True)
Set the value of a configuration item.

Parameters:
- item: ConfigItem - The configuration item to set.
- value: any - The new value for the configuration item.
- save: bool - Whether to save the change to the config file (default: True).
- copy: bool - Whether to deep copy the new value (default: True).

#### toDict(serialize=True)
Convert configuration items to a dictionary.

#### save()
Save the current configuration.

#### load(file=None, config=None)
Load configuration from a file or a config object.

Parameters:
- file: str or Path - The path to the JSON config file.
- config: Config - A config object to initialize from.
```

--------------------------------

### QConfig Class Methods

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/config/index.rst.txt

Provides methods to interact with application configuration items, including getting, setting, and serializing configuration data.

```APIDOC
## QConfig.get(item)

### Description
Get the value of a configuration item.

### Method
`get`

### Parameters
#### Path Parameters
- **item** (ConfigItem) - The configuration item to retrieve the value for.

### Response
#### Success Response (200)
- **value** - The current value of the configuration item.
```

```APIDOC
## QConfig.set(item, value, save=True, copy=True)

### Description
Set the value of a configuration item.

### Method
`set`

### Parameters
#### Path Parameters
- **item** (ConfigItem) - The configuration item to set.
- **value** - The new value for the configuration item.
- **save** (bool) - Whether to save the change to the config file. Defaults to True.
- **copy** (bool) - Whether to deep copy the new value. Defaults to True.
```

```APIDOC
## QConfig.toDict(serialize=True)

### Description
Convert configuration items to a dictionary.

### Method
`toDict`

### Parameters
#### Path Parameters
- **serialize** (bool) - Whether to serialize the configuration items. Defaults to True.
```

```APIDOC
## QConfig.save()

### Description
Save the current configuration.

### Method
`save`
```

```APIDOC
## QConfig.load(file=None, config=None)

### Description
Load configuration from a file or a config object.

### Method
`load`

### Parameters
#### Path Parameters
- **file** (str or Path) - The path to the JSON config file.
- **config** (Config) - A config object to initialize from.
```

--------------------------------

### theme

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/index.rst.txt

Gets the current theme mode.

```APIDOC
## theme()

### Description
Get theme mode.

### Returns
Theme: The current theme mode (e.g., `Theme.Light`, `Theme.Dark`).
```

--------------------------------

### TeachingTip.make

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/index.rst.txt

A class method to create and show a teaching tip using a provided FlyoutViewBase. This method allows for more control over the view content.

```APIDOC
## TeachingTip.make

### Description
A class method to create and show a teaching tip using a provided FlyoutViewBase. This method allows for more control over the view content.

### Method
`make(view: FlyoutViewBase, target: QWidget, duration=1000, tailPosition=TeachingTipTailPosition.BOTTOM, parent=None, isDeleteOnClose=True)

### Parameters
#### Parameters
- **view** (FlyoutViewBase) - teaching tip view
- **target** (QWidget) - the target widget to show tip
- **duration** (int) - the time for teaching tip to display in milliseconds. If duration is less than zero, teaching tip will never disappear.
- **tailPosition** (TeachingTipTailPosition) - the position of bubble tail
- **parent** (QWidget) - parent widget
- **isDeleteOnClose** (bool) - whether delete flyout automatically when flyout is closed
```

--------------------------------

### AMTimePicker.getTime

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/index.rst.txt

Gets the current time from the AMTimePicker.

```APIDOC
## AMTimePicker.getTime

### Description
Gets the current time from the AMTimePicker.

### Method
`getTime()`
```

--------------------------------

### Teaching Tip Components

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/index.rst.txt

Widgets for providing contextual guidance and tips to users.

```APIDOC
## TeachingTip

### Description
A widget that provides contextual tips and guidance to the user.

## TeachingTipTailPosition

### Description
Specifies the position of the tail for a TeachingTip.

## TeachingTipView

### Description
A view for displaying TeachingTips.

## PopupTeachingTip

### Description
A TeachingTip that appears as a pop-up.
```

--------------------------------

### TimePicker.getTime

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/index.rst.txt

Gets the current time from the TimePicker.

```APIDOC
## TimePicker.getTime

### Description
Gets the current time from the TimePicker.

### Method
`getTime()`
```

--------------------------------

### themeColor

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/index.rst.txt

Gets the current theme color.

```APIDOC
## themeColor

### Description
Retrieves the current theme color of the application.
```

--------------------------------

### TeachingTip.create

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/index.rst.txt

Creates and displays a teaching tip with customizable content, icon, and image. It can be shown attached to a target widget and has options for closability and display duration.

```APIDOC
## TeachingTip.create

### Description
Creates and displays a teaching tip with customizable content, icon, and image. It can be shown attached to a target widget and has options for closability and display duration.

### Method
`create(target: QWidget, title: str, content: str, icon: Union[FluentIconBase, QIcon, str] = None, image: Union[str, QPixmap, QImage] = None, isClosable=True, duration=1000, tailPosition=TeachingTipTailPosition.BOTTOM, parent=None, isDeleteOnClose=True)

### Parameters
#### Parameters
- **target** (QWidget) - the target widget to show tip
- **title** (str) - the title of teaching tip
- **content** (str) - the content of teaching tip
- **icon** (Union[FluentIconBase, QIcon, str]) - the icon of teaching tip
- **image** (Union[str, QPixmap, QImage]) - the image of teaching tip
- **isClosable** (bool) - whether to show the close button
- **duraction** (int) - the time for teaching tip to display in milliseconds. If duration is less than zero, teaching tip will never disappear.
- **parent** (QWidget) - parent widget
- **isDeleteOnClose** (bool) - whether delete flyout automatically when flyout is closed
```

--------------------------------

### theme Function

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/config/index.rst.txt

Gets the current theme.

```APIDOC
## theme()

### Description
Gets the current theme.

### Returns
- **Theme**: The current theme (LIGHT, DARK, or AUTO).
```

--------------------------------

### FluentIconEngine

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/icon/index.rst.txt

A QIconEngine implementation for Fluent UI icons.

```APIDOC
## class FluentIconEngine(icon, reverse=False)

### Description
Fluent icon engine

### Parameters
- **icon**: (type not specified) - Description of the icon parameter.
- **reverse**: (bool) - Optional. Defaults to False. Whether to reverse the theme.

### Methods
- **paint(painter, rect, mode, state)**: Paints the icon.
- **clone() -> PyQt5.QtGui.QIconEngine**: Clones the icon engine.
- **pixmap(size, mode, state)**: Returns a pixmap representation of the icon.
```

--------------------------------

### getTime

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/date_time/index.rst.txt

Gets the current time from the DateTime component.

```APIDOC
## getTime()

### Description
Gets the current time.
```

--------------------------------

### TeachingTip.create

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/teaching_tip/index.rst.txt

Creates and displays a teaching tip. This is a class method.

```APIDOC
## create(target: PyQt5.QtWidgets.QWidget, title: str, content: str, icon: Union[qfluentwidgets.common.icon.FluentIconBase, PyQt5.QtGui.QIcon, str] = None, image: Union[str, PyQt5.QtGui.QPixmap, PyQt5.QtGui.QImage] = None, isClosable=True, duration=1000, tailPosition=TeachingTipTailPosition.BOTTOM, parent=None, isDeleteOnClose=True)

### Description
Creates and displays a teaching tip attached to a target widget.

### Parameters
#### Parameters
- **target** (QWidget) - The target widget to show the tip.
- **title** (str) - The title of the teaching tip.
- **content** (str) - The content of the teaching tip.
- **icon** (Union[qfluentwidgets.common.icon.FluentIconBase, PyQt5.QtGui.QIcon, str]) - The icon for the teaching tip.
- **image** (Union[str, PyQt5.QtGui.QPixmap, PyQt5.QtGui.QImage]) - The image for the teaching tip.
- **isClosable** (bool) - Whether to show the close button. Defaults to True.
- **duration** (int) - The time in milliseconds for the teaching tip to display. If less than zero, it will never disappear. Defaults to 1000.
- **tailPosition** (TeachingTipTailPosition) - The position of the bubble tail. Defaults to TeachingTipTailPosition.BOTTOM.
- **parent** (QWidget) - The parent widget. Defaults to None.
- **isDeleteOnClose** (bool) - Whether to delete the flyout automatically when it is closed. Defaults to True.
```

--------------------------------

### FluentIconBase.path

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/icon/index.rst.txt

Abstract method to get the SVG path data for the icon.

```APIDOC
## method path(theme=Theme.AUTO) -> str

### Description
Get the path of icon.

### Parameters
- **theme**: (Theme) - The theme of the icon. Defaults to Theme.AUTO.
  * `Theme.Light`: black icon
  * `Theme.DARK`: white icon
  * `Theme.AUTO`: icon color depends on `config.theme`

### Returns
- **str**: The SVG path data for the icon.
```

--------------------------------

### ALERT

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/index.rst.txt

A constant string providing a tip about QFluentWidgets Pro.

```APIDOC
ALERT = """
[1;33m📢 Tips:[0m QFluentWidgets Pro is now released. Click [1;96mhttps://qfluentwidgets.com/pages/pro[0m to learn more about it.
"""
```

--------------------------------

### HyperlinkLabel Methods

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/label/index.html

Methods for getting and setting the URL and underline visibility of the HyperlinkLabel.

```APIDOC
## HyperlinkLabel Methods

### Description
Provides functionality to interact with the HyperlinkLabel's URL and underline properties.

### Methods
- `getUrl() -> PyQt5.QtCore.QUrl`
  Returns the current URL of the hyperlink.

- `setUrl(_url : PyQt5.QtCore.QUrl | str_)`
  Sets the URL for the hyperlink. Accepts a QUrl object or a string representation of a URL.

- `isUnderlineVisible() -> bool`
  Checks if the underline for the hyperlink is currently visible.

- `setUnderlineVisible(_isVisible : bool)`
  Sets the visibility of the hyperlink's underline. Set to True to show, False to hide.
```

--------------------------------

### Define Application Configuration with ConfigItem

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/settings.html

Define application settings using ConfigItem and its subclasses. Add these to a QConfig subclass and load from a JSON file. Ensure to import necessary classes like Enum, QConfig, ConfigItem, and specific validators/serializers.

```python
from enum import Enum
from qfluentwidgets import (QConfig, ConfigItem, BoolValidator, ColorConfigItem, OptionsConfigItem, RangeConfigItem, BoolValidator, RangeValidator, OptionsValidator, EnumSerializer)


class MvQuality(Enum):
    """ MV quality enumeration class """

    FULL_HD = "Full HD"
    HD = "HD"
    SD = "SD"
    LD = "LD"

    @staticmethod
    def values():
        return [q.value for q in MvQuality]


class Config(QConfig):
    """ Config of application """

    # main window
    enableAcrylic = ConfigItem("MainWindow", "EnableAcrylic", False, BoolValidator())
    playBarColor = ColorConfigItem("MainWindow", "PlayBarColor", "#225C7F")
    themeMode = OptionsConfigItem("MainWindow", "ThemeMode", "Light", OptionsValidator(["Light", "Dark", "Auto"])), restart=True)
    recentPlaysNumber = RangeConfigItem("MainWindow", "RecentPlayNumbers", 300, RangeValidator(10, 300))

    # online
    onlineMvQuality = OptionsConfigItem("Online", "MvQuality", MvQuality.FULL_HD, OptionsValidator(MvQuality)), EnumSerializer(MvQuality))


# create config object and initialize it
cfg = Config()
qconfig.load('config/config.json', cfg)

```

--------------------------------

### qconfig Constant

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/config/index.rst.txt

The global configuration object instance.

```APIDOC
## qconfig

### Description
The global configuration object instance, typically an instance of `QConfig`.
```

--------------------------------

### StyleSheetFile

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/style_sheet/index.rst.txt

Represents a style sheet file and provides methods to get its path.

```APIDOC
## StyleSheetFile(path: str)

### Description
Style sheet file.

### Methods
#### path(theme=Theme.AUTO)
get the path of style sheet
```

--------------------------------

### qconfig

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/index.rst.txt

Global instance of QConfig.

```APIDOC
## qconfig

### Description
Global instance of `QConfig` for application-wide configuration management.
```

--------------------------------

### SystemThemeListener

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/theme_listener/index.rst.txt

Listens for system theme changes. Inherits from PyQt5.QtCore.QThread.

```APIDOC
## class SystemThemeListener

### Description
Monitors system theme changes and emits a signal when the theme is updated. This class inherits from `PyQt5.QtCore.QThread`.

### Methods

#### `__init__(self, parent=None)`
Initializes the SystemThemeListener.

- **parent** (QWidget, optional): The parent widget. Defaults to None.

#### `run(self)`
This method is the entry point for the thread's activity. It should contain the main logic for listening to system theme changes.
```

--------------------------------

### Icon Path Retrieval

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/index.rst.txt

Get the file path for an icon, with support for different themes.

```APIDOC
## path(theme=Theme.AUTO)

### Description
Get the path of icon.

### Parameters
#### Path Parameters
- **theme** (Theme) - Required - The theme of the icon. Options include `Theme.Light` (black icon), `Theme.DARK` (white icon), and `Theme.AUTO` (icon color depends on `config.theme`).
```

--------------------------------

### OpacityObject

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/animation/index.rst.txt

Represents an opacity animation property. Allows getting and setting the opacity value.

```APIDOC
## OpacityObject

### Description
Represents an opacity animation property. Allows getting and setting the opacity value.

### Methods

- **getValue()**: Returns the current opacity value.
- **setValue(opacity: float)**: Sets the opacity value for the animation.

### Attributes

- **opacity**: The current opacity value.
```

--------------------------------

### SystemThemeListener

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/index.rst.txt

Listens for system theme changes. Inherits from PyQt5.QtCore.QThread.

```APIDOC
class SystemThemeListener(parent=None)

    Bases: PyQt5.QtCore.QThread

    System theme listener

    Methods:
        run()

    Attributes:
        systemThemeChanged
```

--------------------------------

### AngleObject

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/animation/index.rst.txt

Represents an angle animation property. Allows getting and setting the angle value.

```APIDOC
## AngleObject

### Description
Represents an angle animation property. Allows getting and setting the angle value.

### Methods

- **getValue()**: Returns the current angle value.
- **setValue(angle: float)**: Sets the angle value for the animation.

### Attributes

- **angle**: The current angle value.
```

--------------------------------

### QConfig

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/index.rst.txt

Manages application-wide configurations.

```APIDOC
## QConfig

### Description
Config of app.

### Attributes
- `appRestartSig`: Signal emitted when an app restart is required.
- `themeChanged`: Signal emitted when the theme changes.
- `themeChangedFinished`: Signal emitted when the theme change is finished.
- `themeColorChanged`: Signal emitted when the theme color changes.
- `themeMode`: The current theme mode.
- `themeColor`: The current theme color.
- `fontFamilies`: The list of font families used.
- `file`: The configuration file path.

### Methods
- `get(item)`: Get the value of a config item.
- `set(item, value, save=True, copy=True)`: Set the value of a config item.
  - `item`: ConfigItem - The config item to set.
  - `value`: The new value for the config item.
  - `save`: bool - Whether to save the change to the config file.
  - `copy`: bool - Whether to deep copy the new value.
- `toDict(serialize=True)`: Convert config items to a dictionary.
- `save()`: Save the current configuration.
- `load(file=None, config=None)`: Load configuration from a file or another config object.
  - `file`: str or Path - The path of the JSON config file.
  - `config`: Config - A config object to initialize from.

### Properties
- `theme`: Get the theme mode, can be `Theme.Light` or `Theme.Dark`.
```

--------------------------------

### TeachingTipView

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/index.rst.txt

A view component for displaying teaching tips with customizable titles, content, icons, and images. It can be made closable and supports tail positioning.

```APIDOC
## class TeachingTipView

Bases: :py:obj:`qfluentwidgets.components.widgets.flyout.FlyoutView`

Teaching tip view

Parameters:
    title (str): The title of the teaching tip.
    content (str): The main content of the teaching tip.
    icon (Union[qfluentwidgets.common.icon.FluentIconBase, PyQt5.QtGui.QIcon, str], optional): An icon to display with the tip. Defaults to None.
    image (Union[str, PyQt5.QtGui.QPixmap, PyQt5.QtGui.QImage], optional): An image to display with the tip. Defaults to None.
    isClosable (bool, optional): Whether the tip can be closed by the user. Defaults to True.
    tailPosition (TeachingTipTailPosition, optional): The position of the tail for the tip. Defaults to TeachingTipTailPosition.BOTTOM.
    parent (QWidget, optional): The parent widget. Defaults to None.
```

--------------------------------

### ScaleObject

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/animation/index.rst.txt

Represents a scale animation property. Allows getting and setting the scale value.

```APIDOC
## ScaleObject

### Description
Represents a scale animation property. Allows getting and setting the scale value.

### Methods

- **getValue()**: Returns the current scale value.
- **setValue(scale: float)**: Sets the scale value for the animation.

### Attributes

- **scale**: The current scale value.
```

--------------------------------

### qrouter Instance

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/router/index.rst.txt

The global instance of the Router class.

```APIDOC
## qrouter Instance

### Description
A globally accessible instance of the `Router` class used for managing application-wide routing.

### Usage
This instance can be used to control navigation and history across different parts of the application that utilize `QStackedWidget`.
```

--------------------------------

### MessageBox

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/index.rst.txt

A message box component with a mask, suitable for displaying messages and getting user confirmation.

```APIDOC
## MessageBox

### Description
Message box.

### Methods
- `eventFilter(obj, e: PyQt5.QtCore.QEvent)`: Event filter for handling events.

### Attributes
- `yesSignal`: Signal emitted when the 'Yes' action is triggered.
- `cancelSignal`: Signal emitted when the 'Cancel' action is triggered.
```

--------------------------------

### Define Application Configuration with QConfig

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/settings.rst.txt

Define configuration items as class attributes in a QConfig subclass. Use appropriate validators and serializers for each item. Load the configuration from a JSON file using qconfig.load().

```python
class MvQuality(Enum):
    """ MV quality enumeration class """

    FULL_HD = "Full HD"
    HD = "HD"
    SD = "SD"
    LD = "LD"

    @staticmethod
    def values():
        return [q.value for q in MvQuality]


class Config(QConfig):
    """ Config of application """

    # main window
    enableAcrylic = ConfigItem("MainWindow", "EnableAcrylic", False, BoolValidator())
    playBarColor = ColorConfigItem("MainWindow", "PlayBarColor", "#225C7F")
    themeMode = OptionsConfigItem("MainWindow", "ThemeMode", "Light", OptionsValidator(["Light", "Dark", "Auto"])), restart=True)
    recentPlaysNumber = RangeConfigItem("MainWindow", "RecentPlayNumbers", 300, RangeValidator(10, 300))

    # online
    onlineMvQuality = OptionsConfigItem("Online", "MvQuality", MvQuality.FULL_HD, OptionsValidator(MvQuality), EnumSerializer(MvQuality))


# create config object and initialize it
cfg = Config()
qconfig.load('config/config.json', cfg)
```

--------------------------------

### QConfig

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/index.rst.txt

Manages application-wide configurations. Inherits from PyQt5.QtCore.QObject.

```APIDOC
class QConfig(PyQt5.QtCore.QObject)

    Config of app

    Attributes:
        appRestartSig
        themeChanged
        themeChangedFinished
        themeColorChanged
        themeMode
```

--------------------------------

### DisplayLabel

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/index.rst.txt

A label widget that displays text. It inherits from FluentLabelBase and supports setting text and getting its font.

```APIDOC
## DisplayLabel

### Description
Displays text content.

### Constructors
* `DisplayLabel(parent: QWidget = None)`
* `DisplayLabel(text: str, parent: QWidget = None)`

### Methods
* `getFont()`: Returns the font of the label.
```

--------------------------------

### IconWidget

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/index.rst.txt

An icon widget that can display an icon. It inherits from QWidget and provides methods to get and set the icon.

```APIDOC
## IconWidget

### Description
Icon widget for displaying icons.

### Constructors
* `IconWidget(parent=None)`
* `IconWidget(icon: QIcon | str | FluentIconBase, parent: QWidget = None)`

### Methods
* `getIcon() -> Union[QIcon, str, FluentIconBase]`
* `setIcon(icon: Union[str, PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase])`
* `paintEvent(e)`
```

--------------------------------

### QConfig Class

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/config/index.rst.txt

Represents the global configuration object.

```APIDOC
## QConfig

### Description
Represents the global configuration object. This class is typically instantiated once and used throughout the application to access and manage configuration settings.
```

--------------------------------

### TextEditMenu

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/menu/index.rst.txt

A specialized menu for text edits, inheriting from EditMenu. It manages selection start and length properties.

```APIDOC
## TextEditMenu

### Description
Text edit menu

### Attributes

- `selectionStart`
- `selectionLength`
```

--------------------------------

### List and View Widgets

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/index.rst.txt

Documentation for list and view widgets, including ListViews, TreeViews, and related delegates for item rendering.

```APIDOC
## List and View Widgets

Widgets for displaying collections of items in list or view formats.

### Classes

- **ListWidget**: A widget that displays a list of items.
- **ListView**: A view widget that displays items in a list format, often used with models.
- **ListItemDelegate**: A delegate for rendering items in a list view.
- **FlipView**: A widget that displays items by flipping between them.
- **HorizontalFlipView**: A flip view that animates horizontally.
- **VerticalFlipView**: A flip view that animates vertically.
- **FlipImageDelegate**: A delegate for rendering images within a flip view.
- **TableView**: A widget for displaying data in a table format.
- **TreeView**: A widget for displaying hierarchical data in a tree format.
```

--------------------------------

### LineEditMenu

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/menu/index.rst.txt

A specialized menu for line edits, inheriting from EditMenu. It manages selection start and length properties.

```APIDOC
## LineEditMenu

### Description
Line edit menu

### Attributes

- `selectionStart`
- `selectionLength`
```

--------------------------------

### StyleSheetBase

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/index.rst.txt

Base class for stylesheet management, providing methods to get stylesheet path, content, and apply it to widgets.

```APIDOC
## StyleSheetBase

### Description
Style sheet base class.

### Methods
#### path(theme=Theme.AUTO)
get the path of style sheet

#### content(theme=Theme.AUTO)
get the content of style sheet

#### apply(widget: PyQt5.QtWidgets.QWidget, theme=Theme.AUTO)
apply style sheet to widget
```

--------------------------------

### Font Management

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/index.rst.txt

Functions for managing application-wide fonts, including setting, getting, and retrieving available font families.

```APIDOC
## setFont

### Description
Sets the application-wide font.

### Signature
setFont(font: QFont)

## getFont

### Description
Gets the application-wide font.

### Signature
getFont() -> QFont

## setFontFamilies

### Description
Sets the application-wide font families.

### Signature
setFontFamilies(families: list[str])

## fontFamilies

### Description
Gets the application-wide font families.

### Signature
fontFamilies() -> list[str]

## fontStyleSheet

### Description
Gets the application-wide font stylesheet.

### Signature
fontStyleSheet() -> str
```

--------------------------------

### Layout and Sizing

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/command_bar/index.rst.txt

Methods related to the layout and sizing behavior of the command bar.

```APIDOC
## suitableWidth

### Description
Returns the suitable width for the command bar.

### Method
`suitableWidth() -> int`

## resizeToSuitableWidth

### Description
Resizes the command bar to its suitable width.

### Method
`resizeToSuitableWidth()`
```

--------------------------------

### SpinIcon Enum

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/spin_box/index.rst.txt

Represents icons used in spin controls, with methods to get icon paths based on theme.

```APIDOC
## Enum SpinIcon

Bases: :py:obj:`qfluentwidgets.common.icon.FluentIconBase`, :py:obj:`enum.Enum`

Spin icon

### Attributes

*   **UP** (str): 'Up'
*   **DOWN** (str): 'Down'

### Methods

*   **path(theme=Theme.AUTO)**
    get the path of icon

    Parameters:
    ----------
    theme: Theme
        the theme of icon
        * `Theme.Light`: black icon
        * `Theme.DARK`: white icon
        * `Theme.AUTO`: icon color depends on `config.theme`
```

--------------------------------

### Action Class

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/icon/index.rst.txt

Represents a Fluent Design action, extending PyQt5's QAction with Fluent UI icon support.

```APIDOC
## class Action(parent: PyQt5.QtCore.QObject = None, **kwargs)

Bases: :py:obj:`PyQt5.QtWidgets.QAction`

Fluent action

### Constructors
* Action(`parent`: QWidget = None, `**kwargs`)
* Action(`text`: str, `parent`: QWidget = None, `**kwargs`)
* Action(`icon`: QIcon | FluentIconBase, `parent`: QWidget = None, `**kwargs`)

### Attributes
* **fluentIcon**: Any - value: None

### Methods
* **icon()** -> PyQt5.QtGui.QIcon
* **setIcon(icon: Union[FluentIconBase, PyQt5.QtGui.QIcon])**
```

--------------------------------

### StyleSheetBase

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/index.rst.txt

Base class for all stylesheet implementations. Provides abstract methods for getting stylesheet path, content, and applying it to a widget.

```APIDOC
## StyleSheetBase

### Description
Style sheet base class. Provides abstract methods for getting stylesheet path, content, and applying it to a widget.

### Methods
- **path(theme=Theme.AUTO)**: abstractmethod
  get the path of style sheet

- **content(theme=Theme.AUTO)**
  get the content of style sheet

- **apply(widget: PyQt5.QtWidgets.QWidget, theme=Theme.AUTO)**
  apply style sheet to widget
```

--------------------------------

### PopupTeachingTip

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/index.rst.txt

A class for creating and displaying a teaching tip that pops up, associated with a specific target widget. It allows for custom durations and tail positioning.

```APIDOC
## class PopupTeachingTip

Bases: :py:obj:`TeachingTip`

Pop up teaching tip

Parameters:
    view (qfluentwidgets.components.widgets.flyout.FlyoutViewBase): The view to display as the teaching tip.
    target (PyQt5.QtWidgets.QWidget): The widget that the teaching tip is associated with.
    duration (int, optional): The duration in milliseconds before the tip automatically closes. Defaults to 1000.
    tailPosition (TeachingTipTailPosition, optional): The position of the tail for the tip. Defaults to TeachingTipTailPosition.BOTTOM.
    parent (QWidget, optional): The parent widget. Defaults to None.
    isDeleteOnClose (bool, optional): Whether to delete the popup automatically when it is closed. Defaults to True.
```

--------------------------------

### ALERT Constant

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/config/index.rst.txt

A constant string containing a tip about QFluentWidgets Pro.

```APIDOC
## ALERT

### Description
A constant string containing a tip about QFluentWidgets Pro.

### Value
```python
"""
[1;33m📢 Tips:[0m QFluentWidgets Pro is now released. Click [1;96mhttps://qfluentwidgets.com/pages/pro[0m to learn more about it.
"""
```
```

--------------------------------

### CalendarPicker

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/date_time/index.rst.txt

A calendar picker widget that allows users to select a date. It provides methods to get and set the current date, format the date display, and control the visibility of a reset button.

```APIDOC
## CalendarPicker

### Description
Calendar picker widget.

### Methods
- `getDate()`: Returns the currently selected date.
- `setDate(date: PyQt5.QtCore.QDate)`: Sets the selected date.
- `reset()`: Resets the date to its default value.
- `getDateFormat()`: Returns the current date format.
- `setDateFormat(format: Union[PyQt5.QtCore.Qt.DateFormat, str])`: Sets the date format.
- `isRestEnabled()`: Checks if the reset button is enabled.
- `setResetEnabled(isEnabled: bool)`: Sets the visibility of the reset button.
```

--------------------------------

### DWMMenu

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/menu/index.rst.txt

A QMenu subclass that supports DWM (Desktop Window Manager) shadow effects for a more visually appealing appearance.

```APIDOC
## DWMMenu

### Description
A menu with DWM shadow.

### Class
```python
class DWMMenu(title='', parent=None)
```

### Attributes
* **windowEffect**: (type not specified) - Description not specified.
```

--------------------------------

### FluentFontIconBase.icon(theme=Theme.AUTO, color=None)

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/index.html

Creates a QIcon instance based on the Fluent font icon configuration.

```APIDOC
## FluentFontIconBase.icon(theme=Theme.AUTO, color=None)

### Description
Creates a PyQt5.QtGui.QIcon instance using the current font icon settings.

### Parameters
- **theme** (Theme) - Optional - The theme of the icon (Light, Dark, or Auto).
- **color** (QColor | Qt.GlobalColor | str) - Optional - The icon color, applicable to SVG icons.
```

--------------------------------

### ModelComboBoxBase

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/model_combo_box/index.rst.txt

An abstract combo box class that forms the base for combo boxes built with data models. It provides methods for managing items, setting and getting current selections, and handling events.

```APIDOC
## Class: ModelComboBoxBase

### Description
Abstract combo box build in data model.

### Methods
- **setModel(model: PyQt5.QtCore.QAbstractItemModel)**: Sets the data model for the combo box.
- **model() -> PyQt5.QtCore.QAbstractItemModel**: Returns the current data model.
- **eventFilter(obj, e: PyQt5.QtCore.QEvent)**: Event filter for handling events.
- **insertItem(index: int, text: str, userData=None, icon: PyQt5.QtGui.QIcon = None)**: Inserts an item into the combobox at the specified index.
- **insertItems(index: int, texts: Iterable[str])**: Inserts multiple items into the combobox starting at the specified index.
- **addItem(text: str, userData=None, icon: PyQt5.QtGui.QIcon = None)**: Adds an item to the end of the combobox.
- **addItems(texts: Iterable[str])**: Adds multiple items to the end of the combobox.
- **removeItem(index: int)**: Removes the item at the specified index.
- **currentIndex() -> int**: Returns the index of the current item.
- **setCurrentIndex(index: int)**: Sets the current item by its index.
- **setText(text: str)**: Sets the text displayed in the combo box.
- **currentText() -> str**: Returns the text of the current item.
- **currentData()**: Returns the data associated with the current item.
- **setCurrentText(text: str)**: Sets the current item by its text. The text must exist in the item list.
- **setItemText(index: int, text: str)**: Sets the text of an item at a specific index.
- **itemData(index: int)**: Returns the data associated with an item at a specific index.
- **itemText(index: int)**: Returns the text of an item at a specific index.
- **itemIcon(index: int)**: Returns the icon of an item at a specific index.
- **setItemData(index: int, value, role=Qt.ItemDataRole.UserRole)**: Sets the data for an item at a specific index with a given role.
- **setItemIcon(index: int, icon: Union[str, PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase])**: Sets the icon for an item at a specific index.
- **findData(data, role=Qt.ItemDataRole.UserRole, flags=Qt.MatchFlag.MatchExactly) -> int**: Returns the index of the item containing the given data for the specified role, or -1 if not found.
- **findText(text: str, flags=Qt.MatchFlag.MatchExactly)**: Returns the index of the item containing the given text, or -1 if not found.
- **clear()**: Removes all items from the combobox.
- **count() -> int**: Returns the number of items in the combobox.
- **setMaxVisibleItems(num: int)**: Sets the maximum number of items to display when the dropdown is open.
- **maxVisibleItems() -> int**: Returns the maximum number of visible items.
```

--------------------------------

### SystemThemeListener

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/common/theme_listener/index.html

Listens for system theme changes.

```APIDOC
## class SystemThemeListener

### Description
Listens for system theme changes.

### Methods
#### `systemThemeChanged`
Signal emitted when the system theme changes.

#### `run()`
This method is part of the QThread and is executed when the thread starts. It contains the main logic for listening to system theme changes.
```

--------------------------------

### Create Custom Navigation Widget

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/navigation.md.txt

Inherit from NavigationWidget to create custom navigation menu items. Override paintEvent for custom drawing and setCompacted for compacted view behavior. This example shows how to create an avatar item.

```python
from qfluentwidgets import NavigationWidget


class AvatarWidget(NavigationWidget):
    """ Avatar widget """

    def __init__(self, parent=None):
        super().__init__(isSelectable=False, parent=parent)
        self.avatar = QImage('resource/shoko.png').scaled(
            24, 24, Qt.KeepAspectRatio, Qt.SmoothTransformation)

    def paintEvent(self, e):
        painter = QPainter(self)
        painter.setRenderHints(
            QPainter.SmoothPixmapTransform | QPainter.Antialiasing)

        painter.setPen(Qt.NoPen)

        if self.isPressed:
            painter.setOpacity(0.7)

        # draw background
        if self.isEnter:
            c = 255 if isDarkTheme() else 0
            painter.setBrush(QColor(c, c, c, 10))
            painter.drawRoundedRect(self.rect(), 5, 5)

        # draw avatar
        painter.setBrush(QBrush(self.avatar))
        painter.translate(8, 6)
        painter.drawEllipse(0, 0, 24, 24)
        painter.translate(-8, -6)

        if not self.isCompacted:
            painter.setPen(Qt.white if isDarkTheme() else Qt.black)
            font = QFont('Segoe UI')
            font.setPixelSize(14)
            painter.setFont(font)
            painter.drawText(QRect(44, 0, 255, 36), Qt.AlignVCenter, 'zhiyiYo')
```

--------------------------------

### DesktopInfoBarView Class

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/info_bar/index.rst.txt

A QWidget for displaying InfoBars on the desktop.

```APIDOC
## DesktopInfoBarView

### Description
A widget that serves as a view for displaying InfoBars on the desktop.

### Bases
:py:obj:`PyQt5.QtWidgets.QWidget`

### Parameters
- **parent** (QWidget, optional) - The parent widget. Defaults to None.
```

--------------------------------

### CalendarPicker Class

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/date_time/calendar_picker/index.rst.txt

The CalendarPicker class provides a user interface for selecting dates. It inherits from QPushButton and offers methods to get, set, and reset the selected date, as well as customize date formatting and reset button visibility.

```APIDOC
## Class: CalendarPicker

### Description
Calendar picker widget that allows users to select dates.

### Methods
- **getDate()**: Returns the currently selected date.
- **setDate(date: PyQt5.QtCore.QDate)**: Sets the selected date.
- **reset()**: Resets the selected date.
- **getDateFormat()**: Returns the current date format.
- **setDateFormat(format: Union[PyQt5.QtCore.Qt.DateFormat, str])**: Sets the date format.
- **isRestEnabled()**: Checks if the reset functionality is enabled.
- **setResetEnabled(isEnabled: bool)**: Sets the visibility of the reset button.

### Attributes
- **dateChanged**: Signal emitted when the date changes.
- **date**: The currently selected date.
- **dateFormat**: The format of the date display.
```

--------------------------------

### DWMMenu

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/index.rst.txt

A context menu with DWM (Desktop Window Manager) shadow effects.

```APIDOC
## DWMMenu

### Description
A menu with DWM shadow effects.

### Attributes
* `windowEffect`: Controls the window effect for the menu.

### Methods
* `event(e: PyQt5.QtCore.QEvent)`: Event handler for menu events.
```

--------------------------------

### SimpleMediaPlayBar

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/multimedia/media_play_bar/index.rst.txt

A simple implementation of a media play bar.

```APIDOC
## SimpleMediaPlayBar

### Description
Simple media play bar.

### Attributes
- **hBoxLayout**: The horizontal layout for the play bar.

### Methods
#### addButton(button: MediaPlayBarButton)
Adds a button to the right side of the play bar.
```

--------------------------------

### TeachingTip Class

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/teaching_tip/index.rst.txt

The main class for creating and managing teaching tips.

```APIDOC
## TeachingTip Class

### Description
Teaching tip

### Class Methods
- **make(view, target, duration=1000, tailPosition=TeachingTipTailPosition.BOTTOM, parent=None, isDeleteOnClose=True)**: Creates and returns a new TeachingTip instance.
  
  Parameters:
  - **view** (FlyoutViewBase): The teaching tip view.
  - **target** (QWidget): The target widget to show the tip near.
  - **duration** (int): The duration in milliseconds the tip will be shown (default: 1000).
  - **tailPosition** (TeachingTipTailPosition): The position of the tip's tail (default: TeachingTipTailPosition.BOTTOM).
  - **parent** (QWidget): The parent widget (default: None).
  - **isDeleteOnClose** (bool): Whether to delete the tip on close (default: True).

### Methods
- **setShadowEffect(blurRadius=35, offset=(0, 8))**: Adds a shadow effect to the teaching tip.
- **showEvent(e)**: Handles the show event.
- **closeEvent(e)**: Handles the close event.
- **eventFilter(obj, e)**: Filters events for the teaching tip.
- **addWidget(widget, stretch=0, align=Qt.AlignLeft)**: Adds a widget to the teaching tip.

### Properties
- **view**: Gets or sets the view of the teaching tip.

### Attributes
- **target**: The target widget.
- **duration**: The duration the tip is displayed.
- **isDeleteOnClose**: Flag indicating if the tip is deleted on close.
- **manager**: The manager associated with this teaching tip.
- **hBoxLayout**: The horizontal layout box for arranging content.
- **opacityAni**: The opacity animation object.
- **bubble**: The bubble widget associated with the teaching tip.
```

--------------------------------

### LeftBottomTailTeachingTipManager

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/teaching_tip/index.rst.txt

Manages teaching tips with a tail at the left-bottom.

```APIDOC
## class LeftBottomTailTeachingTipManager

### Description
Left bottom tail teaching tip manager.

### Methods
#### imagePosition()
Returns the position of the image.

#### draw(tip, painter)
Draws the shape of the bubble.
```

--------------------------------

### FontIconEngine

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/common/icon/index.rst.txt

A QIconEngine implementation for font-based icons.

```APIDOC
## class FontIconEngine(fontFamily: str, char: str, color, isBold)

### Description
Font icon engine

### Parameters
- **fontFamily**: (str) - The font family to use.
- **char**: (str) - The character representing the icon.
- **color**: (type not specified) - The color of the icon.
- **isBold**: (type not specified) - Whether the font should be bold.

### Methods
- **paint(painter, rect, mode, state)**: Paints the icon.
- **clone() -> PyQt5.QtGui.QIconEngine**: Clones the icon engine.
- **pixmap(size, mode, state)**: Returns a pixmap representation of the icon.
```

--------------------------------

### FluentWindow Class

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/window/fluent_window/index.rst.txt

Represents a complete Fluent Design window with integrated navigation.

```APIDOC
## Class: FluentWindow

### Description
A complete Fluent Design window with an integrated navigation interface.

### Attributes

- `navigationInterface`: The navigation interface object.
- `widgetLayout`: The main layout for the window's widgets.

### Methods

#### addSubInterface(interface: QWidget, icon: Union[FluentIconBase, QIcon, str], text: str, position=NavigationItemPosition.TOP, parent=None, isTransparent=False) -> NavigationTreeWidget

Add a sub-interface to the navigation. The object name of `interface` must be set before calling this method.

- **Parameters**:
  - `interface` (QWidget): The sub-interface widget to add.
  - `icon` (FluentIconBase | QIcon | str): The icon for the navigation item.
  - `text` (str): The text label for the navigation item.
  - `position` (NavigationItemPosition, optional): The position of the navigation item. Defaults to NavigationItemPosition.TOP.
  - `parent` (QWidget | str, optional): The parent of the navigation item or the parent route key. Defaults to None.
  - `isTransparent` (bool, optional): Whether to use a transparent background for the navigation item. Defaults to False.

- **Returns**:
  - NavigationTreeWidget: The navigation tree widget.

#### removeInterface(interface, isDelete=False)

Remove a sub-interface from the window.

- **Parameters**:
  - `interface` (QWidget): The sub-interface widget to remove.
  - `isDelete` (bool, optional): Whether to delete the sub-interface object. Defaults to False.
```

--------------------------------

### TopLeftTailTeachingTipManager

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/components/widgets/teaching_tip/index.rst.txt

Manages teaching tips with a tail at the top-left.

```APIDOC
## class TopLeftTailTeachingTipManager

### Description
Top left tail teaching tip manager.

### Methods
#### draw(tip, painter)
Draws the shape of the bubble.
```

--------------------------------

### PopupTeachingTip

Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/_sources/autoapi/qfluentwidgets/index.rst.txt

A class to pop up a teaching tip. It inherits from TeachingTip and provides functionality to display a teaching tip as a popup.

```APIDOC
## class PopupTeachingTip

Bases: :py:obj:`TeachingTip`

Pop up teaching tip

Parameters:
    view (FlyoutViewBase): The view to be displayed as a teaching tip.
    target (QWidget): The target widget where the teaching tip will be anchored.
    duration (int, optional): The duration in milliseconds for which the teaching tip will be displayed. Defaults to 1000.
    tailPosition (TeachingTipTailPosition, optional): The position of the tail. Defaults to TeachingTipTailPosition.BOTTOM.
    parent (QWidget, optional): The parent widget. Defaults to None.
    isDeleteOnClose (bool, optional): Whether to delete the teaching tip automatically when it is closed. Defaults to True.
```
Tokens:
Raw