window
======

.. py:module:: qfluentwidgets.window




.. toctree::
   :titlesonly:
   :maxdepth: 1

   fluent_window/index.rst
   splash_screen/index.rst
   stacked_widget/index.rst


Package Contents
----------------



.. autoapisummary::

   qfluentwidgets.window.FluentWindow
   qfluentwidgets.window.MSFluentWindow
   qfluentwidgets.window.SplitFluentWindow
   qfluentwidgets.window.FluentTitleBar
   qfluentwidgets.window.MSFluentTitleBar
   qfluentwidgets.window.SplitTitleBar
   qfluentwidgets.window.FluentBackgroundTheme
   qfluentwidgets.window.SplashScreen




.. py:class:: FluentWindow(parent=None)

   Bases: :py:obj:`FluentWindowBase`


   Fluent window 


   .. py:attribute:: navigationInterface


   .. py:attribute:: widgetLayout


   .. py:method:: addSubInterface(interface: PyQt5.QtWidgets.QWidget, icon: Union[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



   .. py:method:: resizeEvent(e)


.. py:class:: MSFluentWindow(parent=None)

   Bases: :py:obj:`FluentWindowBase`


   Fluent window in Microsoft Store style 


   .. py:attribute:: navigationInterface


   .. py:method:: addSubInterface(interface: PyQt5.QtWidgets.QWidget, icon: Union[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



.. py:class:: SplitFluentWindow(parent=None)

   Bases: :py:obj:`FluentWindow`


   Fluent window with split style 


.. py:class:: FluentTitleBar(parent)

   Bases: :py:obj:`qframelesswindow.TitleBar`


   Fluent title bar


   .. py:attribute:: iconLabel


   .. py:attribute:: titleLabel


   .. py:attribute:: vBoxLayout


   .. py:attribute:: buttonLayout


   .. py:method:: setTitle(title)


   .. py:method:: setIcon(icon)


.. py:class:: MSFluentTitleBar(parent)

   Bases: :py:obj:`FluentTitleBar`


   Fluent title bar


.. py:class:: SplitTitleBar(parent)

   Bases: :py:obj:`qframelesswindow.TitleBar`


   Title bar with minimize, maximum and close button 


   .. py:attribute:: iconLabel


   .. py:attribute:: titleLabel


   .. py:method:: setTitle(title)


   .. py:method:: setIcon(icon)


.. py:class:: FluentBackgroundTheme

   Fluent background theme 


   .. py:attribute:: DEFAULT


   .. py:attribute:: DEFAULT_BLUE


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

   Bases: :py:obj:`PyQt5.QtWidgets.QWidget`


   Splash screen 


   .. py:attribute:: titleBar


   .. py:attribute:: iconWidget


   .. py:attribute:: shadowEffect


   .. py:method:: setIcon(icon: Union[str, PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase])


   .. py:method:: icon()


   .. py:method:: setIconSize(size: PyQt5.QtCore.QSize)


   .. py:method:: iconSize()


   .. py:method:: setTitleBar(titleBar: PyQt5.QtWidgets.QWidget)

      set title bar 



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


   .. py:method:: resizeEvent(e)


   .. py:method:: finish()

      close splash screen 



   .. py:method:: paintEvent(e)