summaryrefslogtreecommitdiffstats
path: root/doc/man/man3/qlistboxitem.3qt
diff options
context:
space:
mode:
authorTimothy Pearson <[email protected]>2011-11-08 12:31:36 -0600
committerTimothy Pearson <[email protected]>2011-11-08 12:31:36 -0600
commitd796c9dd933ab96ec83b9a634feedd5d32e1ba3f (patch)
tree6e3dcca4f77e20ec8966c666aac7c35bd4704053 /doc/man/man3/qlistboxitem.3qt
downloadtqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.tar.gz
tqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.zip
Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731
Diffstat (limited to 'doc/man/man3/qlistboxitem.3qt')
-rw-r--r--doc/man/man3/qlistboxitem.3qt203
1 files changed, 203 insertions, 0 deletions
diff --git a/doc/man/man3/qlistboxitem.3qt b/doc/man/man3/qlistboxitem.3qt
new file mode 100644
index 000000000..ab4c4e4cf
--- /dev/null
+++ b/doc/man/man3/qlistboxitem.3qt
@@ -0,0 +1,203 @@
+'\" t
+.TH QListBoxItem 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
+.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the
+.\" license file included in the distribution for a complete license
+.\" statement.
+.\"
+.ad l
+.nh
+.SH NAME
+QListBoxItem \- The base class of all list box items
+.SH SYNOPSIS
+\fC#include <qlistbox.h>\fR
+.PP
+Inherited by QListBoxText and QListBoxPixmap.
+.PP
+.SS "Public Members"
+.in +1c
+.ti -1c
+.BI "\fBQListBoxItem\fR ( QListBox * listbox = 0 )"
+.br
+.ti -1c
+.BI "\fBQListBoxItem\fR ( QListBox * listbox, QListBoxItem * after )"
+.br
+.ti -1c
+.BI "virtual \fB~QListBoxItem\fR ()"
+.br
+.ti -1c
+.BI "virtual QString \fBtext\fR () const"
+.br
+.ti -1c
+.BI "virtual const QPixmap * \fBpixmap\fR () const"
+.br
+.ti -1c
+.BI "virtual int \fBheight\fR ( const QListBox * lb ) const"
+.br
+.ti -1c
+.BI "virtual int \fBwidth\fR ( const QListBox * lb ) const"
+.br
+.ti -1c
+.BI "bool \fBisSelected\fR () const"
+.br
+.ti -1c
+.BI "bool \fBisCurrent\fR () const"
+.br
+.ti -1c
+.BI "bool selected () const \fI(obsolete)\fR"
+.br
+.ti -1c
+.BI "bool current () const \fI(obsolete)\fR"
+.br
+.ti -1c
+.BI "QListBox * \fBlistBox\fR () const"
+.br
+.ti -1c
+.BI "void \fBsetSelectable\fR ( bool b )"
+.br
+.ti -1c
+.BI "bool \fBisSelectable\fR () const"
+.br
+.ti -1c
+.BI "QListBoxItem * \fBnext\fR () const"
+.br
+.ti -1c
+.BI "QListBoxItem * \fBprev\fR () const"
+.br
+.ti -1c
+.BI "virtual int \fBrtti\fR () const"
+.br
+.in -1c
+.SS "Protected Members"
+.in +1c
+.ti -1c
+.BI "virtual void \fBpaint\fR ( QPainter * p ) = 0"
+.br
+.ti -1c
+.BI "virtual void \fBsetText\fR ( const QString & text )"
+.br
+.ti -1c
+.BI "void \fBsetCustomHighlighting\fR ( bool b )"
+.br
+.in -1c
+.SH DESCRIPTION
+The QListBoxItem class is the base class of all list box items.
+.PP
+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().
+.PP
+See also QListBox.
+.SH MEMBER FUNCTION DOCUMENTATION
+.SH "QListBoxItem::QListBoxItem ( QListBox * listbox = 0 )"
+Constructs an empty list box item in the list box \fIlistbox\fR.
+.SH "QListBoxItem::QListBoxItem ( QListBox * listbox, QListBoxItem * after )"
+Constructs an empty list box item in the list box \fIlistbox\fR and inserts it after the item \fIafter\fR or at the beginning if \fIafter\fR is 0.
+.SH "QListBoxItem::~QListBoxItem ()\fC [virtual]\fR"
+Destroys the list box item.
+.SH "bool QListBoxItem::current () const"
+\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code.
+.SH "int QListBoxItem::height ( const QListBox * lb ) const\fC [virtual]\fR"
+Implement this function to return the height of your item. The \fIlb\fR parameter is the same as listBox() and is provided for convenience and compatibility.
+.PP
+The default implementation returns QApplication::globalStrut()'s height.
+.PP
+See also paint() and width().
+.PP
+Reimplemented in QListBoxText and QListBoxPixmap.
+.SH "bool QListBoxItem::isCurrent () const"
+Returns TRUE if the item is the current item; otherwise returns FALSE.
+.PP
+See also QListBox::currentItem, QListBox::item(), and isSelected().
+.SH "bool QListBoxItem::isSelectable () const"
+Returns TRUE if this item is selectable (the default); otherwise returns FALSE.
+.PP
+See also setSelectable().
+.SH "bool QListBoxItem::isSelected () const"
+Returns TRUE if the item is selected; otherwise returns FALSE.
+.PP
+See also QListBox::isSelected() and isCurrent().
+.PP
+Example: listboxcombo/listboxcombo.cpp.
+.SH "QListBox * QListBoxItem::listBox () const"
+Returns a pointer to the list box containing this item.
+.SH "QListBoxItem * QListBoxItem::next () const"
+Returns the item that comes after this in the list box. If this is the last item, 0 is returned.
+.PP
+See also prev().
+.SH "void QListBoxItem::paint ( QPainter * p )\fC [pure virtual protected]\fR"
+Implement this function to draw your item. The painter, \fIp\fR, is already open for painting.
+.PP
+See also height() and width().
+.PP
+Example: listboxcombo/listboxcombo.cpp.
+.PP
+Reimplemented in QListBoxText and QListBoxPixmap.
+.SH "const QPixmap * QListBoxItem::pixmap () const\fC [virtual]\fR"
+Returns the pixmap associated with the item, or 0 if there isn't one.
+.PP
+The default implementation returns 0.
+.PP
+Example: listboxcombo/listboxcombo.cpp.
+.PP
+Reimplemented in QListBoxPixmap.
+.SH "QListBoxItem * QListBoxItem::prev () const"
+Returns the item which comes before this in the list box. If this is the first item, 0 is returned.
+.PP
+See also next().
+.SH "int QListBoxItem::rtti () const\fC [virtual]\fR"
+Returns 0.
+.PP
+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.
+.SH "bool QListBoxItem::selected () const"
+\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code.
+.SH "void QListBoxItem::setCustomHighlighting ( bool b )\fC [protected]\fR"
+Defines whether the list box item is responsible for drawing itself in a highlighted state when being selected.
+.PP
+If \fIb\fR is FALSE (the default), the list box will draw some default highlight indicator before calling paint().
+.PP
+See also selected() and paint().
+.SH "void QListBoxItem::setSelectable ( bool b )"
+If \fIb\fR is TRUE (the default) then this item can be selected by the user; otherwise this item cannot be selected by the user.
+.PP
+See also isSelectable().
+.SH "void QListBoxItem::setText ( const QString & text )\fC [virtual protected]\fR"
+Sets the text of the QListBoxItem to \fItext\fR. This \fItext\fR is also used for sorting. The text is not shown unless explicitly drawn in paint().
+.PP
+See also text().
+.SH "QString QListBoxItem::text () const\fC [virtual]\fR"
+Returns the text of the item. This text is also used for sorting.
+.PP
+See also setText().
+.PP
+Example: listboxcombo/listboxcombo.cpp.
+.SH "int QListBoxItem::width ( const QListBox * lb ) const\fC [virtual]\fR"
+Reimplement this function to return the width of your item. The \fIlb\fR parameter is the same as listBox() and is provided for convenience and compatibility.
+.PP
+The default implementation returns QApplication::globalStrut()'s width.
+.PP
+See also paint() and height().
+.PP
+Reimplemented in QListBoxText and QListBoxPixmap.
+
+.SH "SEE ALSO"
+.BR http://doc.trolltech.com/qlistboxitem.html
+.BR http://www.trolltech.com/faq/tech.html
+.SH COPYRIGHT
+Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the
+license file included in the distribution for a complete license
+statement.
+.SH AUTHOR
+Generated automatically from the source code.
+.SH BUGS
+If you find a bug in Qt, please report it as described in
+.BR http://doc.trolltech.com/bughowto.html .
+Good bug reports help us to help you. Thank you.
+.P
+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.
+.P
+If you find errors in this manual page, please report them to
+Please include the name of the manual page (qlistboxitem.3qt) and the Qt
+version (3.3.8).