kcompletionbox.cpp
/* This file is part of the KDE libraries
Copyright (c) 2000,2001,2002 Carsten Pfeiffer <pfeiffer@kde.org>
Copyright (c) 2000 Stefan Schimanski <1Stein@gmx.de>
Copyright (c) 2000,2001,2002,2003,2004 Dawit Alemayehu <adawit@kde.org>
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., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#include <qapplication.h>
#include <qcombobox.h>
#include <qevent.h>
#include <qstyle.h>
#include <kdebug.h>
#include <kconfig.h>
#include <knotifyclient.h>
#include <kglobalsettings.h>
#include "kcompletionbox.h"
class KCompletionBox::KCompletionBoxPrivate
{
public:
QWidget *m_parent; // necessary to set the focus back
QString cancelText;
bool tabHandling;
bool down_workaround;
bool upwardBox;
bool emitSelected;
};
KCompletionBox::KCompletionBox( QWidget *parent, const char *name )
:KListBox( parent, name, WType_Popup ), d(new KCompletionBoxPrivate)
{
d->m_parent = parent;
d->tabHandling = true;
d->down_workaround = false;
d->upwardBox = false;
d->emitSelected = true;
setColumnMode( 1 );
setLineWidth( 1 );
setFrameStyle( QFrame::Box | QFrame::Plain );
if ( parent )
setFocusProxy( parent );
else
setFocusPolicy( NoFocus );
setVScrollBarMode( Auto );
setHScrollBarMode( AlwaysOff );
connect( this, SIGNAL( doubleClicked( QListBoxItem * )),
SLOT( slotActivated( QListBoxItem * )) );
// grmbl, just QListBox workarounds :[ Thanks Volker.
connect( this, SIGNAL( currentChanged( QListBoxItem * )),
SLOT( slotCurrentChanged() ));
connect( this, SIGNAL( clicked( QListBoxItem * )),
SLOT( slotItemClicked( QListBoxItem * )) );
}
KCompletionBox::~KCompletionBox()
{
d->m_parent = 0L;
delete d;
}
QStringList KCompletionBox::items() const
{
QStringList list;
const QListBoxItem* currItem = firstItem();
while (currItem) {
list.append(currItem->text());
currItem = currItem->next();
}
return list;
}
void KCompletionBox::slotActivated( QListBoxItem *item )
{
if ( !item )
return;
hide();
emit activated( item->text() );
}
bool KCompletionBox::eventFilter( QObject *o, QEvent *e )
{
int type = e->type();
if ( o == d->m_parent ) {
if ( isVisible() ) {
if ( type == QEvent::KeyPress ) {
QKeyEvent *ev = static_cast<QKeyEvent *>( e );
switch ( ev->key() ) {
case Key_BackTab:
if ( d->tabHandling && (ev->state() == NoButton ||
(ev->state() & ShiftButton)) ) {
up();
ev->accept();
return true;
}
break;
case Key_Tab:
if ( d->tabHandling && (ev->state() == NoButton) ) {
down(); // Only on TAB!!
ev->accept();
return true;
}
break;
case Key_Down:
down();
ev->accept();
return true;
case Key_Up:
// If there is no selected item and we've popped up above
// our parent, select the first item when they press up.
if ( selectedItem() ||
mapToGlobal( QPoint( 0, 0 ) ).y() >
d->m_parent->mapToGlobal( QPoint( 0, 0 ) ).y() )
up();
else
down();
ev->accept();
return true;
case Key_Prior:
pageUp();
ev->accept();
return true;
case Key_Next:
pageDown();
ev->accept();
return true;
case Key_Escape:
canceled();
ev->accept();
return true;
case Key_Enter:
case Key_Return:
if ( ev->state() & ShiftButton ) {
hide();
ev->accept(); // Consume the Enter event
return true;
}
break;
case Key_End:
if ( ev->state() & ControlButton )
{
end();
ev->accept();
return true;
}
case Key_Home:
if ( ev->state() & ControlButton )
{
home();
ev->accept();
return true;
}
default:
break;
}
}
else if ( type == QEvent::AccelOverride ) {
// Override any acceleartors that match
// the key sequences we use here...
QKeyEvent *ev = static_cast<QKeyEvent *>( e );
switch ( ev->key() ) {
case Key_Down:
case Key_Up:
case Key_Prior:
case Key_Next:
case Key_Escape:
case Key_Enter:
case Key_Return:
ev->accept();
return true;
break;
case Key_Tab:
case Key_BackTab:
if ( ev->state() == NoButton ||
(ev->state() & ShiftButton))
{
ev->accept();
return true;
}
break;
case Key_Home:
case Key_End:
if ( ev->state() & ControlButton )
{
ev->accept();
return true;
}
break;
default:
break;
}
}
// parent loses focus or gets a click -> we hide
else if ( type == QEvent::FocusOut || type == QEvent::Resize ||
type == QEvent::Close || type == QEvent::Hide ||
type == QEvent::Move ) {
hide();
}
}
}
// any mouse-click on something else than "this" makes us hide
else if ( type == QEvent::MouseButtonPress ) {
QMouseEvent *ev = static_cast<QMouseEvent *>( e );
if ( !rect().contains( ev->pos() )) // this widget
hide();
if ( !d->emitSelected && currentItem() && !::qt_cast<QScrollBar*>(o) )
{
emit highlighted( currentText() );
hide();
ev->accept(); // Consume the mouse click event...
return true;
}
}
return KListBox::eventFilter( o, e );
}
void KCompletionBox::popup()
{
if ( count() == 0 )
hide();
else {
ensureCurrentVisible();
bool block = signalsBlocked();
blockSignals( true );
setCurrentItem( 0 );
blockSignals( block );
clearSelection();
if ( !isVisible() )
show();
else if ( size().height() != sizeHint().height() )
sizeAndPosition();
}
}
void KCompletionBox::sizeAndPosition()
{
int currentGeom = height();
QPoint currentPos = pos();
QRect geom = calculateGeometry();
resize( geom.size() );
int x = currentPos.x(), y = currentPos.y();
if ( d->m_parent ) {
if ( !isVisible() ) {
QRect screenSize = KGlobalSettings::desktopGeometry(d->m_parent);
QPoint orig = d->m_parent->mapToGlobal( QPoint(0, d->m_parent->height()) );
x = orig.x() + geom.x();
y = orig.y() + geom.y();
if ( x + width() > screenSize.right() )
x = screenSize.right() - width();
if (y + height() > screenSize.bottom() ) {
y = y - height() - d->m_parent->height();
d->upwardBox = true;
}
}
else {
// Are we above our parent? If so we must keep bottom edge anchored.
if (d->upwardBox)
y += (currentGeom-height());
}
move( x, y);
}
}
void KCompletionBox::show()
{
d->upwardBox = false;
if ( d->m_parent ) {
sizeAndPosition();
qApp->installEventFilter( this );
}
// ### we shouldn't need to call this, but without this, the scrollbars
// are pretty b0rked.
//triggerUpdate( true );
// Workaround for I'm not sure whose bug - if this KCompletionBox' parent
// is in a layout, that layout will detect inserting new child (posted
// ChildInserted event), and will trigger relayout (post LayoutHint event).
// QWidget::show() sends also posted ChildInserted events for the parent,
// and later all LayoutHint events, which causes layout updating.
// The problem is, KCompletionBox::eventFilter() detects resizing
// of the parent, and calls hide() - and this hide() happen in the middle
// of show(), causing inconsistent state. I'll try to submit a Qt patch too.
qApp->sendPostedEvents();
KListBox::show();
}
void KCompletionBox::hide()
{
if ( d->m_parent )
qApp->removeEventFilter( this );
d->cancelText = QString::null;
KListBox::hide();
}
QRect KCompletionBox::calculateGeometry() const
{
int x = 0, y = 0;
int ih = itemHeight();
int h = QMIN( 15 * ih, (int) count() * ih ) + 2*frameWidth();
int w = (d->m_parent) ? d->m_parent->width() : KListBox::minimumSizeHint().width();
w = QMAX( KListBox::minimumSizeHint().width(), w );
//If we're inside a combox, Qt by default makes the dropdown
// as wide as the combo, and gives the style a chance
// to adjust it. Do that here as well, for consistency
const QObject* combo;
if ( d->m_parent && (combo = d->m_parent->parent() ) &&
combo->inherits("QComboBox") )
{
const QComboBox* cb = static_cast<const QComboBox*>(combo);
//Expand to the combo width
w = QMAX( w, cb->width() );
QPoint parentCorner = d->m_parent->mapToGlobal(QPoint(0, 0));
QPoint comboCorner = cb->mapToGlobal(QPoint(0, 0));
//We need to adjust our horizontal position to also be WRT to the combo
x += comboCorner.x() - parentCorner.x();
//The same with vertical one
y += cb->height() - d->m_parent->height() +
comboCorner.y() - parentCorner.y();
//Ask the style to refine this a bit
QRect styleAdj = style().querySubControlMetrics(QStyle::CC_ComboBox,
cb, QStyle::SC_ComboBoxListBoxPopup,
QStyleOption(x, y, w, h));
//QCommonStyle returns QRect() by default, so this is what we get if the
//style doesn't implement this
if (!styleAdj.isNull())
return styleAdj;
}
return QRect(x, y, w, h);
}
QSize KCompletionBox::sizeHint() const
{
return calculateGeometry().size();
}
void KCompletionBox::down()
{
int i = currentItem();
if ( i == 0 && d->down_workaround ) {
d->down_workaround = false;
setCurrentItem( 0 );
setSelected( 0, true );
emit highlighted( currentText() );
}
else if ( i < (int) count() - 1 )
setCurrentItem( i + 1 );
}
void KCompletionBox::up()
{
if ( currentItem() > 0 )
setCurrentItem( currentItem() - 1 );
}
void KCompletionBox::pageDown()
{
int i = currentItem() + numItemsVisible();
i = i > (int)count() - 1 ? (int)count() - 1 : i;
setCurrentItem( i );
}
void KCompletionBox::pageUp()
{
int i = currentItem() - numItemsVisible();
i = i < 0 ? 0 : i;
setCurrentItem( i );
}
void KCompletionBox::home()
{
setCurrentItem( 0 );
}
void KCompletionBox::end()
{
setCurrentItem( count() -1 );
}
void KCompletionBox::setTabHandling( bool enable )
{
d->tabHandling = enable;
}
bool KCompletionBox::isTabHandling() const
{
return d->tabHandling;
}
void KCompletionBox::setCancelledText( const QString& text )
{
d->cancelText = text;
}
QString KCompletionBox::cancelledText() const
{
return d->cancelText;
}
void KCompletionBox::canceled()
{
if ( !d->cancelText.isNull() )
emit userCancelled( d->cancelText );
if ( isVisible() )
hide();
}
class KCompletionBoxItem : public QListBoxItem
{
public:
//Returns true if dirty.
bool reuse( const QString& newText )
{
if ( text() == newText )
return false;
setText( newText );
return true;
}
};
void KCompletionBox::insertItems( const QStringList& items, int index )
{
bool block = signalsBlocked();
blockSignals( true );
insertStringList( items, index );
blockSignals( block );
d->down_workaround = true;
}
void KCompletionBox::setItems( const QStringList& items )
{
bool block = signalsBlocked();
blockSignals( true );
QListBoxItem* item = firstItem();
if ( !item ) {
insertStringList( items );
}
else {
//Keep track of whether we need to change anything,
//so we can avoid a repaint for identical updates,
//to reduce flicker
bool dirty = false;
QStringList::ConstIterator it = items.constBegin();
const QStringList::ConstIterator itEnd = items.constEnd();
for ( ; it != itEnd; ++it) {
if ( item ) {
const bool changed = ((KCompletionBoxItem*)item)->reuse( *it );
dirty = dirty || changed;
item = item->next();
}
else {
dirty = true;
//Inserting an item is a way of making this dirty
insertItem( new QListBoxText( *it ) );
}
}
//If there is an unused item, mark as dirty -> less items now
if ( item ) {
dirty = true;
}
QListBoxItem* tmp = item;
while ( (item = tmp ) ) {
tmp = item->next();
delete item;
}
if (dirty)
triggerUpdate( false );
}
if ( isVisible() && size().height() != sizeHint().height() )
sizeAndPosition();
blockSignals( block );
d->down_workaround = true;
}
void KCompletionBox::slotCurrentChanged()
{
d->down_workaround = false;
}
void KCompletionBox::slotItemClicked( QListBoxItem *item )
{
if ( item )
{
if ( d->down_workaround ) {
d->down_workaround = false;
emit highlighted( item->text() );
}
hide();
emit activated( item->text() );
}
}
void KCompletionBox::setActivateOnSelect(bool state)
{
d->emitSelected = state;
}
bool KCompletionBox::activateOnSelect() const
{
return d->emitSelected;
}
void KCompletionBox::virtual_hook( int id, void* data )
{ KListBox::virtual_hook( id, data ); }
#include "kcompletionbox.moc"
KCompletionBox::down
void down()
Moves the selection one line down or select the first item if nothing is selected yet...
Definition: kcompletionbox.cpp:381
KCompletionBox::KCompletionBox
KCompletionBox(QWidget *parent, const char *name=0)
Constructs a KCompletionBox.
Definition: kcompletionbox.cpp:47
KCompletionBox::~KCompletionBox
~KCompletionBox()
Destroys the box.
Definition: kcompletionbox.cpp:79
KCompletionBox::calculateGeometry
QRect calculateGeometry() const
This calculates the size of the dropdown and the relative position of the top left corner with respec...
Definition: kcompletionbox.cpp:332
KCompletionBox::activateOnSelect
bool activateOnSelect() const
KCompletionBox::up
void up()
Moves the selection one line up or select the first item if nothing is selected yet.
Definition: kcompletionbox.cpp:396
KCompletionBox::setCancelledText
void setCancelledText(const QString &txt)
Sets the text to be emitted if the user chooses not to pick from the available matches.
Definition: kcompletionbox.cpp:436
KCompletionBox::cancelledText
QString cancelledText() const
KCompletionBox::pageUp
void pageUp()
Moves the selection one page up.
Definition: kcompletionbox.cpp:409
KCompletionBox::items
QStringList items() const
Returns a list of all items currently in the box.
Definition: kcompletionbox.cpp:85
KGlobalSettings::desktopGeometry
static QRect desktopGeometry(const QPoint &point)
KCompletionBox::setActivateOnSelect
void setActivateOnSelect(bool state)
Set whether or not the selected signal should be emitted when an item is selected.
Definition: kcompletionbox.cpp:549
KCompletionBox::popup
virtual void popup()
Adjusts the size of the box to fit the width of the parent given in the constructor and pops it up at...
Definition: kcompletionbox.cpp:250
KCompletionBox::hide
virtual void hide()
Re-implemented for internal reasons.
Definition: kcompletionbox.cpp:324
KCompletionBox::insertItems
void insertItems(const QStringList &items, int index=-1)
Inserts items into the box.
Definition: kcompletionbox.cpp:468
KCompletionBox::show
virtual void show()
Re-implemented for internal reasons.
Definition: kcompletionbox.cpp:300
KCompletionBox::slotActivated
virtual void slotActivated(QListBoxItem *)
Called when an item was activated.
Definition: kcompletionbox.cpp:99
KCompletionBox::end
void end()
Moves the selection down to the last item.
Definition: kcompletionbox.cpp:421
KCompletionBox::pageDown
void pageDown()
Moves the selection one page down.
Definition: kcompletionbox.cpp:402
KCompletionBox::setTabHandling
void setTabHandling(bool enable)
Makes this widget (when visible) capture Tab-key events to traverse the items in the dropdown list...
Definition: kcompletionbox.cpp:426
KCompletionBox::home
void home()
Moves the selection up to the first item.
Definition: kcompletionbox.cpp:416
KCompletionBox::eventFilter
virtual bool eventFilter(QObject *, QEvent *)
Reimplemented from KListBox to get events from the viewport (to hide this widget on mouse-click...
Definition: kcompletionbox.cpp:108
KCompletionBox::activated
void activated(const QString &)
Emitted when an item was selected, contains the text of the selected item.
KCompletionBox::isTabHandling
bool isTabHandling() const
KCompletionBox::sizeAndPosition
void sizeAndPosition()
This properly sizes and positions the listbox.
Definition: kcompletionbox.cpp:268
KCompletionBox::userCancelled
void userCancelled(const QString &)
Emitted whenever the user chooses to ignore the available selections and close the this box...
KListBox
A variant of QListBox that honors KDE's system-wide settings.
Definition: klistbox.h:40
KCompletionBox::setItems
void setItems(const QStringList &items)
Clears the box and inserts items.
Definition: kcompletionbox.cpp:477
KListBox::doubleClicked
void doubleClicked(QListBoxItem *item, const QPoint &pos)
This signal gets emitted whenever the user double clicks into the listbox.

KDE Home | KDE Accessibility Home | Description of Access Keys