kcompletionbase.h

/* This file is part of the KDE libraries
   Copyright (C) 1999,2000 Carsten Pfeiffer <[email protected]>

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

#ifndef KCOMPLETIONBASE_H
#define KCOMPLETIONBASE_H

#include <kcompletion.h>
#include <kcompletion_export.h>

#include <QMap>

class KCompletionBasePrivate;

class KCOMPLETION_EXPORT KCompletionBase
{
public:
    Q_DECLARE_PRIVATE(KCompletionBase)
    enum KeyBindingType {
        TextCompletion,
        PrevCompletionMatch,
        NextCompletionMatch,
        SubstringCompletion
    };

    // Map for the key binding types mentioned above.
    typedef QMap<KeyBindingType, QList<QKeySequence> > KeyBindingMap;

    KCompletionBase();

    virtual ~KCompletionBase();

    KCompletion *completionObject(bool handleSignals = true);

    virtual void setCompletionObject(KCompletion *completionObject, bool handleSignals = true);

    virtual void setHandleSignals(bool handle);

    bool isCompletionObjectAutoDeleted() const;

    void setAutoDeleteCompletionObject(bool autoDelete);

    void setEnableSignals(bool enable);

    bool handleSignals() const;

    bool emitSignals() const;

    void setEmitSignals(bool emitRotationSignals);

    virtual void setCompletionMode(KCompletion::CompletionMode mode);

    KCompletion::CompletionMode completionMode() const;

    bool setKeyBinding(KeyBindingType item, const QList<QKeySequence> &key);

    QList<QKeySequence> keyBinding(KeyBindingType item) const;

#if KCOMPLETION_ENABLE_DEPRECATED_SINCE(5, 0)

    KCOMPLETION_DEPRECATED_VERSION(5, 0, "Use KCompletionBase::keyBinding(KeyBindingType)")
    QList<QKeySequence> getKeyBinding(KeyBindingType item) const
    {
        return keyBinding(item);
    }
#endif

    void useGlobalKeyBindings();

    virtual void setCompletedText(const QString &text) = 0;

    virtual void setCompletedItems(const QStringList &items, bool autoSuggest = true) = 0;

    KCompletion *compObj() const;

protected:
    KeyBindingMap keyBindingMap() const;

#if KCOMPLETION_ENABLE_DEPRECATED_SINCE(5, 0)

    KCOMPLETION_DEPRECATED_VERSION(5, 0, "Use KCompletionBase::keyBindingMap()")
    KeyBindingMap getKeyBindings() const
    {
        return keyBindingMap();
    }
#endif

    void setKeyBindingMap(KeyBindingMap keyBindingMap);

    void setDelegate(KCompletionBase *delegate);

    KCompletionBase *delegate() const;

    virtual void virtual_hook(int id, void *data);

private:
    Q_DISABLE_COPY(KCompletionBase)
    const QScopedPointer<KCompletionBasePrivate> d_ptr;
};

#endif // KCOMPLETIONBASE_H