TQListBoxItem Class

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

# TQListBoxItem Class Reference

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

`#include <ntqlistbox.h>`

Inherited by TQListBoxText and TQListBoxPixmap.

List of all member functions.

## Public Members

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

## Protected Members

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

## Detailed Description

The TQListBoxItem 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 TQListBox you must inherit this class and reimplement paint(), height() and width().

See also TQListBox.

## Member Function Documentation

### TQListBoxItem::TQListBoxItem ( TQListBox * listbox = 0 )

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

### TQListBoxItem::TQListBoxItem ( TQListBox * listbox, TQListBoxItem * 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.

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

Destroys the list box item.

### bool TQListBoxItem::current () const

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

### int TQListBoxItem::height ( const TQListBox * 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 TQApplication::globalStrut()'s height.

See also paint() and width().

Reimplemented in TQListBoxText and TQListBoxPixmap.

### bool TQListBoxItem::isCurrent () const

Returns true if the item is the current item; otherwise returns false.

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

### bool TQListBoxItem::isSelectable () const

Returns true if this item is selectable (the default); otherwise returns false.

See also setSelectable().

### bool TQListBoxItem::isSelected () const

Returns true if the item is selected; otherwise returns false.

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

Example: listboxcombo/listboxcombo.cpp.

### TQListBox * TQListBoxItem::listBox () const

Returns a pointer to the list box containing this item.

### TQListBoxItem * TQListBoxItem::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 TQListBoxItem::paint ( TQPainter * 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 TQListBoxText and TQListBoxPixmap.

### const TQPixmap * TQListBoxItem::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 TQListBoxPixmap.

### TQListBoxItem * TQListBoxItem::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 TQListBoxItem::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 TQListBoxItem::selected () const

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

### void TQListBoxItem::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 TQListBoxItem::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 TQListBoxItem::setText ( const TQString & text )`[virtual protected]`

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

See also text().

### TQString TQListBoxItem::text () const`[virtual]`

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

See also setText().

Example: listboxcombo/listboxcombo.cpp.

### int TQListBoxItem::width ( const TQListBox * 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 TQApplication::globalStrut()'s width.

See also paint() and height().

Reimplemented in TQListBoxText and TQListBoxPixmap.

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