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

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. If after is 0, the item is inserted at the beginning.

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.

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; otherwise returns FALSE.

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, a null pointer is returned.

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

Implement this function to draw your item. You will need to pass the QPainter that will draw the item in p.

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

Returns the pixmap associated with the item, if any.

The default implementation returns a null pointer.

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, a null pointer is returned.

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

Returns 0.

Although often frowned upon by purists, Run Time Type Identification is very useful in this case, as it allows a QListBox to be an efficient indexed storage mechanism.

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

void QListBoxItem::setSelectable ( bool b )

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

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

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

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

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

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