fluent_window¶
Module Contents¶
Fluent window base class |
|
Fluent title bar |
|
Fluent window |
|
Fluent title bar |
|
Fluent window in Microsoft Store style |
|
Title bar with minimize, maximum and close button |
|
Fluent window with split style |
|
Fluent background theme |
- class FluentWindowBase(parent=None)¶
Bases:
qfluentwidgets.common.animation.BackgroundAnimationWidget
,qfluentwidgets.components.widgets.frameless_window.FramelessWindow
Fluent window base class
- abstract addSubInterface(interface: PyQt5.QtWidgets.QWidget, icon: qfluentwidgets.common.icon.FluentIconBase | PyQt5.QtGui.QIcon | str, text: str, position=NavigationItemPosition.TOP)¶
add sub interface
- switchTo(interface: PyQt5.QtWidgets.QWidget)¶
- setCustomBackgroundColor(light, dark)¶
set custom background color
Parameters¶
- light, dark: QColor | Qt.GlobalColor | str
background color in light/dark theme mode
- paintEvent(e)¶
- setMicaEffectEnabled(isEnabled: bool)¶
set whether the mica effect is enabled, only available on Win11
- isMicaEffectEnabled()¶
- class FluentTitleBar(parent)¶
Bases:
qframelesswindow.TitleBar
Fluent title bar
- setTitle(title)¶
- setIcon(icon)¶
- class FluentWindow(parent=None)¶
Bases:
FluentWindowBase
Fluent window
- addSubInterface(interface: PyQt5.QtWidgets.QWidget, icon: qfluentwidgets.common.icon.FluentIconBase | PyQt5.QtGui.QIcon | str, text: str, position=NavigationItemPosition.TOP, parent=None, isTransparent=False) qfluentwidgets.components.navigation.NavigationTreeWidget ¶
add sub interface, the object name of interface should be set already before calling this method
Parameters¶
- interface: QWidget
the subinterface to be added
- icon: FluentIconBase | QIcon | str
the icon of navigation item
- text: str
the text of navigation item
- position: NavigationItemPosition
the position of navigation item
- parent: QWidget
the parent of navigation item
- isTransparent: bool
whether to use transparent background
- resizeEvent(e)¶
- class MSFluentTitleBar(parent)¶
Bases:
FluentTitleBar
Fluent title bar
- class MSFluentWindow(parent=None)¶
Bases:
FluentWindowBase
Fluent window in Microsoft Store style
- addSubInterface(interface: PyQt5.QtWidgets.QWidget, icon: qfluentwidgets.common.icon.FluentIconBase | PyQt5.QtGui.QIcon | str, text: str, selectedIcon=None, position=NavigationItemPosition.TOP, isTransparent=False) qfluentwidgets.components.navigation.NavigationBarPushButton ¶
add sub interface, the object name of interface should be set already before calling this method
Parameters¶
- interface: QWidget
the subinterface to be added
- icon: FluentIconBase | QIcon | str
the icon of navigation item
- text: str
the text of navigation item
- selectedIcon: str | QIcon | FluentIconBase
the icon of navigation item in selected state
- position: NavigationItemPosition
the position of navigation item
- class SplitTitleBar(parent)¶
Bases:
qframelesswindow.TitleBar
Title bar with minimize, maximum and close button
- setTitle(title)¶
- setIcon(icon)¶
- class SplitFluentWindow(parent=None)¶
Bases:
FluentWindow
Fluent window with split style