idocumentcontroller.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright 2007 Alexander Dymo <[email protected]>                    *
 *                                                                         *
 *   This program 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 program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this program; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
 ***************************************************************************/
#ifndef KDEVPLATFORM_IDOCUMENTCONTROLLER_H
#define KDEVPLATFORM_IDOCUMENTCONTROLLER_H
 
#include <QObject>
#include <QList>
#include <QUrl>
 
#include <KTextEditor/Range>
 
#include "interfacesexport.h"
 
#include "idocument.h"
 
namespace KTextEditor {
    class View;
}
 
namespace KDevelop {
 
class ICore;
 
class KDEVPLATFORMINTERFACES_EXPORT IDocumentFactory {
public:
    virtual ~IDocumentFactory() {}
    virtual IDocument* create(const QUrl&, ICore* ) = 0;
};
 
class KDEVPLATFORMINTERFACES_EXPORT IDocumentController: public QObject {
    Q_OBJECT
public:
    enum DocumentActivation
    {
        DefaultMode = 0,            
        DoNotActivate = 1,          
        DoNotCreateView = 2,        
        DoNotFocus = 4,             
        DoNotAddToRecentOpen = 8,   
    };
    Q_DECLARE_FLAGS(DocumentActivationParams, DocumentActivation)
 
    explicit IDocumentController(QObject *parent);
 
    virtual KDevelop::IDocument* documentForUrl( const QUrl & url ) const = 0;
 
    virtual QList<KDevelop::IDocument*> openDocuments() const = 0;
 
    virtual KDevelop::IDocument* activeDocument() const = 0;
 
    virtual void activateDocument( KDevelop::IDocument * document, const KTextEditor::Range& range = KTextEditor::Range::invalid() ) = 0;
 
    virtual void registerDocumentForMimetype( const QString&, KDevelop::IDocumentFactory* ) = 0;
 
    virtual bool saveAllDocuments(KDevelop::IDocument::DocumentSaveMode mode = KDevelop::IDocument::Default) = 0;
    virtual bool saveSomeDocuments(const QList<IDocument*>& list, KDevelop::IDocument::DocumentSaveMode mode = KDevelop::IDocument::Default) = 0;
    virtual bool saveAllDocumentsForWindow(KParts::MainWindow* mw, IDocument::DocumentSaveMode mode, bool currentAreaOnly = false) = 0;
 
    virtual KDevelop::IDocument* openDocumentFromText( const QString& data ) = 0;
 
    virtual IDocumentFactory* factory(const QString& mime) const = 0;
 
    virtual KTextEditor::View* activeTextDocumentView() const = 0;
 
public Q_SLOTS:
    KDevelop::IDocument* openDocument( const QUrl &url,
            const KTextEditor::Cursor& cursor,
            DocumentActivationParams activationParams = {},
            const QString& encoding = {});
 
    virtual KDevelop::IDocument* openDocument( const QUrl &url,
            const KTextEditor::Range& range = KTextEditor::Range::invalid(),
            DocumentActivationParams activationParams = {},
            const QString& encoding = {},
            IDocument* buddy = nullptr) = 0;
 
    virtual bool openDocument(IDocument* doc,
            const KTextEditor::Range& range = KTextEditor::Range::invalid(),
            DocumentActivationParams activationParams = {},
            IDocument* buddy = nullptr) = 0;
 
    virtual KDevelop::IDocument* openDocument( const QUrl &url, const QString& prefName ) = 0;
 
    virtual bool closeAllDocuments() = 0;
 
Q_SIGNALS:
    void documentActivated( KDevelop::IDocument* document );
 
    void documentJumpPerformed( KDevelop::IDocument* newDocument, KTextEditor::Cursor newCursor,
                                KDevelop::IDocument* previousDocument, KTextEditor::Cursor previousCursor);
    
    void documentSaved( KDevelop::IDocument* document );
 
    void documentOpened( KDevelop::IDocument* document );
 
    void documentLoaded( KDevelop::IDocument* document );
 
    void textDocumentCreated( KDevelop::IDocument* document );
 
    void documentClosed( KDevelop::IDocument* document );
 
    void documentStateChanged( KDevelop::IDocument* document );
 
    void documentContentChanged( KDevelop::IDocument* document );
 
    void documentLoadedPrepare( KDevelop::IDocument* document );
 
    void documentUrlChanged( KDevelop::IDocument* document );
 
    friend class IDocument;
};
 
#if QT_VERSION >= QT_VERSION_CHECK(5, 12, 0)
Q_DECLARE_OPERATORS_FOR_FLAGS(IDocumentController::DocumentActivationParams)
#endif
 
} // namespace KDevelop
 
#if QT_VERSION < QT_VERSION_CHECK(5, 12, 0)
Q_DECLARE_OPERATORS_FOR_FLAGS(KDevelop::IDocumentController::DocumentActivationParams)
#endif
 
#endif