.TH "KStatusBar" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KStatusBar \- KDE statusbar widget  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kstatusbar.h>\fP
.PP
Inherits \fBQStatusBar\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBBarStatus\fP { \fBToggle\fP, \fBShow\fP, \fBHide\fP }"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBpressed\fP (int)"
.br
.ti -1c
.RI "void \fBreleased\fP (int)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKStatusBar\fP (\fBQWidget\fP *parent=0L, const char *name=0L)"
.br
.ti -1c
.RI "\fB~KStatusBar\fP ()"
.br
.ti -1c
.RI "void \fBinsertItem\fP (const \fBQString\fP &text, int id, int stretch=0, bool permanent=false)"
.br
.ti -1c
.RI "void \fBinsertFixedItem\fP (const \fBQString\fP &text, int id, bool permanent=false)"
.br
.ti -1c
.RI "void \fBremoveItem\fP (int id)"
.br
.ti -1c
.RI "bool \fBhasItem\fP (int id) const "
.br
.ti -1c
.RI "void \fBchangeItem\fP (const \fBQString\fP &text, int id)"
.br
.ti -1c
.RI "void \fBsetItemAlignment\fP (int id, int align)"
.br
.ti -1c
.RI "void \fBsetItemFixed\fP (int id, int width=-1)"
.br
.in -1c
.SH "Detailed Description"
.PP 
KDE statusbar widget 

Display status messages.
.PP
You can insert text labels or custom widgets. Their geometry is managed internally. KStatusBar resizes itself, but positioning is left to \fBKMainWindow\fP (or to you, if you don't use \fBKMainWindow\fP ).
.PP
A special type of item is a message which is a temporary text-message displayed on top of other items in full-width. Messages are visible for specified time, or until you call the slot \fBQStatusBar::clear()\fP. See \fBQStatusBar::message\fP for details.
.PP
It is useful to connect the \fBKActionCollection\fP signals to the \fBQStatusBar::message\fP slots.
.PP
KStatusBar inherits \fBQStatusBar\fP, you can freely use all \fBQStatusBar\fP methods.
.PP
Empty text items are not visible. They will become visible when you change (add) text.
.PP
\fBAuthor:\fP
.RS 4
Mark Donohoe (donohoe@kde.org) Maintained by Sven Radej <radej@kde.org>
.RE
.PP
\fBSee also:\fP
.RS 4
\fBKActionCollection\fP 
.RE
.PP

.PP
Definition at line 87 of file kstatusbar.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKStatusBar::BarStatus\fP"
.PP
\fBDeprecated\fP
.RS 4
WARNING: This enum is only for backward compatibility and it may be removed. No method here uses it. 
.RE
.PP

.PP
Definition at line 97 of file kstatusbar.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KStatusBar::KStatusBar (\fBQWidget\fP * parent = \fC0L\fP, const char * name = \fC0L\fP)"
.PP
Constructs a status bar. 
.PP
\fCparent\fP is usually \fBKMainWindow\fP. 
.PP
Definition at line 61 of file kstatusbar.cpp.
.PP
References KGlobal::config(), KConfigBase::group(), KConfigBase::readBoolEntry(), KConfigBase::setGroup(), and QStatusBar::setSizeGripEnabled().
.SS "KStatusBar::~\fBKStatusBar\fP ()"
.PP
Destructor. 
.PP
Deletes all internal objects. 
.PP
Definition at line 74 of file kstatusbar.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KStatusBar::insertItem (const \fBQString\fP & text, int id, int stretch = \fC0\fP, bool permanent = \fCfalse\fP)"
.PP
Inserts a text label into the status bar. 
.PP
Paremeters \fCstretch\fP and \fCpermanent\fP are passed to \fBQStatusBar::addWidget\fP .
.PP
If \fCpermanent\fP is true, then item will be placed on the far right of the statusbar and will never be hidden by \fBQStatusBar::message\fP.
.PP
\fBParameters:\fP
.RS 4
\fItext\fP The label's text string. 
.br
\fIid\fP id of item 
.br
\fIstretch\fP stretch passed to \fBQStatusBar::addWidget\fP 
.br
\fIpermanent\fP is item permanent or not (passed to \fBQStatusBar::addWidget\fP )
.RE
.PP
\fBSee also:\fP
.RS 4
QStatusbar::addWidget 
.RE
.PP

.PP
Definition at line 78 of file kstatusbar.cpp.
.PP
References QStatusBar::addWidget(), endl(), QIntDict::insert(), and kdDebug().
.SS "void KStatusBar::insertFixedItem (const \fBQString\fP & text, int id, bool permanent = \fCfalse\fP)\fC [inline]\fP"
.PP
Inserts a fixed width text label into status bar. 
.PP
The width will be set according to \fCtext\fP, but will remain fixed even if you change text. You can change fixed width by calling setItemFixed.
.PP
\fBParameters:\fP
.RS 4
\fItext\fP The label's text string 
.br
\fIid\fP id of item 
.br
\fIpermanent\fP permanent flag passed to \fBQStatusBar::addWidget\fP 
.RE
.PP

.PP
Definition at line 138 of file kstatusbar.h.
.SS "void KStatusBar::removeItem (int id)"
.PP
Removes an item. 
.PP
\fBParameters:\fP
.RS 4
\fIid\fP The item to remove. 
.RE
.PP

.PP
Definition at line 90 of file kstatusbar.cpp.
.PP
References endl(), kdDebug(), QIntDict::remove(), and QStatusBar::removeWidget().
.PP
Referenced by KXMLGUIBuilder::removeContainer().
.SS "bool KStatusBar::hasItem (int id) const"
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Returns true if an item with \fCid\fP exists already in KStatusBar, otherwise returns false.
.PP
\fBParameters:\fP
.RS 4
\fIid\fP id of the item 
.RE
.PP

.PP
Definition at line 103 of file kstatusbar.cpp.
.SS "void KStatusBar::changeItem (const \fBQString\fP & text, int id)"
.PP
Changes the text in a status bar field. 
.PP
The item will be resized to fit the text. If you change text to be empty, item will not be visible (untill you add some text).
.PP
\fBParameters:\fP
.RS 4
\fItext\fP The label's text string 
.br
\fIid\fP The id of item. 
.RE
.PP

.PP
Definition at line 112 of file kstatusbar.cpp.
.PP
References endl(), kdDebug(), QStatusBar::reformat(), and QLabel::setText().
.SS "void KStatusBar::setItemAlignment (int id, int align)"
.PP
Sets the alignment of item \fCid\fP. 
.PP
By default all fields are aligned \fCAlignHCenter\fP | \fCAlignVCenter\fP. See \fBQLabel::setAlignment\fP for details. 
.PP
Definition at line 127 of file kstatusbar.cpp.
.PP
References endl(), kdDebug(), and QLabel::setAlignment().
.SS "void KStatusBar::setItemFixed (int id, int width = \fC-1\fP)"
.PP
Sets item \fCid\fP to have fixed width. 
.PP
This cannot be undone, but you can always set new fixed width.
.PP
\fBParameters:\fP
.RS 4
\fIid\fP id of item 
.br
\fIwidth\fP fixed width in pixels. Default -1 is to adapt to text width. 
.RE
.PP

.PP
Definition at line 138 of file kstatusbar.cpp.
.PP
References endl(), kdDebug(), and QLabel::text().
.SS "void KStatusBar::pressed (int)\fC [signal]\fP"
.PP
Emitted when mouse is pressed over item \fCid\fP. 
.PP
Connect to this signal if you want to respond to mouse press events. 
.SS "void KStatusBar::released (int)\fC [signal]\fP"
.PP
Emitted when mouse is released over item \fCid\fP. 
.PP
Connect to this signal if you want to respond to mouse release events (clicks). 

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
