window

• fluent_window
• splash_screen
• stacked_widget

Package Contents

FluentWindow	Fluent window
MSFluentWindow	Fluent window in Microsoft Store style
SplitFluentWindow	Fluent window with split style
FluentTitleBar	Fluent title bar
MSFluentTitleBar	Fluent title bar
SplitTitleBar	Title bar with minimize, maximum and close button
FluentBackgroundTheme	Fluent background theme
SplashScreen	Splash screen

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 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 SplitFluentWindow(parent=None)

Bases: FluentWindow

Fluent window with split style

class FluentTitleBar(parent)

Bases: qframelesswindow.TitleBar

Fluent title bar

setTitle(title)

setIcon(icon)

class MSFluentTitleBar(parent)

Bases: FluentTitleBar

Fluent title bar

class SplitTitleBar(parent)

Bases: qframelesswindow.TitleBar

Title bar with minimize, maximum and close button

setTitle(title)

setIcon(icon)

class FluentBackgroundTheme

Fluent background theme

DEFAULT = ()

DEFAULT_BLUE = ()

class SplashScreen(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase, parent=None, enableShadow=True)

Bases: PyQt5.QtWidgets.QWidget

Splash screen

setIcon(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase)

icon()

setIconSize(size: PyQt5.QtCore.QSize)

iconSize()

setTitleBar(titleBar: PyQt5.QtWidgets.QWidget)

set title bar

eventFilter(obj, e: PyQt5.QtCore.QEvent)

resizeEvent(e)

finish()

close splash screen

paintEvent(e)