### 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) ``` -------------------------------- ### 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. ``` -------------------------------- ### Action Class Methods Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/common/icon/index.html Methods for the `Action` class related to setting and getting FluentIcons. ```APIDOC ## Action Class ### Description The `Action` class provides methods for managing actions, including associating FluentIcons with them. ### Methods - `Action.fluentIcon(action: Action)` - **Description**: Gets the `FluentIcon` associated with an `Action` object. - **Parameters**: - `action` (Action): The `Action` object. - `Action.icon(action: Action)` - **Description**: Gets the icon associated with an `Action` object. (Type not specified, likely `QIcon`) - **Parameters**: - `action` (Action): The `Action` object. - `Action.setIcon(action: Action, icon: FluentIcon)` - **Description**: Sets the `FluentIcon` for an `Action` object. - **Parameters**: - `action` (Action): The `Action` object. - `icon` (FluentIcon): The `FluentIcon` to set. ``` -------------------------------- ### 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 ``` -------------------------------- ### path Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/index.html Get the path of an icon. ```APIDOC ## path ### Description Retrieves the file path for a given icon. ### Method `path(theme=Theme.AUTO)` ### Parameters #### Query Parameters - **theme** (Theme, optional): The theme to use for the icon. Defaults to `Theme.AUTO`. ### Returns string: The file path of the icon. ``` -------------------------------- ### _TeachingTip.make Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/index.html A class method to create and return a new instance of TeachingTip. ```APIDOC ## _classmethod _make(_view : qfluentwidgets.components.widgets.flyout.FlyoutViewBase_, _target : PyQt5.QtWidgets.QWidget_, _duration =1000_, _tailPosition =TeachingTipTailPosition.BOTTOM_, _parent =None_, _isDeleteOnClose =True_) ### Description Creates and returns a new instance of TeachingTip. ### Parameters - **view**: The teaching tip view. - **target**: The target widget to show the tip. - **duration**: The time for the teaching tip to display in milliseconds. If duration is less than zero, the teaching tip will never disappear. - **tailPosition**: The position of the bubble tail. - **parent**: Parent widget. - **isDeleteOnClose**: Whether to delete the flyout automatically when the flyout is closed. ``` -------------------------------- ### CardGroupWidget.icon Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/card_widget/index.html Gets the icon of the CardGroupWidget. ```APIDOC ## icon() ### Description Gets the icon of the card group. ### Method `icon()` ``` -------------------------------- ### CardGroupWidget.content Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/card_widget/index.html Gets the content of the CardGroupWidget. ```APIDOC ## content() ### Description Gets the content of the card group. ### Method `content()` ``` -------------------------------- ### SystemTrayMenu Methods Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/index.html Methods for system tray menus, including size hint calculation. ```APIDOC ## SystemTrayMenu ### Methods - `sizeHint()`: Returns the recommended size hint for the menu. ``` -------------------------------- ### CardGroupWidget.title Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/card_widget/index.html Gets the title of the CardGroupWidget. ```APIDOC ## title() ### Description Gets the title of the card group. ### Method `title()` ``` -------------------------------- ### TeachingTip Constructors Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/index.html Provides information on how to create and configure TeachingTips. ```APIDOC ## TeachingTip ### Description Provides methods for creating and managing teaching tips. ### Methods * `create()`: Creates a new instance of TeachingTip. ``` -------------------------------- ### 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. ``` -------------------------------- ### HeaderCardWidget.getTitle Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/card_widget/index.html Gets the title of the HeaderCardWidget. ```APIDOC ## getTitle() ### Description Gets the title of the header card. ### Method `getTitle()` ``` -------------------------------- ### 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()` ``` -------------------------------- ### _DWMMenu Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/index.html A QMenu with DWM shadow effects. ```APIDOC ## _DWMMenu ### Description A menu widget that supports DWM shadow effects. ### Properties - windowEffect ### Methods - event(_e : QEvent_) ``` -------------------------------- ### DatePickerBase.monthFormatter Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets the formatter for the month display. ```APIDOC ## DatePickerBase.monthFormatter() ### Description Gets the formatter for the month display. ### Returns - str: The month format string. ``` -------------------------------- ### TeachingTip Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/index.html A component for displaying contextual tips to users. ```APIDOC ## TeachingTip ### Description Displays contextual tips to users, often attached to a target widget. ### Methods - `TeachingTip.setShadowEffect()`: Sets the shadow effect for the teaching tip. - `TeachingTip.showEvent()`: Handles the show event. - `TeachingTip.closeEvent()`: Handles the close event. - `TeachingTip.eventFilter(obj, event)`: Filters events. - `TeachingTip.addWidget(widget)`: Adds a widget to the teaching tip. - `TeachingTip.setView(view)`: Sets the view for the teaching tip. - `TeachingTip.make()`: Creates the teaching tip. - `TeachingTip.create()`: Creates the teaching tip. ### Properties - `TeachingTip.target`: The target widget for the teaching tip. - `TeachingTip.duration`: The duration the teaching tip is displayed. - `TeachingTip.isDeleteOnClose`: Whether to delete the teaching tip on close. - `TeachingTip.manager`: The teaching tip manager. - `TeachingTip.hBoxLayout`: The horizontal layout of the teaching tip. - `TeachingTip.opacityAni`: The opacity animation for the teaching tip. - `TeachingTip.bubble`: The bubble associated with the teaching tip. - `TeachingTip.view`: The view of the teaching tip. ``` -------------------------------- ### _TeachingTip.create Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/index.html A class method to create a teaching tip with specified content, icon, and image. ```APIDOC ## _classmethod _create(_target : PyQt5.QtWidgets.QWidget_, _title : str_, _content : str_, _icon : qfluentwidgets.common.icon.FluentIconBase | PyQt5.QtGui.QIcon | str = None_, _image : str | PyQt5.QtGui.QPixmap | PyQt5.QtGui.QImage = None_, _isClosable =True_, _duration =1000_, _tailPosition =TeachingTipTailPosition.BOTTOM_, _parent =None_, _isDeleteOnClose =True_) ### Description Creates a teaching tip with the given parameters. ### Parameters - **_target**: The target widget. - **_title**: The title of the teaching tip. - **_content**: The content of the teaching tip. - **_icon**: The icon for the teaching tip. Can be FluentIconBase, QIcon, or a string path. - **_image**: The image for the teaching tip. Can be a string path, QPixmap, or QImage. - **_isClosable**: Whether the teaching tip is closable. Defaults to True. - **_duration**: The display duration in milliseconds. Defaults to 1000. - **_tailPosition**: The position of the bubble tail. Defaults to TeachingTipTailPosition.BOTTOM. - **_parent**: The parent widget. Defaults to None. - **_isDeleteOnClose**: Whether to delete the teaching tip automatically when closed. Defaults to True. ``` -------------------------------- ### DatePickerBase.dayFormatter Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets the formatter for the day display. ```APIDOC ## DatePickerBase.dayFormatter() ### Description Gets the formatter for the day display. ### Returns - str: The day format string. ``` -------------------------------- ### _TeachingTip.create Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/index.html Class method to create a teaching tip with title, content, and icon. ```APIDOC ## _classmethod _create(_target : PyQt5.QtWidgets.QWidget_, _title : str_, _content : str_, _icon : qfluentwidgets.common.icon.FluentIconBase | PyQt5.QtGui.QIcon | str = None_, _image : str | PyQt5.QtGui.QPixmap | PyQt5.QtGui.QImage = None_, _isClosable =True_, _duration =1000_, _tailPosition =TeachingTipTailPosition.BOTTOM_, _parent =None_, _isDeleteOnClose =True_) ### Description Creates a teaching tip with specified content and appearance. ### Parameters - **_target**: PyQt5.QtWidgets.QWidget_ - The target widget to anchor the teaching tip. - **_title**: str - The title of the teaching tip. - **_content**: str - The main content of the teaching tip. - **_icon**: qfluentwidgets.common.icon.FluentIconBase | PyQt5.QtGui.QIcon | str - An icon to display in the teaching tip. Defaults to None. - **_image**: str | PyQt5.QtGui.QPixmap | PyQt5.QtGui.QImage - An image to display in the teaching tip. Defaults to None. - **_isClosable**: bool - Whether the teaching tip can be closed by the user. Defaults to True. - **_duration**: int - The duration in milliseconds for which the teaching tip is displayed. If less than zero, it will never disappear. Defaults to 1000. - **_tailPosition**: TeachingTipTailPosition - The position of the tail of the teaching tip. Defaults to TeachingTipTailPosition.BOTTOM. - **_parent**: QWidget - The parent widget. Defaults to None. - **_isDeleteOnClose**: bool - Whether to delete the teaching tip automatically when it is closed. Defaults to True. ``` -------------------------------- ### DatePickerBase.yearFormatter Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets the formatter for the year display. ```APIDOC ## DatePickerBase.yearFormatter() ### Description Gets the formatter for the year display. ### Returns - str: The year format string. ``` -------------------------------- ### 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 ``` -------------------------------- ### DatePickerBase.getDate Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets the current date from the DatePickerBase. ```APIDOC ## DatePickerBase.getDate() ### Description Gets the current date from the DatePickerBase. ### Returns - QDate: The current date. ``` -------------------------------- ### CardWidget.getBorderRadius Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/card_widget/index.html Gets the border radius of the CardWidget. ```APIDOC ## getBorderRadius() ### Description Gets the border radius of the card widget. ### Method `getBorderRadius()` ``` -------------------------------- ### TeachingTipView Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/index.html A view component for teaching tips. ```APIDOC ## TeachingTipView ### Description View component for teaching tips. ### Class `TeachingTipView` ``` -------------------------------- ### PickerBase.initialValue Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets the initial value of the picker. ```APIDOC ## PickerBase.initialValue() ### Description Gets the initial value of the picker. ### Returns - Any: The initial value. ``` -------------------------------- ### 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. ``` -------------------------------- ### PickerBase.value Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets the current value of the picker. ```APIDOC ## PickerBase.value() ### Description Gets the current value of the picker. ### Returns - Any: The current value. ``` -------------------------------- ### DatePicker.getDate Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets the current date from the DatePicker. ```APIDOC ## DatePicker.getDate() ### Description Gets the current date from the DatePicker. ### Returns - QDate: The current date. ``` -------------------------------- ### 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. ``` -------------------------------- ### CalendarPicker.getDate Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets the current date from the CalendarPicker. ```APIDOC ## CalendarPicker.getDate() ### Description Gets the current date from the CalendarPicker. ### Returns - QDate: The current date. ``` -------------------------------- ### SimpleMediaPlayBar Methods Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/multimedia/index.html Methods for configuring and managing a simple media play bar. ```APIDOC ## SimpleMediaPlayBar ### Properties * **hBoxLayout**: The horizontal layout manager for the play bar. ### Methods * **addButton(button)**: Adds a button to the media play bar. ``` -------------------------------- ### CommandViewBar Methods Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/command_bar/index.html Methods for configuring the CommandViewBar. ```APIDOC ## CommandViewBar ### Description A specialized command bar for the command view. ### Methods #### setMenuDropDown(_down : bool_) Sets the animation direction for the more actions menu. #### isMenuDropDown() → bool Checks if the more actions menu is set to drop down. ``` -------------------------------- ### 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`). ``` -------------------------------- ### 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). ``` -------------------------------- ### 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) ``` -------------------------------- ### TeachingTipView Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/index.html API documentation for the TeachingTipView class, a visual component for displaying teaching tip content. ```APIDOC ## TeachingTipView ### Properties - `manager` (TeachingTipManager) - `hBoxLayout` (QHBoxLayout) ### Methods - `paintEvent(e: QPaintEvent)` ``` -------------------------------- ### getStyleSheet Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/index.html Gets a style sheet with theme applied. ```APIDOC ## getStyleSheet(source, theme) ### Description Gets a style sheet with theme applied. ### Parameters - **source** (str) - The style sheet source. - **theme** (Theme, optional) - The theme to apply. ### Returns - str: The generated style sheet string. ``` -------------------------------- ### PickerPanel.column Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets a specific column from the picker panel. ```APIDOC ## PickerPanel.column(index: int) ### Description Gets a specific column from the picker panel. ### Parameters - **index** (int) - The index of the column. ### Returns - PickerColumn: The PickerColumn object. ``` -------------------------------- ### QConfig Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/common/index.html Manages application-wide configurations, including theme settings. ```APIDOC ## QConfig ### Description Manages application-wide configurations, including theme settings. Provides methods to get and set configuration values. ### Signals - **appRestartSig**: pyqtSignal Emitted when an application restart is required due to configuration changes. - **themeChanged**: pyqtSignal Emitted when the theme changes. - **themeChangedFinished**: pyqtSignal Emitted after the theme change is completed. - **themeColorChanged**: pyqtSignal Emitted when the theme color changes. ### Attributes - **themeMode**: Theme The current theme mode (Light, Dark, Auto). - **themeColor**: QColor The current theme color. - **fontFamilies**: list[str] A list of available font families. - **file**: str The path to the configuration file. ### Methods - **get**(key: str, defaultValue: Any = None) -> Any Retrieves the value of a configuration key. - **set**(key: str, value: Any) Sets the value for a configuration key. ``` -------------------------------- ### PickerPanel.value Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets the current value of the picker panel. ```APIDOC ## PickerPanel.value() ### Description Gets the current value of the picker panel. ### Returns - Any: The current value. ``` -------------------------------- ### 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`. ``` -------------------------------- ### 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. ``` -------------------------------- ### CalendarPicker.getDateFormat Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets the current date format string. ```APIDOC ## CalendarPicker.getDateFormat() ### Description Gets the current date format string. ### Returns - str: The date format string. ``` -------------------------------- ### 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. ``` -------------------------------- ### 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. ``` -------------------------------- ### Theme Management Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/common/index.html Functions for setting and getting the application theme. ```APIDOC ## Theme Management Functions for managing the application theme. ### Methods - `setTheme(theme)`: Sets the application theme. - `getTheme()`: Gets the current application theme. - `setThemeColor(color)`: Sets a custom theme color. - `applyThemeColor(widget, color)`: Applies a theme color to a specific widget. ``` -------------------------------- ### 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`. ``` -------------------------------- ### TeachingTip Methods Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/index.html Methods for the TeachingTip component to display contextual information and tips. ```APIDOC ## TeachingTip Methods ### Description Methods for creating and managing teaching tips, which provide contextual information to users. ### Properties - `target`: The widget the teaching tip is associated with. - `duration`: The duration the tip is displayed (in milliseconds). - `isDeleteOnClose`: Whether the tip is deleted after closing. - `manager`: The teaching tip manager. - `hBoxLayout`: The horizontal layout for the tip's content. - `opacityAni`: The opacity animation for the tip. - `bubble`: The bubble widget of the tip. - `view`: The view associated with the teaching tip. ### Methods - `setShadowEffect()`: Applies a shadow effect to the teaching tip. - `showEvent(QShowEvent e)`: Handles the show event. - `closeEvent(QCloseEvent e)`: Handles the close event. - `eventFilter(QObject watched, QEvent event)`: Filters events for the teaching tip. - `addWidget(QWidget widget)`: Adds a widget to the teaching tip's content. - `setView(QWidget view)`: Sets the view for the teaching tip. - `make()`: Creates and shows the teaching tip. ``` -------------------------------- ### PickerPanel.columnValue Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets the value of a specific column in the picker panel. ```APIDOC ## PickerPanel.columnValue(index: int) ### Description Gets the value of a specific column in the picker panel. ### Parameters - **index** (int) - The index of the column. ### Returns - Any: The value of the column. ``` -------------------------------- ### FluentWindow and its subclasses Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/index.html Documentation for window classes including FluentWindow, MSFluentWindow, and SplitFluentWindow, which provide enhanced Fluent Design features for application windows. ```APIDOC ## FluentWindow ### Description A window with Fluent Design elements. ### Attributes - `navigationInterface`: The navigation interface for the window. - `widgetLayout`: The layout manager for the window's widgets. ### Methods - `addSubInterface(widget: QWidget, title: str)`: Adds a sub-interface to the window. - `removeInterface(widget: QWidget)`: Removes a sub-interface from the window. - `resizeEvent(e: QResizeEvent)`: Handles resize events for the window. ``` ```APIDOC ## MSFluentWindow ### Description A Fluent window with Microsoft-style navigation. ### Attributes - `navigationInterface`: The navigation interface for the window. ### Methods - `addSubInterface(widget: QWidget, title: str)`: Adds a sub-interface to the window. - `removeInterface(widget: QWidget)`: Removes a sub-interface from the window. ``` ```APIDOC ## SplitFluentWindow ### Description A Fluent window with a split layout. ``` -------------------------------- ### PickerBase.panelInitialValue Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets or sets the initial value of the picker panel. ```APIDOC ## PickerBase.panelInitialValue() ### Description Gets or sets the initial value of the picker panel. ### Parameters - **time** (QTime) - The current time to set as the initial value. ``` -------------------------------- ### 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. ``` -------------------------------- ### AMTimePicker.panelInitialValue Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets or sets the initial value of the AMTimePicker panel. ```APIDOC ## AMTimePicker.panelInitialValue() ### Description Gets or sets the initial value of the AMTimePicker panel. ### Parameters - **time** (QTime) - The current time to set as the initial 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`. ``` -------------------------------- ### HyperlinkButton Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/index.html A button that functions as a hyperlink, with methods to get and set the URL. ```APIDOC ## HyperlinkButton ### Properties - `url` ### Methods - `getUrl()` - `setUrl()` ``` -------------------------------- ### CommandBar Methods and Properties Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/index.html Methods and properties for the CommandBar widget. ```APIDOC ## CommandBar ### Methods - `setSpaing(spacing: int)` - `spacing() -> int` - `addAction(action: QAction)` - `addActions(actions: list[QAction])` ### Properties - `moreButton` ``` -------------------------------- ### NavigationBarPushButton.indicatorRect Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/index.html Gets the geometry of the indicator for the navigation bar push button. ```APIDOC ## NavigationBarPushButton.indicatorRect ### Description Gets the geometry of the indicator. ``` -------------------------------- ### QConfig Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/index.html Manages application-wide configuration settings. ```APIDOC ## QConfig ### Description Manages application configuration settings, including themes and custom options. ### Signals - `appRestartSig`: Signal emitted when an application restart is required. - `themeChanged`: Signal emitted when the theme changes. - `themeChangedFinished`: Signal![1;33m📢 Tips:[0m QFluentWidgets Pro is now released. Click [1;96mhttps://qfluentwidgets.com/pages/pro[0m to learn more about it. Signal emitted when theme change is finished. - `themeColorChanged`: Signal emitted when the theme color changes. ### Properties - `themeMode` (Theme): Gets or sets the application's theme mode (Light, Dark, Auto). - `themeColor` (any): Gets or sets the application's theme color. - `fontFamilies` (list): Gets or sets the list of available font families. - `file` (str): Path to the configuration file. ### Methods - `get(_item_)`: Retrieves the value of a specific config item. - `set(_item_, _value_, _save_=True, _copy_=True)`: Sets the value of a config item. ### Parameters - `item`: The config item to modify. - `value`: The new value for the config item. - `save` (bool): Whether to save the changes to the config file. Defaults to True. - `copy` (bool): Whether to perform a deep copy of the new value. Defaults to True. - `toDict(_serialize_=True)`: Converts all config items to a dictionary. - `save()`: Saves the current configuration to the file. - `load(_file_=None, _config_=None)`: Loads configuration from a file or a config object. ### Parameters - `file` (str or Path, optional): The path to the JSON config file. - `config` (Config, optional): A config object to initialize from. ### Properties - `_theme` (Theme): Gets the current theme mode. ### Methods - `qconfig`: Returns the singleton instance of QConfig. - `isDarkTheme()`: Checks if the current theme is dark mode. - `theme()`: Gets the current theme mode. - `isDarkThemeMode(_theme_=Theme.AUTO)`: Checks if a given theme is dark mode. ``` -------------------------------- ### NavigationBarPushButton.selectedIcon Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/index.html Gets the selected icon of the navigation bar push button. ```APIDOC ## NavigationBarPushButton.selectedIcon ### Description Gets the selected icon of the button. ``` -------------------------------- ### DatePicker.panelInitialValue Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/date_time/index.html Gets or sets the initial value of the date picker panel. ```APIDOC ## DatePicker.panelInitialValue() ### Description Gets or sets the initial value of the date picker panel. ### Parameters - **time** (QTime) - The current time to set as the initial value. ``` -------------------------------- ### 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) ``` -------------------------------- ### 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. ``` -------------------------------- ### 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 ``` -------------------------------- ### CommandBar Methods Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/command_bar/index.html Methods for managing actions, widgets, and appearance of the CommandBar. ```APIDOC ## CommandBar ### Description Provides functionality to manage actions, widgets, and appearance of the command bar. ### Methods #### addAction(_action : PyQt5.QtWidgets.QAction_) Adds a single action to the command bar. #### addActions(_actions : Iterable[PyQt5.QtWidgets.QAction]_) Adds multiple actions to the command bar. #### addHiddenAction(_action : PyQt5.QtWidgets.QAction_) Adds a hidden action to the command bar. #### addHiddenActions(_actions : List[PyQt5.QtWidgets.QAction]_) Adds multiple hidden actions to the command bar. #### insertAction(_before : PyQt5.QtWidgets.QAction_, _action : PyQt5.QtWidgets.QAction_) Inserts an action before a specified action. #### addSeparator() Adds a separator to the command bar. #### insertSeparator(_index : int_) Inserts a separator at a specific index. #### addWidget(_widget : PyQt5.QtWidgets.QWidget_) Adds a widget to the command bar. #### removeAction(_action : PyQt5.QtWidgets.QAction_) Removes an action from the command bar. #### removeWidget(_widget : PyQt5.QtWidgets.QWidget_) Removes a widget from the command bar. #### removeHiddenAction(_action : PyQt5.QtWidgets.QAction_) Removes a hidden action from the command bar. #### setToolButtonStyle(_style : PyQt5.QtCore.Qt.ToolButtonStyle_) Sets the tool button style for the command bar. #### toolButtonStyle() → PyQt5.QtCore.Qt.ToolButtonStyle Gets the current tool button style. #### setButtonTight(_isTight : bool_) Sets whether the buttons are tight. #### isButtonTight() → bool Checks if the buttons are tight. #### setIconSize(_size : PyQt5.QtCore.QSize_) Sets the icon size for the buttons. #### iconSize() → PyQt5.QtCore.QSize Gets the icon size. #### resizeEvent(_e_) Handles resize events for the command bar. #### minimumSizeHint() → PyQt5.QtCore.QSize Returns the minimum size hint for the command bar. #### updateGeometry() Updates the geometry of the command bar. #### suitableWidth() Calculates the suitable width for the command bar. #### resizeToSuitableWidth() Resizes the command bar to its suitable width. #### setFont(_font : PyQt5.QtGui.QFont_) Sets the font for the command bar. #### setMenuDropDown(_down : bool_) Sets the animation direction for the more actions menu. #### isMenuDropDown() → bool Checks if the more actions menu is set to drop down. ### Properties #### _property _commandButtons Access to the command buttons. ``` -------------------------------- ### Font Utility Methods Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/index.html Methods for setting and getting font properties for widgets. ```APIDOC ## setFont ### Description Set the font for a given widget. ### Method `setFont(_widget : PyQt5.QtWidgets.QWidget_, _fontSize =14_, _weight =QFont.Normal_)` ## getFont ### Description Create a font with specified size and weight. ### Method `getFont(_fontSize =14_, _weight =QFont.Normal_)` ``` -------------------------------- ### 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. ``` -------------------------------- ### 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. ``` -------------------------------- ### Icon Management Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/common/icon/index.html Provides methods to get and set the icon associated with an object. ```APIDOC ## Icon Management ### Description This section details how to manage icons within the Fluent Widgets framework. ### Methods - `icon() → PyQt5.QtGui.QIcon`: Returns the current icon as a `QIcon` object. - `setIcon(_icon : FluentIconBase | PyQt5.QtGui.QIcon_)`: Sets the icon for the object. Accepts either a `FluentIconBase` object or a `QIcon` object. ``` -------------------------------- ### 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. ``` -------------------------------- ### 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 ``` -------------------------------- ### SystemTrayMenu Source: https://pyqt-fluent-widgets.readthedocs.io/zh-cn/latest/autoapi/qfluentwidgets/components/widgets/index.html A menu specifically designed for system tray integration. ```APIDOC ## SystemTrayMenu ### Description A menu specifically designed for system tray integration. ### Methods - `SystemTrayMenu.sizeHint() -> QSize ### Properties (Inherits properties from parent classes) ```