<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /tmp/qt-3.0-reggie-28534/qt-x11-free-3.0.2/src/widgets/qstatusbar.cpp:49 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QStatusBar Class</title>
<style type="text/css"><!--
h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
<a href="index.html">
<font color="#004faf">Home</font></a>
| <a href="classes.html">
<font color="#004faf">All Classes</font></a>
| <a href="mainclasses.html">
<font color="#004faf">Main Classes</font></a>
| <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
| <a href="groups.html">
<font color="#004faf">Grouped Classes</font></a>
| <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QStatusBar Class Reference</h1>
<p>The QStatusBar class provides a horizontal bar suitable for
presenting status information.
<a href="#details">More...</a>
<p><tt>#include <<a href="qstatusbar-h.html">qstatusbar.h</a>></tt>
<p>Inherits <a href="qwidget.html">QWidget</a>.
<p><a href="qstatusbar-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li><div class=fn><a href="#QStatusBar"><b>QStatusBar</b></a> ( QWidget * parent = 0, const char * name = 0 )</div></li>
<li><div class=fn>virtual <a href="#~QStatusBar"><b>~QStatusBar</b></a> ()</div></li>
<li><div class=fn>virtual void <a href="#addWidget"><b>addWidget</b></a> ( QWidget * widget, int stretch = 0, bool permanent = FALSE )</div></li>
<li><div class=fn>virtual void <a href="#removeWidget"><b>removeWidget</b></a> ( QWidget * widget )</div></li>
<li><div class=fn>void <a href="#setSizeGripEnabled"><b>setSizeGripEnabled</b></a> ( bool )</div></li>
<li><div class=fn>bool <a href="#isSizeGripEnabled"><b>isSizeGripEnabled</b></a> () const</div></li>
</ul>
<h2>Public Slots</h2>
<ul>
<li><div class=fn>void <a href="#message"><b>message</b></a> ( const QString & message )</div></li>
<li><div class=fn>void <a href="#message-2"><b>message</b></a> ( const QString & message, int ms )</div></li>
<li><div class=fn>void <a href="#clear"><b>clear</b></a> ()</div></li>
</ul>
<h2>Properties</h2>
<ul>
<li><div class=fn>bool <a href="#sizeGripEnabled-prop"><b>sizeGripEnabled</b></a> - whether the QSizeGrip in the bottom right of the status bar is enabled</div></li>
</ul>
<h2>Protected Members</h2>
<ul>
<li><div class=fn>virtual void <a href="#paintEvent"><b>paintEvent</b></a> ( QPaintEvent * )</div></li>
<li><div class=fn>void <a href="#reformat"><b>reformat</b></a> ()</div></li>
<li><div class=fn>void <a href="#hideOrShow"><b>hideOrShow</b></a> ()</div></li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
<p> The QStatusBar class provides a horizontal bar suitable for
presenting status information.
<p>
<p> Each status indicator falls into one of three categories:
<p> <ul>
<li> <em>Temporary</em> - briefly occupies most of the status bar. Used
to explain tool tip texts or menu entries, for example.
<li> <em>Normal</em> - 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.
<li> <em>Permanent</em> - is never hidden. Used for important mode
indications, for example, some applications put a Caps Lock indicator in the
status bar.
</ul>
<p> QStatusBar lets you display all three types of indicators.
<p> To display a <em>temporary</em> message, call <a href="#message">message</a>() (perhaps by
connecting a suitable signal to it). To remove a temporary message,
call <a href="#clear">clear</a>().
There are two variants of message(): one that displays the message
until the next clear() or mesage() and one that has a time limit:
<p> <pre>
<a href="qobject.html#connect">connect</a>( loader, SIGNAL(progressMessage(const <a href="qstring.html">QString</a>&)),
statusBar(), SLOT(<a href="#message">message</a>(const <a href="qstring.html">QString</a>&)) );
statusBar()->message("Loading..."); // Initial message
loader.loadStuff(); // Emits progress messages
statusBar()->message("Done.", 2000); // Final message for 2 seconds
</pre>
<p> <em>Normal</em> and <em>permanent</em> messages are displayed by creating a small
widget and then adding it to the status bar with <a href="#addWidget">addWidget</a>(). Widgets
like <a href="qlabel.html">QLabel</a>, <a href="qprogressbar.html">QProgressBar</a> or even <a href="qtoolbutton.html">QToolButton</a> are useful for adding
to status bars. <a href="#removeWidget">removeWidget</a>() is used to remove widgets.
<p> <pre>
statusBar()->addWidget(new MyReadWriteIndication(statusBar()));
</pre>
<p> By default QStatusBar provides a <a href="qsizegrip.html">QSizeGrip</a> in the lower-right corner.
You can disable it with <a href="#setSizeGripEnabled">setSizeGripEnabled</a>(FALSE);
<p> <img src=qstatusbar-m.png> <img src=qstatusbar-w.png>
<p> <p>See also <a href="qtoolbar.html">QToolBar</a>, <a href="qmainwindow.html">QMainWindow</a>, <a href="qlabel.html">QLabel</a>, <a href="guibooks.html#fowler">GUI Design Handbook: Status Bar</a>, <a href="application.html">Main Window and Related Classes</a> and <a href="helpsystem.html">Help System</a>.
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QStatusBar"></a>QStatusBar::QStatusBar ( <a href="qwidget.html">QWidget</a> * parent = 0, const char * name = 0 )
</h3>
Constructs a status bar with the parent <em>parent</em> and the name
<em>name</em> and with a size grip.
<p> <p>See also <a href="#sizeGripEnabled-prop">sizeGripEnabled</a>.
<h3 class=fn><a name="~QStatusBar"></a>QStatusBar::~QStatusBar ()<tt> [virtual]</tt>
</h3>
Destroys the status bar and frees any allocated resources and child
widgets.
<h3 class=fn>void <a name="addWidget"></a>QStatusBar::addWidget ( <a href="qwidget.html">QWidget</a> * widget, int stretch = 0, bool permanent = FALSE )<tt> [virtual]</tt>
</h3>
Adds <em>widget</em> to this status bar.
<p> <em>widget</em> is permanently visible if <em>permanent</em> is TRUE and may be
obscured by temporary messages if <em>permanent</em> is FALSE. The
default is FALSE.
<p> If <em>permanent</em> is TRUE, <em>widget</em> is located at the far right of
the status bar. If <em>permanent</em> is FALSE (the default), <em>widget</em> is
located just to the left of the first permanent widget.
<p> <em>stretch</em> is used to compute a suitable size for <em>widget</em> as the
status bar grows and shrinks. The default of 0 uses a minimum of space.
<p> This function may cause some flicker.
<p> <p>See also <a href="#removeWidget">removeWidget</a>().
<h3 class=fn>void <a name="clear"></a>QStatusBar::clear ()<tt> [slot]</tt>
</h3>
Removes any temporary message being shown.
<p> <p>See also <a href="#message">message</a>().
<h3 class=fn>void <a name="hideOrShow"></a>QStatusBar::hideOrShow ()<tt> [protected]</tt>
</h3>
Ensures that the right widgets are visible. Used by <a href="#message">message</a>()
and <a href="#clear">clear</a>().
<h3 class=fn>bool <a name="isSizeGripEnabled"></a>QStatusBar::isSizeGripEnabled () const
</h3><p>Returns TRUE if the <a href="qsizegrip.html">QSizeGrip</a> in the bottom right of the status bar is enabled; otherwise returns FALSE.
See the <a href="qstatusbar.html#sizeGripEnabled-prop">"sizeGripEnabled"</a> property for details.
<h3 class=fn>void <a name="message"></a>QStatusBar::message ( const <a href="qstring.html">QString</a> & message )<tt> [slot]</tt>
</h3>
Hides the normal status indicators and displays <em>message</em> until
<a href="#clear">clear</a>() or another <a href="#message">message</a>() is called.
<p> <p>See also <a href="#clear">clear</a>().
<h3 class=fn>void <a name="message-2"></a>QStatusBar::message ( const <a href="qstring.html">QString</a> & message, int ms )<tt> [slot]</tt>
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Hides the normal status indications and displays <em>message</em> for <em>ms</em> milli-seconds or until <a href="#clear">clear</a>() or another <a href="#message">message</a>() is called,
whichever occurs first.
<h3 class=fn>void <a name="paintEvent"></a>QStatusBar::paintEvent ( <a href="qpaintevent.html">QPaintEvent</a> * )<tt> [virtual protected]</tt>
</h3>
Shows the temporary message, if appropriate.
<p>Reimplemented from <a href="qwidget.html#paintEvent">QWidget</a>.
<h3 class=fn>void <a name="reformat"></a>QStatusBar::reformat ()<tt> [protected]</tt>
</h3> 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.
<h3 class=fn>void <a name="removeWidget"></a>QStatusBar::removeWidget ( <a href="qwidget.html">QWidget</a> * widget )<tt> [virtual]</tt>
</h3>
Removes <em>widget</em> from the status bar.
<p> This function may cause some flicker.
<p> Note that <em>widget</em> is not deleted.
<p> <p>See also <a href="#addWidget">addWidget</a>().
<h3 class=fn>void <a name="setSizeGripEnabled"></a>QStatusBar::setSizeGripEnabled ( bool )
</h3><p>Sets whether the <a href="qsizegrip.html">QSizeGrip</a> in the bottom right of the status bar is enabled.
See the <a href="qstatusbar.html#sizeGripEnabled-prop">"sizeGripEnabled"</a> property for details.
<hr><h2>Property Documentation</h2>
<h3 class=fn>bool <a name="sizeGripEnabled-prop"></a>sizeGripEnabled</h3>
<p>This property holds whether the <a href="qsizegrip.html">QSizeGrip</a> in the bottom right of the status bar is enabled.
<p>Enables or disables the QSizeGrip in the bottom right of the status bar.
By default, the size grip is enabled.
<p>Set this property's value with <a href="#setSizeGripEnabled">setSizeGripEnabled</a>() and get this property's value with <a href="#isSizeGripEnabled">isSizeGripEnabled</a>().
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright © 1995-2001
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright © 2001
<a href="http://www.trolltech.com">Trolltech</a><td><a href="http://www.trolltech.com/trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt version 3.0.2</div>
</table></div></address></body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
112b0974ad288f6cd55bf971ee6026a9
>
files
>
1852
