QStatusBar

The QStatusBar class provides a horizontal bar suitable for presenting status information. More…

Inheritance diagram of PySide2.QtWidgets.QStatusBar

Synopsis

Functions

Slots

Signals

Detailed Description

Each status indicator falls into one of three categories:

  • Temporary - briefly occupies most of the status bar. Used to explain tool tip texts or menu entries, for example.

  • Normal - occupies part of the status bar and may be hidden by temporary messages. Used to display the page and line number in a word processor, for example.

  • Permanent - is never hidden. Used for important mode indications, for example, some applications put a Caps Lock indicator in the status bar.

QStatusBar lets you display all three types of indicators.

Typically, a request for the status bar functionality occurs in relation to a QMainWindow object. QMainWindow provides a main application window, with a menu bar, tool bars, dock widgets and a status bar around a large central widget. The status bar can be retrieved using the statusBar() function, and replaced using the setStatusBar() function.

Use the showMessage() slot to display a temporary message:

def createStatusBar(self):
    statusBar().showMessage(tr("Ready"))

To remove a temporary message, use the clearMessage() slot, or set a time limit when calling showMessage() . For example:

def print(self)
    document = textEdit.document()
    printer = QPrinter()

    dlg =  QPrintDialog(&printer, self)
    if dlg.exec() != QDialog.Accepted:
        return

    document.print(printer)
    statusBar().showMessage(tr("Ready"), 2000)

Use the currentMessage() function to retrieve the temporary message currently shown. The QStatusBar class also provide the messageChanged() signal which is emitted whenever the temporary status message changes.

Normal and Permanent messages are displayed by creating a small widget ( QLabel , QProgressBar or even QToolButton ) and then adding it to the status bar using the addWidget() or the addPermanentWidget() function. Use the removeWidget() function to remove such messages from the status bar.

statusBar().addWidget(MyReadWriteIndication())

By default QStatusBar provides a QSizeGrip in the lower-right corner. You can disable it using the setSizeGripEnabled() function. Use the isSizeGripEnabled() function to determine the current status of the size grip.

../../_images/fusion-statusbar-sizegrip.png

See also

QMainWindow QStatusTipEvent GUI Design Handbook: Status Bar Application Example

class PySide2.QtWidgets.QStatusBar([parent=None])

Constructs a status bar with a size grip and the given parent .

See also

setSizeGripEnabled()

PySide2.QtWidgets.QStatusBar.addPermanentWidget(widget[, stretch=0])
Parameters:

Adds the given widget permanently to this status bar, reparenting the widget if it isn’t already a child of this QStatusBar object. The stretch parameter is used to compute a suitable size for the given widget as the status bar grows and shrinks. The default stretch factor is 0, i.e giving the widget a minimum of space.

Permanently means that the widget may not be obscured by temporary messages. It is is located at the far right of the status bar.

See also

insertPermanentWidget() removeWidget() addWidget()

PySide2.QtWidgets.QStatusBar.addWidget(widget[, stretch=0])
Parameters:

Adds the given widget to this status bar, reparenting the widget if it isn’t already a child of this QStatusBar object. The stretch parameter is used to compute a suitable size for the given widget as the status bar grows and shrinks. The default stretch factor is 0, i.e giving the widget a minimum of space.

The widget is located to the far left of the first permanent widget (see addPermanentWidget() ) and may be obscured by temporary messages.

See also

insertWidget() removeWidget() addPermanentWidget()

PySide2.QtWidgets.QStatusBar.clearMessage()

Removes any temporary message being shown.

See also

currentMessage() showMessage() removeWidget()

PySide2.QtWidgets.QStatusBar.currentMessage()
Return type:

str

Returns the temporary message currently shown, or an empty string if there is no such message.

See also

showMessage()

PySide2.QtWidgets.QStatusBar.hideOrShow()

Ensures that the right widgets are visible.

Used by the showMessage() and clearMessage() functions.

PySide2.QtWidgets.QStatusBar.insertPermanentWidget(index, widget[, stretch=0])
Parameters:
Return type:

int

Inserts the given widget at the given index permanently to this status bar, reparenting the widget if it isn’t already a child of this QStatusBar object. If index is out of range, the widget is appended (in which case it is the actual index of the widget that is returned).

The stretch parameter is used to compute a suitable size for the given widget as the status bar grows and shrinks. The default stretch factor is 0, i.e giving the widget a minimum of space.

Permanently means that the widget may not be obscured by temporary messages. It is is located at the far right of the status bar.

See also

addPermanentWidget() removeWidget() addWidget()

PySide2.QtWidgets.QStatusBar.insertWidget(index, widget[, stretch=0])
Parameters:
Return type:

int

Inserts the given widget at the given index to this status bar, reparenting the widget if it isn’t already a child of this QStatusBar object. If index is out of range, the widget is appended (in which case it is the actual index of the widget that is returned).

The stretch parameter is used to compute a suitable size for the given widget as the status bar grows and shrinks. The default stretch factor is 0, i.e giving the widget a minimum of space.

The widget is located to the far left of the first permanent widget (see addPermanentWidget() ) and may be obscured by temporary messages.

See also

addWidget() removeWidget() addPermanentWidget()

PySide2.QtWidgets.QStatusBar.isSizeGripEnabled()
Return type:

bool

This property holds whether the QSizeGrip in the bottom-right corner of the status bar is enabled.

The size grip is enabled by default.

PySide2.QtWidgets.QStatusBar.messageChanged(text)
Parameters:

text – str

PySide2.QtWidgets.QStatusBar.reformat()

Changes the status bar’s appearance to account for item changes.

Special subclasses may need this function, but geometry management will usually take care of any necessary rearrangements.

PySide2.QtWidgets.QStatusBar.removeWidget(widget)
Parameters:

widget – PySide2.QtWidgets.QWidget

Removes the specified widget from the status bar.

Note

This function does not delete the widget but hides it. To add the widget again, you must call both the addWidget() and show() functions.

See also

addWidget() addPermanentWidget() clearMessage()

PySide2.QtWidgets.QStatusBar.setSizeGripEnabled(arg__1)
Parameters:

arg__1 – bool

This property holds whether the QSizeGrip in the bottom-right corner of the status bar is enabled.

The size grip is enabled by default.

PySide2.QtWidgets.QStatusBar.showMessage(text[, timeout=0])
Parameters:

  • text – str

  • timeout – int

Hides the normal status indications and displays the given message for the specified number of milli-seconds (timeout ). If timeout is 0 (default), the message remains displayed until the clearMessage() slot is called or until the slot is called again to change the message.

Note that is called to show temporary explanations of tool tip texts, so passing a timeout of 0 is not sufficient to display a permanent message .

See also

messageChanged() currentMessage() clearMessage()