iprojectcontroller.h

Go to the documentation of this file.

/* This file is part of KDevelop
Copyright 2006 Adam Treat <[email protected]>
Copyright 2007 Andreas Pakulat <[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 KDEVPLATFORM_IPROJECTCONTROLLER_H
#define KDEVPLATFORM_IPROJECTCONTROLLER_H

#include <QObject>
#include <QList>
#include <QUrl>

#include "interfacesexport.h"

namespace KDevelop
{

class IProject;
class ProjectBuildSetModel;
class ProjectModel;
class ProjectBaseItem;
class ProjectChangesModel;

class KDEVPLATFORMINTERFACES_EXPORT IProjectController : public QObject
{
    Q_OBJECT
public:
    explicit IProjectController( QObject *parent = nullptr );
    ~IProjectController() override;

    Q_INVOKABLE virtual KDevelop::IProject* projectAt( int ) const = 0;
    Q_INVOKABLE virtual int projectCount() const = 0;
    Q_INVOKABLE virtual QList<IProject*> projects() const = 0;

    virtual ProjectModel* projectModel() = 0;
    
    
    virtual ProjectChangesModel* changesModel() = 0;

    virtual ProjectBuildSetModel* buildSetModel() = 0;

    virtual KDevelop::IProject* findProjectByName( const QString& name ) = 0;

    virtual IProject* findProjectForUrl( const QUrl& url ) const = 0;

    virtual bool isProjectNameUsed( const QString& name ) const = 0;

    virtual QUrl projectsBaseDirectory() const = 0;

    enum FormattingOptions {
        FormatHtml,
        FormatPlain
    };

    virtual QString prettyFilePath(const QUrl& url, FormattingOptions format = FormatHtml) const = 0;
    
    virtual QString prettyFileName(const QUrl& url, FormattingOptions format = FormatHtml) const = 0;

    static bool parseAllProjectSources();

public Q_SLOTS:
        virtual void openProjectForUrl( const QUrl &sourceUrl ) = 0;
    virtual void openProject( const QUrl & url = QUrl() ) = 0;
    virtual void closeProject( IProject* ) = 0;

    virtual void closeAllProjects() = 0;

    virtual void configureProject( IProject* ) = 0;

    virtual void reparseProject( IProject* project, bool forceUpdate = false, bool forceAll = false ) = 0;

//     virtual void changeCurrentProject( KDevelop::ProjectBaseItem* ) = 0;

Q_SIGNALS:
    void projectAboutToBeOpened( KDevelop::IProject* project );
    void projectOpened( KDevelop::IProject* project );
    void projectClosing( KDevelop::IProject* project );
    void projectClosed( KDevelop::IProject* project );
    void projectOpeningAborted( KDevelop::IProject* project );

    void projectConfigurationChanged( KDevelop::IProject* project );
};

}
#endif