kcombobox.h

Go to the documentation of this file.

/* This file is part of the KDE libraries

   Copyright (c) 2000,2001 Dawit Alemayehu <adawit@kde.org>
   Copyright (c) 2000,2001 Carsten Pfeiffer <pfeiffer@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser 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.
*/

#ifndef KCOMBOBOX_H
#define KCOMBOBOX_H

#include <QtGui/QComboBox>

#include <kcompletion.h>

class QLineEdit;
class QMenu;

class KCompletionBox;
class KUrl;

/*
 * ### KDE 5: On all methods that it is said that a prettyUrl will be used, it
 *            would be nice to add a flag to the method for forcing the pretty
 *            url or not. (ereslibre)
 */

class KDEUI_EXPORT KComboBox : public QComboBox, public KCompletionBase //krazy:exclude=qclasses
{
  Q_OBJECT
  Q_PROPERTY( bool autoCompletion READ autoCompletion WRITE setAutoCompletion )
  Q_PROPERTY( bool urlDropsEnabled READ urlDropsEnabled WRITE setUrlDropsEnabled )
  Q_PROPERTY( bool trapReturnKey READ trapReturnKey WRITE setTrapReturnKey )

public:

    explicit KComboBox( QWidget *parent=0 );

    explicit KComboBox( bool rw, QWidget *parent=0 );

    virtual ~KComboBox();

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void insertURL( const KUrl& url, int index = -1 )
    { insertUrl( index < 0 ? count() : index, url ); }
    KDE_DEPRECATED void insertURL( const QPixmap& pixmap, const KUrl& url, int index = -1 )
    { insertUrl( index < 0 ? count() : index, QIcon(pixmap), url ); }
    KDE_DEPRECATED void changeURL( const KUrl& url, int index )
    { changeUrl( index, url ); }
    KDE_DEPRECATED void changeURL( const QPixmap& pixmap, const KUrl& url, int index )
    { changeUrl( index, QIcon(pixmap), url ); }
#endif

    void setEditUrl( const KUrl& url );

    void addUrl( const KUrl& url );

    void addUrl( const QIcon& icon,  const KUrl& url );

    void insertUrl( int index, const KUrl& url );

    void insertUrl( int index, const QIcon& icon, const KUrl& url );

    void changeUrl( int index, const KUrl& url );

    void changeUrl( int index , const QIcon& icon, const KUrl& url);

    int cursorPosition() const;

    virtual void setAutoCompletion( bool autocomplete );

    bool autoCompletion() const;

#ifndef KDE_NO_DEPRECATED
    virtual KDE_DEPRECATED void setContextMenuEnabled( bool showMenu );
#endif

    void setUrlDropsEnabled( bool enable );

    bool urlDropsEnabled() const;

    bool contains( const QString& text ) const;

    void setTrapReturnKey( bool trap );

    bool trapReturnKey() const;

    virtual bool eventFilter( QObject *, QEvent * );

    KCompletionBox * completionBox( bool create = true );

    virtual void setLineEdit( QLineEdit * );

    void setEditable(bool editable);

Q_SIGNALS:
    void returnPressed();

    void returnPressed( const QString& );

    void completion( const QString& );

    void substringCompletion( const QString& );

    void textRotation( KCompletionBase::KeyBindingType );

    void completionModeChanged( KGlobalSettings::Completion );

    void aboutToShowContextMenu( QMenu * p );

public Q_SLOTS:

    void rotateText( KCompletionBase::KeyBindingType type );

    virtual void setCompletedText( const QString& );

    void setCompletedItems( const QStringList& items, bool autosubject = true );

    void setCurrentItem( const QString& item, bool insert = false, int index = -1 );

protected Q_SLOTS:

    virtual void makeCompletion( const QString& );

protected:
    /*
    * This function simply sets the lineedit text and
    * highlights the text appropriately if the boolean
    * value is set to true.
    *
    * @param
    * @param
    */
    virtual void setCompletedText( const QString& /* */, bool /*marked*/ );

    virtual void create( WId = 0, bool initializeWindow = true,
                         bool destroyOldWindow = true );

    virtual void wheelEvent( QWheelEvent *ev );

    virtual QSize minimumSizeHint() const;

private Q_SLOTS:
    void lineEditDeleted();

private:
    void init();

private:
    class KComboBoxPrivate;
    KComboBoxPrivate* const d;
};



#endif