QListBoxItem

Section: Misc. Reference Manual Pages (3qt)
Updated: 2 February 2007
Index Return to Main Contents

NAME

QListBoxItem - The base class of all list box items

SYNOPSIS

Inherited by QListBoxText and QListBoxPixmap.

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 )

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

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.

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.

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

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

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.

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

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.

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]

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.

COPYRIGHT

AUTHOR

Generated automatically from the source code.

BUGS

If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you. The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech. If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qlistboxitem.3qt) and the Qt version (3.3.8).