codecompletioninterface.h

/* This file is part of the KDE libraries
   Copyright (C) 2001 Joseph Wenninger <jowenn@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 version 2 as published by the Free Software Foundation.
 
   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 __tdetexteditor_codecompletioninterface_h__
#define __tdetexteditor_codecompletioninterface_h__
 
#include <tqstring.h>
#include <tqstringlist.h>
 
#include <tdelibs_export.h>
 
namespace KTextEditor
{
 
class KTEXTEDITOR_EXPORT CompletionEntry
{
  public:
    TQString type;
    TQString text;
    TQString prefix;
    TQString postfix;
    TQString comment;
 
    TQString userdata;
 
    bool operator==( const CompletionEntry &c ) const {
      return ( c.type == type &&
           c.text == text &&
           c.postfix == postfix &&
           c.prefix == prefix &&
           c.comment == comment &&
               c.userdata == userdata);
    }
};
 
class KTEXTEDITOR_EXPORT CodeCompletionInterface
{
  friend class PrivateCodeCompletionInterface;
 
  public:
    CodeCompletionInterface();
    virtual ~CodeCompletionInterface();
 
    unsigned int codeCompletionInterfaceNumber () const;
 
  protected:
    void setCodeCompletionInterfaceDCOPSuffix (const TQCString &suffix);
 
 
  public:
    //
    // slots !!!
    //
    virtual void showArgHint (TQStringList functionList, const TQString& strWrapping, const TQString& strDelimiter) = 0;
 
    virtual void showCompletionBox (TQValueList<CompletionEntry> complList,int offset=0, bool casesensitive=true)=0;
 
    //
    // signals !!!
    //
    public:
 
 
    virtual void completionAborted()=0;
 
    virtual void completionDone()=0;
 
    virtual void completionDone(CompletionEntry)=0;
 
    virtual void argHintHidden()=0;
 
    virtual void filterInsertString(CompletionEntry*,TQString*)=0;
 
 
  private:
    class PrivateCodeCompletionInterface *d;
    static unsigned int globalCodeCompletionInterfaceNumber;
    unsigned int myCodeCompletionInterfaceNumber;
};
 
KTEXTEDITOR_EXPORT CodeCompletionInterface *codeCompletionInterface (class View *view);
 
}
 
#endif