.TH "KEditListBox" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KEditListBox \- An editable listbox.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <keditlistbox.h>\fP
.PP
Inherits \fBQGroupBox\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBButton\fP { \fBAdd\fP =  1, \fBRemove\fP =  2, \fBUpDown\fP =  4 }"
.br
.ti -1c
.RI "enum { \fBAll\fP =  Add|Remove|UpDown }"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBchanged\fP ()"
.br
.ti -1c
.RI "void \fBadded\fP (const \fBQString\fP &text)"
.br
.ti -1c
.RI "void \fBremoved\fP (const \fBQString\fP &text)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKEditListBox\fP (\fBQWidget\fP *parent=0, const char *name=0, bool checkAtEntering=false, int buttons=All)"
.br
.ti -1c
.RI "\fBKEditListBox\fP (const \fBQString\fP &\fBtitle\fP, \fBQWidget\fP *parent=0, const char *name=0, bool checkAtEntering=false, int buttons=All)"
.br
.ti -1c
.RI "\fBKEditListBox\fP (const \fBQString\fP &\fBtitle\fP, const \fBCustomEditor\fP &customEditor, \fBQWidget\fP *parent=0, const char *name=0, bool checkAtEntering=false, int buttons=All)"
.br
.ti -1c
.RI "\fBQListBox\fP * \fBlistBox\fP () const "
.br
.ti -1c
.RI "\fBKLineEdit\fP * \fBlineEdit\fP () const "
.br
.ti -1c
.RI "\fBQPushButton\fP * \fBaddButton\fP () const "
.br
.ti -1c
.RI "\fBQPushButton\fP * \fBremoveButton\fP () const "
.br
.ti -1c
.RI "\fBQPushButton\fP * \fBupButton\fP () const "
.br
.ti -1c
.RI "\fBQPushButton\fP * \fBdownButton\fP () const "
.br
.ti -1c
.RI "int \fBcount\fP () const "
.br
.ti -1c
.RI "void \fBinsertStringList\fP (const \fBQStringList\fP &list, int index=-1)"
.br
.ti -1c
.RI "void \fBinsertStrList\fP (const \fBQStrList\fP *list, int index=-1)"
.br
.ti -1c
.RI "void \fBinsertStrList\fP (const \fBQStrList\fP &list, int index=-1)"
.br
.ti -1c
.RI "void \fBinsertStrList\fP (const char **list, int numStrings=-1, int index=-1)"
.br
.ti -1c
.RI "void \fBinsertItem\fP (const \fBQString\fP &text, int index=-1)"
.br
.ti -1c
.RI "void \fBclear\fP ()"
.br
.ti -1c
.RI "\fBQString\fP \fBtext\fP (int index) const "
.br
.ti -1c
.RI "int \fBcurrentItem\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBcurrentText\fP () const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBitems\fP () const "
.br
.ti -1c
.RI "void \fBsetItems\fP (const \fBQStringList\fP &items)"
.br
.ti -1c
.RI "int \fBbuttons\fP () const "
.br
.ti -1c
.RI "void \fBsetButtons\fP (uint buttons)"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBmoveItemUp\fP ()"
.br
.ti -1c
.RI "void \fBmoveItemDown\fP ()"
.br
.ti -1c
.RI "void \fBaddItem\fP ()"
.br
.ti -1c
.RI "void \fBremoveItem\fP ()"
.br
.ti -1c
.RI "void \fBenableMoveButtons\fP (int index)"
.br
.ti -1c
.RI "void \fBtypedSomething\fP (const \fBQString\fP &text)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Properties"

.in +1c
.ti -1c
.RI "\fBButton\fP \fBbuttons\fP"
.br
.ti -1c
.RI "\fBQStringList\fP \fBitems\fP"
.br
.in -1c
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBCustomEditor\fP"
.br
.RI "\fICustom editor class. \fP"
.in -1c
.SH "Detailed Description"
.PP 
An editable listbox. 

This class provides a editable listbox ;-), this means a listbox which is accompanied by a line edit to enter new items into the listbox and pushbuttons to add and remove items from the listbox and two buttons to move items up and down.
.PP
KDE Edit List Box Widget
.PP
Definition at line 44 of file keditlistbox.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBKEditListBox::Button\fP"
.PP
Enumeration of the buttons, the listbox offers. 
.PP
Specify them in the constructor in the buttons parameter, or in setButtons. 
.PP
Definition at line 94 of file keditlistbox.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KEditListBox::KEditListBox (\fBQWidget\fP * parent = \fC0\fP, const char * name = \fC0\fP, bool checkAtEntering = \fCfalse\fP, int buttons = \fCAll\fP)"
.PP
Create an editable listbox. 
.PP
If \fCcheckAtEntering\fP is true, after every character you type in the line edit KEditListBox will enable or disable the Add-button, depending whether the current content of the line edit is already in the listbox. Maybe this can become a performance hit with large lists on slow machines. If \fCcheckAtEntering\fP is false, it will be checked if you press the Add-button. It is not possible to enter items twice into the listbox. 
.PP
Definition at line 48 of file keditlistbox.cpp.
.SS "KEditListBox::KEditListBox (const \fBQString\fP & title, \fBQWidget\fP * parent = \fC0\fP, const char * name = \fC0\fP, bool checkAtEntering = \fCfalse\fP, int buttons = \fCAll\fP)"
.PP
Create an editable listbox. 
.PP
The same as the other constructor, additionally it takes \fCtitle\fP, which will be the title of the frame around the listbox. 
.PP
Definition at line 55 of file keditlistbox.cpp.
.SS "KEditListBox::KEditListBox (const \fBQString\fP & title, const \fBCustomEditor\fP & customEditor, \fBQWidget\fP * parent = \fC0\fP, const char * name = \fC0\fP, bool checkAtEntering = \fCfalse\fP, int buttons = \fCAll\fP)"
.PP
Another constructor, which allows to use a custom editing widget instead of the standard \fBKLineEdit\fP widget. 
.PP
E.g. you can use a \fBKURLRequester\fP or a \fBKComboBox\fP as input widget. The custom editor must consist of a lineedit and optionally another widget that is used as representation. A \fBKComboBox\fP or a \fBKURLRequester\fP have a \fBKLineEdit\fP as child-widget for example, so the \fBKComboBox\fP is used as the representation widget.
.PP
\fBSee also:\fP
.RS 4
\fBKURLRequester::customEditor()\fP 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 62 of file keditlistbox.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBQListBox\fP* KEditListBox::listBox () const\fC [inline]\fP"
.PP
Return a pointer to the embedded \fBQListBox\fP. 
.PP
Definition at line 143 of file keditlistbox.h.
.SS "\fBKLineEdit\fP* KEditListBox::lineEdit () const\fC [inline]\fP"
.PP
Return a pointer to the embedded \fBQLineEdit\fP. 
.PP
Definition at line 147 of file keditlistbox.h.
.SS "\fBQPushButton\fP* KEditListBox::addButton () const\fC [inline]\fP"
.PP
Return a pointer to the Add button. 
.PP
Definition at line 151 of file keditlistbox.h.
.SS "\fBQPushButton\fP* KEditListBox::removeButton () const\fC [inline]\fP"
.PP
Return a pointer to the Remove button. 
.PP
Definition at line 155 of file keditlistbox.h.
.SS "\fBQPushButton\fP* KEditListBox::upButton () const\fC [inline]\fP"
.PP
Return a pointer to the Up button. 
.PP
Definition at line 159 of file keditlistbox.h.
.SS "\fBQPushButton\fP* KEditListBox::downButton () const\fC [inline]\fP"
.PP
Return a pointer to the Down button. 
.PP
Definition at line 163 of file keditlistbox.h.
.SS "int KEditListBox::count () const\fC [inline]\fP"
.PP
See \fBQListBox::count()\fP. 
.PP
Definition at line 168 of file keditlistbox.h.
.SS "void KEditListBox::insertStringList (const \fBQStringList\fP & list, int index = \fC-1\fP)"
.PP
See \fBQListBox::insertStringList()\fP. 
.PP
Definition at line 363 of file keditlistbox.cpp.
.PP
References QListBox::insertStringList().
.SS "void KEditListBox::insertStrList (const \fBQStrList\fP * list, int index = \fC-1\fP)"
.PP
See \fBQListBox::insertStringList()\fP. 
.PP
Definition at line 368 of file keditlistbox.cpp.
.PP
References QListBox::insertStrList().
.SS "void KEditListBox::insertStrList (const \fBQStrList\fP & list, int index = \fC-1\fP)"
.PP
See \fBQListBox::insertStrList()\fP. 
.PP
Definition at line 373 of file keditlistbox.cpp.
.PP
References QListBox::insertStrList().
.SS "void KEditListBox::insertStrList (const char ** list, int numStrings = \fC-1\fP, int index = \fC-1\fP)"
.PP
See \fBQListBox::insertStrList()\fP. 
.PP
Definition at line 378 of file keditlistbox.cpp.
.PP
References QListBox::insertStrList().
.SS "void KEditListBox::insertItem (const \fBQString\fP & text, int index = \fC-1\fP)\fC [inline]\fP"
.PP
See \fBQListBox::insertItem()\fP. 
.PP
Definition at line 188 of file keditlistbox.h.
.SS "void KEditListBox::clear ()"
.PP
Clears both the listbox and the line edit. 
.PP
Definition at line 356 of file keditlistbox.cpp.
.PP
References QListBox::clear(), and KLineEdit::clear().
.SS "\fBQString\fP KEditListBox::text (int index) const\fC [inline]\fP"
.PP
See \fBQListBox::text()\fP. 
.PP
Definition at line 196 of file keditlistbox.h.
.PP
References KAction::text.
.SS "int KEditListBox::currentItem () const"
.PP
See \fBQListBox::currentItem()\fP. 
.PP
Definition at line 293 of file keditlistbox.cpp.
.PP
References QListBox::currentItem(), QListBox::isSelected(), and QListBox::item().
.SS "\fBQString\fP KEditListBox::currentText () const\fC [inline]\fP"
.PP
See \fBQListBox::currentText()\fP. 
.PP
Definition at line 204 of file keditlistbox.h.
.SS "\fBQStringList\fP KEditListBox::items () const"
.PP
\fBReturns:\fP
.RS 4
a stringlist of all items in the listbox 
.RE
.PP

.SS "void KEditListBox::setItems (const \fBQStringList\fP & items)"
.PP
Clears the listbox and sets the contents to \fCitems\fP. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 392 of file keditlistbox.cpp.
.PP
References QListBox::clear(), and QListBox::insertStringList().
.SS "int KEditListBox::buttons () const"
.PP
Returns which buttons are visible. 
.PP
.SS "void KEditListBox::setButtons (uint buttons)"
.PP
Specifies which buttons should be visible. 
.PP
Definition at line 116 of file keditlistbox.cpp.
.PP
References QGridLayout::addWidget().
.SS "void KEditListBox::added (const \fBQString\fP & text)\fC [signal]\fP"
.PP
This signal is emitted when the user adds a new string to the list, the parameter is the added string. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.SS "void KEditListBox::removed (const \fBQString\fP & text)\fC [signal]\fP"
.PP
This signal is emitted when the user removes a string from the list, the parameter is the removed string. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
