kdevcore.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2001-2002 Matthias Hoelzer-Kluepfel <hoelzer@kde.org>
   Copyright (C) 2001-2002 Bernd Gehrmann <bernd@kdevelop.org>
   Copyright (C) 2001 Sandy Meier <smeier@kdevelop.org>
   Copyright (C) 2002 Daniel Engelschalt <daniel.engelschalt@gmx.net>
   Copyright (C) 2002 Simon Hausmann <hausmann@kde.org>
   Copyright (C) 2002-2003 Roberto Raggi <roberto@kdevelop.org>
   Copyright (C) 2003 Mario Scalas <mario.scalas@libero.it>
   Copyright (C) 2003 Harald Fernengel <harry@kdevelop.org>
   Copyright (C) 2003 Hamish Rodda <rodda@kde.org>
   Copyright (C) 2004 Alexander Dymo <adymo@kdevelop.org>
 
   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 KDEVCORE_H
#define KDEVCORE_H

 
#include <tqstringlist.h>
#include <tqdict.h>
#include <tqobject.h>
 
#include <kurl.h>
 
class KDialogBase;
class KDevPlugin;
class CodeModelItem;
class ProjectModelItem;
 
namespace KParts
{
    class Part;
}
 
class TQStatusBar;
class TQPopupMenu;

class Context
{
public:
    enum Type
    { 
        EditorContext,            
        DocumentationContext,     
        FileContext,              
        ProjectModelItemContext,  
        CodeModelItemContext      
    };

    virtual int type() const = 0;

    virtual bool hasType(int type) const;
 
protected:
    Context();

    virtual ~Context();
};

class EditorContext: public Context
{
public:
    EditorContext(const KURL &url, int line, int col,
        const TQString &linestr, const TQString &wordstr);
    
    virtual ~EditorContext();
 
    virtual int type() const;

    const KURL &url() const;

    int line() const;

    int col() const;

    TQString currentLine() const;

    TQString currentWord() const;
 
private:
    class Private;
    Private *d;
 
    EditorContext( const EditorContext &);
    EditorContext &operator=( const EditorContext &);
};
 

class DocumentationContext: public Context
{
public:

    DocumentationContext(const TQString &url, const TQString &selection );

    DocumentationContext(const DocumentationContext &);
    DocumentationContext &operator=(const DocumentationContext &);

    virtual ~DocumentationContext();
 
    virtual int type() const;

    TQString url() const;

    TQString selection() const;
 
private:
    class Private;
    Private *d;
};

class FileContext : public Context
{
public:
    FileContext(const KURL::List &someURLs);
    
    virtual ~FileContext();
 
    virtual int type() const;

    const KURL::List &urls() const;
 
private:
    class Private;
    Private *d;
 
    FileContext( const FileContext &);
    FileContext &operator=( const FileContext &);
};

class CodeModelItemContext: public Context
{
public:
    CodeModelItemContext(const CodeModelItem* item);

    virtual ~CodeModelItemContext();
 
    virtual int type() const;

    const CodeModelItem* item() const;
 
private:
    class Private;
    Private *d;
 
    CodeModelItemContext( const CodeModelItemContext &);
    CodeModelItemContext &operator=( const CodeModelItemContext &);
};

class ProjectModelItemContext : public Context
{
public:
    ProjectModelItemContext(const ProjectModelItem* item);

    virtual ~ProjectModelItemContext();
 
    virtual int type() const;

    const ProjectModelItem* item() const;
 
private:
    class Private;
    Private *d;
 
    ProjectModelItemContext( const ProjectModelItemContext &);
    ProjectModelItemContext &operator=( const ProjectModelItemContext &);
};
 
 
 

class KDevCore: public TQObject
{
    TQ_OBJECT
  
public:
    KDevCore(TQObject *parent=0, const char *name=0);

    virtual ~KDevCore();

    virtual void fillContextMenu(TQPopupMenu *popup, const Context *context) = 0;

    virtual void openProject(const TQString& projectFileName) = 0;

    virtual void running(KDevPlugin *which, bool runs) = 0;
 
signals:
    void coreInitialized();

    void projectOpened();

    void projectClosed();

    void languageChanged();

    void stopButtonClicked(KDevPlugin *which);

    void contextMenu(TQPopupMenu *popupMenu, const Context *context);

    void configWidget(KDialogBase *dlg);

    void projectConfigWidget(KDialogBase *dlg);
};
 
#endif