document.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright 2006-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_SUBLIMEDOCUMENT_H
#define KDEVPLATFORM_SUBLIMEDOCUMENT_H
 
#include <QObject>
#include <QList>
 
 
#include "sublimeexport.h"
 
class QIcon;
 
class QWidget;
 
namespace Sublime {
 
class Area;
class View;
class Controller;
class DocumentPrivate;
 
class KDEVPLATFORMSUBLIME_EXPORT Document: public QObject {
    Q_OBJECT
public:
    Document(const QString &title, Controller *controller);
    ~Document() override;
 
    View *createView();
    const QList<View*> &views() const;
 
    Controller *controller() const;
 
    enum TitleType { Normal, Extended};
    virtual QString title(TitleType type = Normal) const;
    void setTitle(const QString& newTitle);
    void setToolTip(const QString& newToolTip);
    QString toolTip() const;
    virtual QString documentType() const = 0;
 
    virtual QString documentSpecifier() const = 0;
 
    virtual bool askForCloseFeedback();
    
    virtual bool closeDocument(bool silent = false);
 
    void setStatusIcon(const QIcon& icon);
 
    QIcon statusIcon() const;
 
    QIcon icon() const;
 
    virtual QIcon defaultIcon() const;
 
Q_SIGNALS:
    void aboutToDelete(Sublime::Document *doc);
    void titleChanged(Sublime::Document *doc);
    void statusIconChanged(Sublime::Document *doc);
 
protected:
    virtual View *newView(Document *doc);
    virtual QWidget *createViewWidget(QWidget *parent = nullptr) = 0;
    virtual void closeViews();
 
private:
    const QScopedPointer<class DocumentPrivate> d_ptr;
    Q_DECLARE_PRIVATE(Document)
 
    friend class DocumentPrivate;
    friend class View;
};
 
}
 
#endif