navigation_widget¶
Module Contents¶
Navigation widget |
|
Navigation push button |
|
Navigation tool button |
|
Navigation Separator |
|
Navigation tree item widget |
|
Navigation tree widget base class |
|
Navigation tree widget |
|
Avatar widget |
|
Navigation item info badge manager |
|
Navigation flyout menu |
- class NavigationWidget(isSelectable: bool, parent=None)¶
Bases:
PyQt5.QtWidgets.QWidget
Navigation widget
- clicked¶
- selectedChanged¶
- EXPAND_WIDTH = 312¶
- enterEvent(e)¶
- leaveEvent(e)¶
- mousePressEvent(e)¶
- mouseReleaseEvent(e)¶
- click()¶
- setCompacted(isCompacted: bool)¶
set whether the widget is compacted
- class NavigationPushButton(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIcon, text: str, isSelectable: bool, parent=None)¶
Bases:
NavigationWidget
Navigation push button
- text()¶
- setText(text: str)¶
- icon()¶
- setIcon(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIcon)¶
- paintEvent(e)¶
- class NavigationToolButton(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIcon, parent=None)¶
Bases:
NavigationPushButton
Navigation tool button
- setCompacted(isCompacted: bool)¶
set whether the widget is compacted
- class NavigationSeparator(parent=None)¶
Bases:
NavigationWidget
Navigation Separator
- setCompacted(isCompacted: bool)¶
set whether the widget is compacted
- paintEvent(e)¶
- class NavigationTreeItem(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIcon, text: str, isSelectable: bool, parent=None)¶
Bases:
NavigationPushButton
Navigation tree item widget
- itemClicked¶
- arrowAngle¶
- setExpanded(isExpanded: bool)¶
- mouseReleaseEvent(e)¶
- paintEvent(e)¶
- getArrowAngle()¶
- setArrowAngle(angle)¶
- class NavigationTreeWidgetBase(isSelectable: bool, parent=None)¶
Bases:
NavigationWidget
Navigation tree widget base class
- abstract insertChild(index: int, child: NavigationWidget)¶
insert child
Parameters¶
- child: NavigationTreeWidgetBase
child item
- abstract removeChild(child: NavigationWidget)¶
remove child
Parameters¶
- child: NavigationTreeWidgetBase
child item
- isRoot()¶
is root node
- isLeaf()¶
is leaf node
- abstract setExpanded(isExpanded: bool)¶
set the expanded status
Parameters¶
- isExpanded: bool
whether to expand node
- abstract childItems() → list¶
return child items
- class NavigationTreeWidget(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIcon, text: str, isSelectable: bool, parent=None)¶
Bases:
NavigationTreeWidgetBase
Navigation tree widget
- expanded¶
- text()¶
- icon()¶
- setText(text)¶
- setIcon(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIcon)¶
- setFont(font: PyQt5.QtGui.QFont)¶
- clone()¶
- suitableWidth()¶
- childItems() → list¶
return child items
- setExpanded(isExpanded: bool, ani=False)¶
set the expanded status
- isRoot()¶
is root node
- isLeaf()¶
is leaf node
- setSelected(isSelected: bool)¶
set whether the button is selected
Parameters¶
- isSelected: bool
whether the button is selected
- mouseReleaseEvent(e)¶
- setCompacted(isCompacted: bool)¶
set whether the widget is compacted
- class NavigationAvatarWidget(name: str, avatar: str | PyQt5.QtGui.QPixmap | PyQt5.QtGui.QImage, parent=None)¶
Bases:
NavigationWidget
Avatar widget
- setName(name: str)¶
- setAvatar(avatar: str | PyQt5.QtGui.QPixmap | PyQt5.QtGui.QImage)¶
- paintEvent(e)¶
- class NavigationItemInfoBadgeManager(target: PyQt5.QtWidgets.QWidget, badge: InfoBadge)¶
Bases:
qfluentwidgets.components.widgets.info_badge.InfoBadgeManager
Navigation item info badge manager
- eventFilter(obj, e: PyQt5.QtCore.QEvent)¶
- position()¶
return the position of info badge
- class NavigationFlyoutMenu(tree: NavigationTreeWidget, parent=None)¶
Bases:
qfluentwidgets.components.widgets.scroll_area.ScrollArea
Navigation flyout menu
- expanded¶
- visibleTreeNodes()¶