QListBoxItem Class

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# QListBoxItem Class Reference

The QListBoxItem class is the base class of all list box items. More...

`#include <qlistbox.h>`

Inherited by QListBoxText and QListBoxPixmap.

List of all member functions.

## Public Members

- QListBoxItem ( QListBox * listbox = 0 )
- QListBoxItem ( QListBox * listbox, QListBoxItem * after )
- virtual ~QListBoxItem ()
- virtual QString text () const
- virtual const QPixmap * pixmap () const
- virtual int height ( const QListBox * lb ) const
- virtual int width ( const QListBox * lb ) const
- bool isSelected () const
- bool isCurrent () const
- bool selected () const (obsolete)
- bool current () const (obsolete)
- QListBox * listBox () const
- void setSelectable ( bool b )
- bool isSelectable () const
- QListBoxItem * next () const
- QListBoxItem * prev () const
- virtual int rtti () const

## Protected Members

- virtual void paint ( QPainter * p ) = 0
- virtual void setText ( const QString & text )
- void setCustomHighlighting ( bool b )

## Detailed Description

The QListBoxItem class is the base class of all list box items.

This class is an abstract base class used for all list box items. If you need to insert customized items into a QListBox you must inherit this class and reimplement paint(), height() and width().

See also QListBox.

## Member Function Documentation

### QListBoxItem::QListBoxItem ( QListBox * listbox = 0 )

Constructs an empty list box item in the list box listbox.

### QListBoxItem::QListBoxItem ( QListBox * listbox, QListBoxItem * after )

Constructs an empty list box item in the list box listbox and inserts it after the item after or at the beginning if after is 0.

### QListBoxItem::~QListBoxItem ()`[virtual]`

Destroys the list box item.

### bool QListBoxItem::current () const

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.

### int QListBoxItem::height ( const QListBox * lb ) const`[virtual]`

Implement this function to return the height of your item. The lb parameter is the same as listBox() and is provided for convenience and compatibility.

The default implementation returns QApplication::globalStrut()'s height.

See also paint() and width().

Reimplemented in QListBoxText and QListBoxPixmap.

### bool QListBoxItem::isCurrent () const

Returns TRUE if the item is the current item; otherwise returns FALSE.

See also QListBox::currentItem, QListBox::item(), and isSelected().

### bool QListBoxItem::isSelectable () const

Returns TRUE if this item is selectable (the default); otherwise returns FALSE.

See also setSelectable().

### bool QListBoxItem::isSelected () const

Returns TRUE if the item is selected; otherwise returns FALSE.

See also QListBox::isSelected() and isCurrent().

Example: listboxcombo/listboxcombo.cpp.

### QListBox * QListBoxItem::listBox () const

Returns a pointer to the list box containing this item.

### QListBoxItem * QListBoxItem::next () const

Returns the item that comes after this in the list box. If this is the last item, 0 is returned.

See also prev().

### void QListBoxItem::paint ( QPainter * p )`[pure virtual protected]`

Implement this function to draw your item. The painter, p, is already open for painting.

See also height() and width().

Example: listboxcombo/listboxcombo.cpp.

Reimplemented in QListBoxText and QListBoxPixmap.

### const QPixmap * QListBoxItem::pixmap () const`[virtual]`

Returns the pixmap associated with the item, or 0 if there isn't one.

The default implementation returns 0.

Example: listboxcombo/listboxcombo.cpp.

Reimplemented in QListBoxPixmap.

### QListBoxItem * QListBoxItem::prev () const

Returns the item which comes before this in the list box. If this is the first item, 0 is returned.

See also next().

### int QListBoxItem::rtti () const`[virtual]`

Returns 0.

Make your derived classes return their own values for rtti(), and you can distinguish between listbox items. You should use values greater than 1000 preferably a large random number, to allow for extensions to this class.

### bool QListBoxItem::selected () const

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.

### void QListBoxItem::setCustomHighlighting ( bool b )`[protected]`

Defines whether the list box item is responsible for drawing itself in a highlighted state when being selected.

If b is FALSE (the default), the list box will draw some default highlight indicator before calling paint().

See also selected() and paint().

### void QListBoxItem::setSelectable ( bool b )

If b is TRUE (the default) then this item can be selected by the user; otherwise this item cannot be selected by the user.

See also isSelectable().

### void QListBoxItem::setText ( const QString & text )`[virtual protected]`

Sets the text of the QListBoxItem to text. This text is also used for sorting. The text is not shown unless explicitly drawn in paint().

See also text().

### QString QListBoxItem::text () const`[virtual]`

Returns the text of the item. This text is also used for sorting.

See also setText().

Example: listboxcombo/listboxcombo.cpp.

### int QListBoxItem::width ( const QListBox * lb ) const`[virtual]`

Reimplement this function to return the width of your item. The lb parameter is the same as listBox() and is provided for convenience and compatibility.

The default implementation returns QApplication::globalStrut()'s width.

See also paint() and height().

Reimplemented in QListBoxText and QListBoxPixmap.

This file is part of the Qt toolkit. Copyright © 1995-2005 Trolltech. All Rights Reserved.