info_bar

Module Contents

InfoBarIcon

Info bar icon

InfoBarPosition

Info bar position

InfoIconWidget

Icon widget

InfoBar

Information bar

InfoBarManager

Info bar manager

TopInfoBarManager

Top position info bar manager

TopRightInfoBarManager

Top right position info bar manager

BottomRightInfoBarManager

Bottom right position info bar manager

TopLeftInfoBarManager

Top left position info bar manager

BottomLeftInfoBarManager

Bottom left position info bar manager

BottomInfoBarManager

Bottom position info bar manager

DesktopInfoBarView

class InfoBarIcon

Bases: qfluentwidgets.common.icon.FluentIconBase, enum.Enum

Info bar icon

INFORMATION = 'Info'
SUCCESS = 'Success'
WARNING = 'Warning'
ERROR = 'Error'
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

class InfoBarPosition

Bases: enum.Enum

Info bar position

TOP = 0
BOTTOM = 1
TOP_LEFT = 2
TOP_RIGHT = 3
BOTTOM_LEFT = 4
BOTTOM_RIGHT = 5
NONE = 6
class InfoIconWidget(icon: InfoBarIcon, parent=None)

Bases: PyQt5.QtWidgets.QWidget

Icon widget

icon
paintEvent(e)
class InfoBar(icon: InfoBarIcon | qfluentwidgets.common.icon.FluentIconBase | PyQt5.QtGui.QIcon | str, title: str, content: str, orient=Qt.Horizontal, isClosable=True, duration=1000, position=InfoBarPosition.TOP_RIGHT, parent=None)

Bases: PyQt5.QtWidgets.QFrame

Information bar

closedSignal
title
content
orient
icon
duration = 1000
isClosable = True
position
titleLabel
contentLabel
closeButton
iconWidget
hBoxLayout
textLayout
widgetLayout
opacityEffect
opacityAni
lightBackgroundColor = None
darkBackgroundColor = None
addWidget(widget: PyQt5.QtWidgets.QWidget, stretch=0)

add widget to info bar

setCustomBackgroundColor(light, dark)

set the custom background color

Parameters

light, dark: str | Qt.GlobalColor | QColor

background color in light/dark theme mode

eventFilter(obj, e: PyQt5.QtCore.QEvent)
closeEvent(e)
showEvent(e)
paintEvent(e)
classmethod new(icon, title, content, orient=Qt.Horizontal, isClosable=True, duration=1000, position=InfoBarPosition.TOP_RIGHT, parent=None)
classmethod info(title, content, orient=Qt.Horizontal, isClosable=True, duration=1000, position=InfoBarPosition.TOP_RIGHT, parent=None)
classmethod success(title, content, orient=Qt.Horizontal, isClosable=True, duration=1000, position=InfoBarPosition.TOP_RIGHT, parent=None)
classmethod warning(title, content, orient=Qt.Horizontal, isClosable=True, duration=1000, position=InfoBarPosition.TOP_RIGHT, parent=None)
classmethod error(title, content, orient=Qt.Horizontal, isClosable=True, duration=1000, position=InfoBarPosition.TOP_RIGHT, parent=None)
classmethod desktopView()

Returns the desktop container

class InfoBarManager

Bases: PyQt5.QtCore.QObject

Info bar manager

managers
spacing = 16
margin = 24
infoBars
aniGroups
slideAnis = []
dropAnis = []
add(infoBar: InfoBar)

add info bar

remove(infoBar: InfoBar)

remove info bar

eventFilter(obj, e: PyQt5.QtCore.QEvent)
classmethod register(name)

register menu animation manager

Parameters

name: Any

the name of manager, it should be unique

classmethod make(position: InfoBarPosition)

mask info bar manager according to the display position

class TopInfoBarManager

Bases: InfoBarManager

Top position info bar manager

class TopRightInfoBarManager

Bases: InfoBarManager

Top right position info bar manager

class BottomRightInfoBarManager

Bases: InfoBarManager

Bottom right position info bar manager

class TopLeftInfoBarManager

Bases: InfoBarManager

Top left position info bar manager

class BottomLeftInfoBarManager

Bases: InfoBarManager

Bottom left position info bar manager

class BottomInfoBarManager

Bases: InfoBarManager

Bottom position info bar manager

class DesktopInfoBarView(parent=None)

Bases: PyQt5.QtWidgets.QWidget