.TH "KStatusBar" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KStatusBar \- Display status messages. \fBKDE\fP 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
.RI "\fIWARNING: This enum is only for backward compatibility and it may be removed. \fP"
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBpressed\fP (int)"
.br
.RI "\fIEmitted when mouse is pressed over item \fCid\fP. \fP"
.ti -1c
.RI "void \fBreleased\fP (int)"
.br
.RI "\fIEmitted when mouse is released over item \fCid\fP. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKStatusBar\fP (\fBQWidget\fP *parent=0L, const  char *name=0L)"
.br
.RI "\fIConstructs a status bar. \fP"
.ti -1c
.RI "\fB~KStatusBar\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "void \fBinsertItem\fP (const  \fBQString\fP &text, int id, int stretch=0, bool permanent=false)"
.br
.RI "\fIInserts a text label into the status bar. \fP"
.ti -1c
.RI "void \fBinsertFixedItem\fP (const  \fBQString\fP &text, int id, bool permanent=false)"
.br
.RI "\fIInserts a fixed width text label into status bar. \fP"
.ti -1c
.RI "void \fBremoveItem\fP (int id)"
.br
.RI "\fIRemoves an item. \fP"
.ti -1c
.RI "void \fBchangeItem\fP (const  \fBQString\fP &text, int id)"
.br
.RI "\fIChanges the text in a status bar field. \fP"
.ti -1c
.RI "void \fBsetItemAlignment\fP (int id, int align)"
.br
.RI "\fISets the alignment of item \fCid\fP. \fP"
.ti -1c
.RI "void \fBsetItemFixed\fP (int id, int width=-1)"
.br
.RI "\fISets item \fCid\fP to have fixed width. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Display status messages. \fBKDE\fP statusbar widget. 

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
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
\fBVersion:\fP
.RS 4
\fBId\fP.RS 4
\fBkstatusbar.h\fP,v 1.34 2002/03/04 00:51:51 lunakl Exp 
.RE
.PP
.RE
.PP

.PP
Definition at line 81 of file kstatusbar.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKStatusBar::BarStatus\fP"
.PP
WARNING: This enum is only for backward compatibility and it may be removed. No method here uses it. Definition at line 90 of file kstatusbar.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KStatusBar::KStatusBar (\fBQWidget\fP * parent = 0L, const char * name = 0L)"
.PP
Constructs a status bar. \fCparent\fP is usually \fBKMainWindow\fP. Definition at line 63 of file kstatusbar.cpp.
.PP
References KGlobal::config(), QString::fromLatin1(), KConfigBase::group(), KStdAccel::name(), KConfigBase::readBoolEntry(), KConfigBase::setGroup(), and QStatusBar::setSizeGripEnabled().
.SS "KStatusBar::~\fBKStatusBar\fP ()"
.PP
Destructor. Deletes all internal objects. Definition at line 76 of file kstatusbar.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KStatusBar::insertItem (const \fBQString\fP & text, int id, int stretch = 0, bool permanent = false)"
.PP
Inserts a text label into the status bar. 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
\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
Definition at line 80 of file kstatusbar.cpp.
.PP
References QStatusBar::addWidget(), and QIntDict< KStatusBarLabel >::insert().
.PP
Referenced by insertFixedItem().
.SS "void KStatusBar::insertFixedItem (const \fBQString\fP & text, int id, bool permanent = false)\fC [inline]\fP"
.PP
Inserts a fixed width text label into status bar. 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 \fBsetItemFixed\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIid\fP id ov item 
.br
\fIpermanent\fP permanent flag passed to \fBQStatusBar::addWidget\fP 
.RE
.PP
Definition at line 128 of file kstatusbar.h.
.PP
References insertItem(), and setItemFixed().
.SS "void KStatusBar::removeItem (int id)"
.PP
Removes an item. \fBParameters:\fP
.RS 4
\fIid\fP The item to remove. 
.RE
.PP
Definition at line 89 of file kstatusbar.cpp.
.PP
References QStatusBar::removeWidget().
.SS "void KStatusBar::changeItem (const \fBQString\fP & text, int id)"
.PP
Changes the text in a status bar field. 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
\fIid\fP The id of item. 
.RE
.PP
Definition at line 102 of file kstatusbar.cpp.
.PP
References QStatusBar::clear(), QStatusBar::reformat(), and QLabel::setText().
.SS "void KStatusBar::setItemAlignment (int id, int align)"
.PP
Sets the alignment of item \fCid\fP. By default all fields are aligned \fCAlignHCenter\fP | \fCAlignVCenter\fP. See \fBQLabel::setAlignment\fP for details. Definition at line 115 of file kstatusbar.cpp.
.PP
References QLabel::setAlignment().
.SS "void KStatusBar::setItemFixed (int id, int width = -1)"
.PP
Sets item \fCid\fP to have fixed width. 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
Definition at line 126 of file kstatusbar.cpp.
.PP
References QLabel::text().
.PP
Referenced by insertFixedItem().
.SS "void KStatusBar::pressed (int)\fC [signal]\fP"
.PP
Emitted when mouse is pressed over item \fCid\fP. 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. 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.
