QStatusBar

Synopsis

Functions

• def addPermanentWidget (widget[, stretch=0])
• def addWidget (widget[, stretch=0])
• def currentMessage ()
• def hideOrShow ()
• def insertPermanentWidget (index, widget[, stretch=0])
• def insertWidget (index, widget[, stretch=0])
• def isSizeGripEnabled ()
• def reformat ()
• def removeWidget (widget)
• def setSizeGripEnabled (arg__1)

Slots

• def clearMessage ()
• def showMessage (text[, timeout=0])

Signals

• def messageChanged (text)

Detailed Description

The PySide.QtGui.QStatusBar class provides a horizontal bar suitable for presenting status information.

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.

PySide.QtGui.QStatusBar lets you display all three types of indicators.

Typically, a request for the status bar functionality occurs in relation to a PySide.QtGui.QMainWindow object. PySide.QtGui.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 QMainWindow.statusBar() function, and replaced using the QMainWindow.setStatusBar() function.

Use the PySide.QtGui.QStatusBar.showMessage() slot to display a temporary message:

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

To remove a temporary message, use the PySide.QtGui.QStatusBar.clearMessage() slot, or set a time limit when calling PySide.QtGui.QStatusBar.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 PySide.QtGui.QStatusBar.currentMessage() function to retrieve the temporary message currently shown. The PySide.QtGui.QStatusBar class also provide the PySide.QtGui.QStatusBar.messageChanged() signal which is emitted whenever the temporary status message changes.

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

statusBar().addWidget(MyReadWriteIndication())

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

See also

PySide.QtGui.QMainWindow PySide.QtGui.QStatusTipEvent GUI Design Handbook: Status Bar Application Example

class PySide.QtGui.QStatusBar([parent=None])

Parameters:parent – PySide.QtGui.QWidget

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

See also

PySide.QtGui.QStatusBar.setSizeGripEnabled()

PySide.QtGui.QStatusBar.addPermanentWidget(widget[, stretch=0])

Parameters:

• widget – PySide.QtGui.QWidget
• stretch – PySide.QtCore.int

Adds the given widget permanently to this status bar, reparenting the widget if it isn’t already a child of this PySide.QtGui.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

PySide.QtGui.QStatusBar.insertPermanentWidget() PySide.QtGui.QStatusBar.removeWidget() PySide.QtGui.QStatusBar.addWidget()

PySide.QtGui.QStatusBar.addWidget(widget[, stretch=0])

Parameters:

• widget – PySide.QtGui.QWidget
• stretch – PySide.QtCore.int

Adds the given widget to this status bar, reparenting the widget if it isn’t already a child of this PySide.QtGui.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 PySide.QtGui.QStatusBar.addPermanentWidget() ) and may be obscured by temporary messages.

See also

PySide.QtGui.QStatusBar.insertWidget() PySide.QtGui.QStatusBar.removeWidget() PySide.QtGui.QStatusBar.addPermanentWidget()

PySide.QtGui.QStatusBar.clearMessage()

Removes any temporary message being shown.

See also

PySide.QtGui.QStatusBar.currentMessage() PySide.QtGui.QStatusBar.showMessage() PySide.QtGui.QStatusBar.removeWidget()

PySide.QtGui.QStatusBar.currentMessage()

Return type:unicode

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

See also

PySide.QtGui.QStatusBar.showMessage()

PySide.QtGui.QStatusBar.hideOrShow()

Ensures that the right widgets are visible.

Used by the PySide.QtGui.QStatusBar.showMessage() and PySide.QtGui.QStatusBar.clearMessage() functions.

PySide.QtGui.QStatusBar.insertPermanentWidget(index, widget[, stretch=0])

Parameters:

• index – PySide.QtCore.int
• widget – PySide.QtGui.QWidget
• stretch – PySide.QtCore.int

Return type:

PySide.QtCore.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 PySide.QtGui.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

PySide.QtGui.QStatusBar.addPermanentWidget() PySide.QtGui.QStatusBar.removeWidget() PySide.QtGui.QStatusBar.addWidget()

PySide.QtGui.QStatusBar.insertWidget(index, widget[, stretch=0])

Parameters:

• index – PySide.QtCore.int
• widget – PySide.QtGui.QWidget
• stretch – PySide.QtCore.int

Return type:

PySide.QtCore.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 PySide.QtGui.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 PySide.QtGui.QStatusBar.addPermanentWidget() ) and may be obscured by temporary messages.

See also

PySide.QtGui.QStatusBar.addWidget() PySide.QtGui.QStatusBar.removeWidget() PySide.QtGui.QStatusBar.addPermanentWidget()

PySide.QtGui.QStatusBar.isSizeGripEnabled()

Return type:PySide.QtCore.bool

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

The size grip is enabled by default.

PySide.QtGui.QStatusBar.messageChanged(text)

Parameters:text – unicode

PySide.QtGui.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.

PySide.QtGui.QStatusBar.removeWidget(widget)

Parameters:widget – PySide.QtGui.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 PySide.QtGui.QStatusBar.addWidget() and PySide.QtGui.QWidget.show() functions.

See also

PySide.QtGui.QStatusBar.addWidget() PySide.QtGui.QStatusBar.addPermanentWidget() PySide.QtGui.QStatusBar.clearMessage()

PySide.QtGui.QStatusBar.setSizeGripEnabled(arg__1)

Parameters:arg__1 – PySide.QtCore.bool

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

The size grip is enabled by default.

PySide.QtGui.QStatusBar.showMessage(text[, timeout=0])

Parameters:

• text – unicode
• timeout – PySide.QtCore.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 PySide.QtGui.QStatusBar.clearMessage() slot is called or until the PySide.QtGui.QStatusBar.showMessage() slot is called again to change the message.

Note that PySide.QtGui.QStatusBar.showMessage() 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

PySide.QtGui.QStatusBar.messageChanged() PySide.QtGui.QStatusBar.currentMessage() PySide.QtGui.QStatusBar.clearMessage()