Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KStatusBar Class Reference

KDE statusbar widget. More...

#include <kstatusbar.h>

List of all members.

Public Types

enum  BarStatus

Signals

void pressed (int)
void released (int)

Public Methods

 KStatusBar (QWidget *parent=0L, const char *name=0L)
 ~KStatusBar ()
void insertItem (const QString &text, int id, int stretch=0, bool permanent=false)
void insertFixedItem (const QString &text, int id, bool permanent=false)
void removeItem (int id)
void changeItem (const QString &text, int id)
void setItemAlignment (int id, int align)
void setItemFixed (int id, int width=-1)


Detailed Description

KDE statusbar widget.

Display status messages.

You can insert text labels or custom widgets. Their geometry is managed internally. KStatusBar resizes itself, but positioning is left to KMainWindow (or to you, if you don't use KMainWindow ).

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 QStatusBar::clear(). See QStatusBar::message for details.

KStatusBar inherits QStatusBar, you can freely use all QStatusBar methods.

Empty text items are not visible. They will become visible when you change (add) text.

Author:
Mark Donohoe (donohoe@kde.org) Maintained by Sven Radej <radej@kde.org>
Version:
Id:
kstatusbar.h,v 1.34 2002/03/04 00:51:51 lunakl Exp

Definition at line 81 of file kstatusbar.h.


Member Enumeration Documentation

enum KStatusBar::BarStatus
 

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.


Constructor & Destructor Documentation

KStatusBar::KStatusBar QWidget *    parent = 0L,
const char *    name = 0L
 

Constructs a status bar. parent is usually KMainWindow.

KStatusBar::~KStatusBar  
 

Destructor.

Deletes all internal objects.


Member Function Documentation

void KStatusBar::changeItem const QString &    text,
int    id
 

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).

Parameters:
id  The id of item.

void KStatusBar::insertFixedItem const QString &    text,
int    id,
bool    permanent = false
[inline]
 

Inserts a fixed width text label into status bar. The width will be set according to text, but will remain fixed even if you change text. You can change fixed width by calling setItemFixed.

Parameters:
id  id ov item
permanent  permanent flag passed to QStatusBar::addWidget

Definition at line 128 of file kstatusbar.h.

References insertItem(), and setItemFixed().

void KStatusBar::insertItem const QString &    text,
int    id,
int    stretch = 0,
bool    permanent = false
 

Inserts a text label into the status bar. Paremeters stretch and permanent are passed to QStatusBar::addWidget .

If permanent is true, then item will be placed on the far right of the statusbar and will never be hidden by QStatusBar::message.

Parameters:
id  id of item
stretch  stretch passed to QStatusBar::addWidget
permanent  is item permanent or not (passed to QStatusBar::addWidget )
See also:
QStatusbar::addWidget

Referenced by insertFixedItem().

void KStatusBar::pressed int    [signal]
 

Emitted when mouse is pressed over item id.

Connect to this signal if you want to respond to mouse press events.

void KStatusBar::released int    [signal]
 

Emitted when mouse is released over item id.

Connect to this signal if you want to respond to mouse release events (clicks).

void KStatusBar::removeItem int    id
 

Removes an item.

Parameters:
id  The item to remove.

void KStatusBar::setItemAlignment int    id,
int    align
 

Sets the alignment of item id. By default all fields are aligned AlignHCenter | AlignVCenter. See QLabel::setAlignment for details.

void KStatusBar::setItemFixed int    id,
int    width = -1
 

Sets item id to have fixed width. This cannot be undone, but you can always set new fixed width.

Parameters:
id  id of item
width  fixed width in pixels. Default -1 is to adapt to text width.

Referenced by insertFixedItem().


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:25 2003 for kdelibs by doxygen1.2.18