From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qstatusbar.html | 217 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 217 insertions(+) create mode 100644 doc/html/qstatusbar.html (limited to 'doc/html/qstatusbar.html') diff --git a/doc/html/qstatusbar.html b/doc/html/qstatusbar.html new file mode 100644 index 0000000..0fe9728 --- /dev/null +++ b/doc/html/qstatusbar.html @@ -0,0 +1,217 @@ + + + + + +QStatusBar Class + + + + + + + +

QStatusBar Class Reference

+ +

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

#include <qstatusbar.h> +

Inherits QWidget. +

List of all member functions. +

Public Members

QStatusBar ( QWidget * parent = 0, const char * name = 0 )
virtual ~QStatusBar ()
virtual void addWidget ( QWidget * widget, int stretch = 0, bool permanent = FALSE )
virtual void removeWidget ( QWidget * widget )
void setSizeGripEnabled ( bool )
bool isSizeGripEnabled () const

Public Slots

void message ( const QString & message )
void message ( const QString & message, int ms )
void clear ()

Signals

void messageChanged ( const QString & message )

Properties

bool sizeGripEnabled - whether the QSizeGrip in the bottom right of the status bar is enabled

Protected Members

virtual void paintEvent ( QPaintEvent * )
void reformat ()
void hideOrShow ()

Detailed Description

+ + +The 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. +

QStatusBar lets you display all three types of indicators. +

To display a temporary message, call message() (perhaps by +connecting a suitable signal to it). To remove a temporary +message, call clear(). There are two variants of message(): one +that displays the message until the next clear() or message() and +one that has a time limit: +

+        connect( loader, SIGNAL(progressMessage(const QString&)),
+                 statusBar(), SLOT(message(const QString&)) );
+
+        statusBar()->message("Loading...");  // Initial message
+        loader.loadStuff();                  // Emits progress messages
+        statusBar()->message("Done.", 2000); // Final message for 2 seconds
+

+ +

Normal and Permanent messages are displayed by creating a +small widget and then adding it to the status bar with +addWidget(). Widgets like QLabel, QProgressBar or even QToolButton +are useful for adding to status bars. removeWidget() is used to +remove widgets. +

+        statusBar()->addWidget(new MyReadWriteIndication(statusBar()));
+

+ +

By default QStatusBar provides a QSizeGrip in the lower-right +corner. You can disable it with setSizeGripEnabled(FALSE); +

Member Function Documentation

QStatusBar::QStatusBar ( QWidget * parent = 0, const char * name = 0 ) +

+Constructs a status bar called name with parent parent and +with a size grip. +

QStatusBar::~QStatusBar () `[virtual]` +

+Destroys the status bar and frees any allocated resources and +child widgets. + +

void QStatusBar::addWidget ( QWidget * widget, int stretch = 0, bool permanent = FALSE ) `[virtual]` +

+Adds widget to this status bar. widget is reparented if it +isn't already a child of the QStatusBar. +

widget is permanently visible if permanent is TRUE and may +be obscured by temporary messages if permanent is FALSE. The +default is FALSE. +

If permanent is TRUE, widget is located at the far right of +the status bar. If permanent is FALSE (the default), widget +is located just to the left of the first permanent widget. +

stretch is used to compute a suitable size for widget as the +status bar grows and shrinks. The default of 0 uses a minimum of +space. +

This function may cause some flicker. +

void QStatusBar::clear () `[slot]` +

+Removes any temporary message being shown. +

void QStatusBar::hideOrShow () `[protected]` +

+Ensures that the right widgets are visible. Used by message() and +clear(). + +

bool QStatusBar::isSizeGripEnabled () const +

Returns TRUE if the QSizeGrip in the bottom right of the status bar is enabled; otherwise returns FALSE. +See the "sizeGripEnabled" property for details. +

void QStatusBar::message ( const QString & message ) `[slot]` +

+Hides the normal status indicators and displays message until +clear() or another message() is called. +

void QStatusBar::message ( const QString & message, int ms ) `[slot]` +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Hides the normal status indications and displays message for ms milli-seconds or until clear() or another message() is called, +whichever occurs first. + +

void QStatusBar::messageChanged ( const QString & message ) `[signal]` +

+ +

This signal is emitted when the temporary status messages +changes. message is the new temporary message, and is a +null-string when the message has been removed. +

void QStatusBar::paintEvent ( QPaintEvent * ) `[virtual protected]` +

+Shows the temporary message, if appropriate. + +

Reimplemented from QWidget. +

void QStatusBar::reformat () `[protected]` +

+Changes the status bar's appearance to account for item changes. +Special subclasses may need this, but geometry management will +usually take care of any necessary rearrangements. + +

void QStatusBar::removeWidget ( QWidget * widget ) `[virtual]` +

+Removes widget from the status bar. +

This function may cause some flicker. +

Note that widget is not deleted. +

void QStatusBar::setSizeGripEnabled ( bool ) +

Sets whether the QSizeGrip in the bottom right of the status bar is enabled. +See the "sizeGripEnabled" property for details. +

Property Documentation

bool sizeGripEnabled

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

Enables or disables the QSizeGrip in the bottom right of the +status bar. By default, the size grip is enabled. + +

Set this property's value with setSizeGripEnabled() and get this property's value with isSizeGripEnabled(). + +

+ +

Trademarks +

Qt 3.3.8

+ -- cgit v1.2.1

QStatusBar Class Reference

Public Members

Public Slots

Signals

Properties

Protected Members

Detailed Description

Member Function Documentation

QStatusBar::QStatusBar ( QWidget * parent = 0, const char * name = 0 ) +

QStatusBar::~QStatusBar () [virtual] +

void QStatusBar::addWidget ( QWidget * widget, int stretch = 0, bool permanent = FALSE ) [virtual] +

void QStatusBar::clear () [slot] +

void QStatusBar::hideOrShow () [protected] +