editor.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
 *  Copyright (C) 2005 Christoph Cullmann <cullmann@kde.org>
 *  Copyright (C) 2005 Dominik Haumann (dhdev@gmx.de) (documentation)
 *
 *  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 KDELIBS_KTEXTEDITOR_EDITOR_H
#define KDELIBS_KTEXTEDITOR_EDITOR_H

#include <ktexteditor/ktexteditor_export.h>
// our main baseclass of the KTextEditor::Editor
#include <QtCore/QObject>

#include <kicon.h>

class KAboutData;
class KConfig;

namespace KTextEditor
{

class Document;
class ConfigPage;

class KTEXTEDITOR_EXPORT Editor : public QObject
{
  Q_OBJECT

  public:
    Editor ( QObject *parent );

    virtual ~Editor ();

  public:
    void setSimpleMode (bool on);

    bool simpleMode () const;

  /*
   * Methods to create and manage the documents.
   */
  public:
    virtual Document *createDocument ( QObject *parent ) = 0;

    virtual const QList<Document*> &documents () = 0;

  /*
   * General Information about this editor.
   */
  public:
    virtual const KAboutData *aboutData () const = 0;

    const QString &defaultEncoding () const;

  protected:
    void setDefaultEncoding (const QString &defaultEncoding);

  /*
   * Configuration management.
   */
  public:
    virtual void readConfig (KConfig *config = 0) = 0;

    virtual void writeConfig (KConfig *config = 0) = 0;

    virtual bool configDialogSupported () const = 0;

    virtual void configDialog (QWidget *parent) = 0;

    virtual int configPages () const = 0;

    virtual ConfigPage *configPage (int number, QWidget *parent) = 0;

    virtual QString configPageName (int number) const = 0;

    virtual QString configPageFullName (int number) const = 0;

    virtual KIcon configPageIcon (int number) const = 0;

  Q_SIGNALS:
    void documentCreated (KTextEditor::Editor *editor,
                          KTextEditor::Document *document);

  private:
    class EditorPrivate* const d;
};


KTEXTEDITOR_EXPORT Editor *editor ( const char *libname );

}

#endif

// kate: space-indent on; indent-width 2; replace-tabs on;