<HTML>
<HEAD>
<TITLE>Source: kcompletionbox.h</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>Source: kcompletionbox.h</h1>
</TD>
<TD valign="top" align="right" colspan="1"></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<pre>
/* This file is part of the KDE libraries
Copyright (c) 2000 Carsten Pfeiffer <pfeiffer@kde.org>
2000 Stefan Schimanski <1Stein@gmx.de>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License (LGPL) as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef KCOMPLETIONBOX_H
#define KCOMPLETIONBOX_H
#include <qevent.h>
#include <qstringlist.h>
#include <klistbox.h>
/**
* A little utility class for "completion-widgets", like KLineEdit or
* KComboBox. KCompletionBox is a listbox, displayed as a rectangle without
* any window-decoration, usually directly under the lineedit or combobox.
* It is filled with all possible matches for a completion, so the user
* can select the one he wants.
*
* It is used when KGlobalSettings::Completion == CompletionPopup.
*
* @short A helper widget for "completion-widgets" (KLineEdit, KComboBox))
* @author Carsten Pfeiffer <pfeiffer@kde.org>
*/
class KCompletionBox : public KListBox
{
Q_OBJECT
Q_PROPERTY( bool isTabHandling READ isTabHandling WRITE setTabHandling )
Q_PROPERTY(QString cancelledText READ cancelledText WRITE setCancelledText)
public:
/**
* Constructs a KCompletionBox.
*
* Notice: the parent needs to be always 0L,
* so you can't specify it in the constructor. Because of that, Qt's
* auto-deletion does not take place, so you have to explicitly delete
* this widget when you don't need it anymore.
*
* The parent widget is used to give the focus back when pressing the
* up-button on the very first item.
*/
KCompletionBox( QWidget *parent, const char *name = 0 );
/**
* Destroys the box
*/
~KCompletionBox();
virtual QSize sizeHint() const;
public slots:
/**
* @returns a list of all items currently in the box.
*/
QStringList items() const;
/**
* Adjusts the size of the box to fit the width of the parent given in the
* constructor and pops it up at the most appropriate place, relative to
* the parent.
*
* Depending on the screensize and the position of the parent, this may
* be a different place, however the default is to pop it up and the
* lower left corner of the parent.
*
* Make sure to hide() the box when appropriate.
*/
virtual void popup();
/**
* Makes this widget (when visible) capture Tab-key events to traverse the
* items in the dropdown list.
*
* Default off, as it conflicts with the usual behavior of Tab to traverse
* widgets. It is useful for cases like Konqueror's Location Bar, though.
*
* @see #isTabHandling
*/
void setTabHandling( bool enable );
/**
* @returns true if this widget is handling Tab-key events to traverse the
* items in the dropdown list, otherwise false.
*
* Default is false.
*
* @see #setTabHandling
*/
bool isTabHandling() const;
/**
* Sets the text to be emitted if the user chooses not to
* pick from the available matches.
*
* If the cancelled text is not set through this function, the
* @ref userCancelled signal will not be emitted.
*
* @see userCancelled( const QString& )
* @param txt the text to be emitted if the user cancels this box
*/
void setCancelledText( const QString& );
/**
* @returns the text set via @ref setCancelledText() or QString::null.
*/
QString cancelledText() const;
/**
* Move the selection one line down or select the first item if nothing is selected yet.
*/
void down();
/**
* Move the selection one line up or select the first item if nothing is selected yet.
*/
void up();
/**
* Move the selection one page down.
*/
void pageDown();
/**
* Move the selection one page up.
*/
void pageUp();
/**
* Move the selection up to the first item.
*/
void home();
/**
* Move the selection down to the last item.
*/
void end();
/**
* Re-implemented for internal reasons. API is unaffected.
*/
virtual void show();
/**
* Re-implemented for internal reasons. API is unaffected.
*/
virtual void hide();
signals:
/**
* Emitted when an item was selected, contains the text of
* the selected item.
*/
void activated( const QString& );
/**
* Emitted whenever the user chooses to ignore the available
* selections and close the this box.
*/
void userCancelled( const QString& );
protected:
/**
* Reimplemented from KListBox to get events from the viewport (to hide
* this widget on mouse-click, Escape-presses, etc.
*/
virtual bool eventFilter( QObject *, QEvent * );
protected slots:
/**
* Called when an item was activated. Emits
* @ref activated() with the item.
*/
virtual void slotActivated( QListBoxItem * );
private slots:
void slotSetCurrentItem( QListBoxItem *i ) { setCurrentItem( i ); } // grrr
void cancelled();
private:
class KCompletionBoxPrivate;
KCompletionBoxPrivate* d;
};
#endif // KCOMPLETIONBOX_H
</pre>
<HR>
<table>
<tr><td><small>Generated by: qateam on updates.mandrakesoft.com on Mon Dec 30 16:09:05 2002, using kdoc 2.0a53.</small></td></tr>
</table>
</BODY>
</HTML>
