codecompletionmodelcontrollerinterface.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2008 Niko Sams <niko.sams@gmail.com>

   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 KDELIBS_KTEXTEDITOR_CODECOMPLETIONMODELCONTROLLERINTERFACE_H
#define KDELIBS_KTEXTEDITOR_CODECOMPLETIONMODELCONTROLLERINTERFACE_H

#include <ktexteditor/ktexteditor_export.h>
#include <ktexteditor/smartrange.h>
#include <ktexteditor/cursor.h>
#include "codecompletionmodel.h"

class QModelIndex;

namespace KTextEditor {
class View;
class KTEXTEDITOR_EXPORT_DEPRECATED CodeCompletionModelControllerInterface
{
public:
    CodeCompletionModelControllerInterface();
    virtual ~CodeCompletionModelControllerInterface();

    virtual bool shouldStartCompletion(View* view, const QString &insertedText, bool userInsertion, const Cursor &position);

    virtual Range completionRange(View* view, const Cursor &position);

    virtual void updateCompletionRange(View* view, SmartRange& range);

    virtual QString filterString(View* view, const SmartRange& range, const Cursor &position);

    virtual bool shouldAbortCompletion(View* view, const SmartRange& range, const QString &currentCompletion);
    
    virtual bool shouldExecute(const QModelIndex& selected, QChar inserted);
    
    virtual void aborted(View* view);
};

class KTEXTEDITOR_EXPORT_DEPRECATED CodeCompletionModelControllerInterface2 : public CodeCompletionModelControllerInterface {
  public:
    enum MatchReaction {
      None,
      HideListIfAutomaticInvocation 
    };
    virtual MatchReaction matchingItem(const QModelIndex& matched);
};



//BEGIN V3
class KTEXTEDITOR_EXPORT CodeCompletionModelControllerInterface3
{
public:
    CodeCompletionModelControllerInterface3();
    virtual ~CodeCompletionModelControllerInterface3();

    virtual bool shouldStartCompletion(View* view, const QString &insertedText, bool userInsertion, const Cursor &position);

    virtual Range completionRange(View* view, const Cursor &position);

    virtual Range updateCompletionRange(View* view, const Range& range);

    virtual QString filterString(View* view, const Range& range, const Cursor &position);

    virtual bool shouldAbortCompletion(View* view, const Range& range, const QString &currentCompletion);
    
    virtual bool shouldExecute(const QModelIndex& selected, QChar inserted);
    
    virtual void aborted(View* view);

  public:
    enum MatchReaction {
      None=0,
      HideListIfAutomaticInvocation=1, 
      ForExtension=0xffff
    };
    virtual MatchReaction matchingItem(const QModelIndex& matched);
};
//END V3

}
Q_DECLARE_INTERFACE(KTextEditor::CodeCompletionModelControllerInterface, "org.kde.KTextEditor.CodeCompletionModelControllerInterface")
Q_DECLARE_INTERFACE(KTextEditor::CodeCompletionModelControllerInterface2, "org.kde.KTextEditor.CodeCompletionModelControllerInterface2")
Q_DECLARE_INTERFACE(KTextEditor::CodeCompletionModelControllerInterface3, "org.kde.KTextEditor.CodeCompletionModelControllerInterface3")
#endif // KDELIBS_KTEXTEDITOR_CODECOMPLETIONMODELCONTROLLERINTERFACE_H