kateglobal.h

Go to the documentation of this file.

/*  This file is part of the KDE libraries and the Kate part.
 *
 *  Copyright (C) 2001-2010 Christoph Cullmann <cullmann@kde.org>
 *  Copyright (C) 2009 Erlend Hamberg <ehamberg@gmail.com>
 *
 *  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 __KATE_GLOBAL_H__
#define __KATE_GLOBAL_H__

#include "katepartprivate_export.h"
#include "katescript.h"

#include <ktexteditor/editor.h>

#include <kservice.h>
#include <kcomponentdata.h>
#include <kaboutdata.h>
#include <ktexteditor/commandinterface.h>
#include <ktexteditor/containerinterface.h>
#include <ktexteditor/templateinterface2.h>
#include <QtCore/QList>

class KateCmd;
class KateModeManager;
class KateSchemaManager;
class KateGlobalConfig;
class KateDocumentConfig;
class KateViewConfig;
class KateRendererConfig;
class KateDocument;
class KateRenderer;
class KateView;
class KateScriptManager;
class KDirWatch;
class KateHlManager;
class KatePartPluginManager;
class KateSpellCheckManager;
class KateViGlobal;
class KateWordCompletionModel;
class KateSnippetGlobal;

namespace Kate {
  class Command;
}

Q_DECLARE_METATYPE(KSharedConfig::Ptr)


class KATEPART_TESTS_EXPORT KateGlobal : public KTextEditor::Editor, public KTextEditor::CommandInterface, public KTextEditor::ContainerInterface, public KTextEditor::TemplateScriptRegistrar
{
  Q_OBJECT
  Q_INTERFACES(KTextEditor::CommandInterface)
  Q_INTERFACES(KTextEditor::ContainerInterface)
  Q_INTERFACES(KTextEditor::TemplateScriptRegistrar)

  public:
    Q_PROPERTY (QWidget *snippetWidget READ snippetWidget)

    
    QWidget *snippetWidget ();

    Q_PROPERTY (KSharedConfig::Ptr sessionConfig READ sessionConfig WRITE setSessionConfig)

    
    KSharedConfig::Ptr sessionConfig ()
    {
      return m_sessionConfig;
    }

    void setSessionConfig (KSharedConfig::Ptr sessionConfig)
    {
      m_sessionConfig = sessionConfig;
    }

  // for setDefaultEncoding
  friend class KateDocumentConfig;

  private:
    KateGlobal ();

  public:
    ~KateGlobal ();

    KTextEditor::Document *createDocument ( QObject *parent );

    const QList<KTextEditor::Document*> &documents ();

  public:
    const KAboutData* aboutData() const { return &m_aboutData; }

  public:
    void readConfig (KConfig *config = 0);

    void writeConfig (KConfig *config = 0);

    bool configDialogSupported () const;

    void configDialog (QWidget *parent);

    int configPages () const;

    KTextEditor::ConfigPage *configPage (int number, QWidget *parent);

    QString configPageName (int number) const;

    QString configPageFullName (int number) const;

    KIcon configPageIcon (int number) const;

  public:
    static KateGlobal *self ();

    static void incRef () { ++s_ref; }

    static void decRef () { if (s_ref > 0) --s_ref; if (s_ref == 0) { delete s_self; s_self = 0L; } }

    static QString katePartVersion();

    const KComponentData &componentData() { return m_componentData; }

    void registerDocument ( KateDocument *doc );

    void deregisterDocument ( KateDocument *doc );

    void registerView ( KateView *view );

    void deregisterView ( KateView *view );

    QList<KateDocument*> &kateDocuments () { return m_documents; }

    QList<KateView*> &views () { return m_views; }

    KatePartPluginManager *pluginManager () { return m_pluginManager; }

    KDirWatch *dirWatch () { return m_dirWatch; }

    KateModeManager *modeManager () { return m_modeManager; }

    KateSchemaManager *schemaManager () { return m_schemaManager; }

    KateDocumentConfig *documentConfig () { return m_documentConfig; }

    KateViewConfig *viewConfig () { return m_viewConfig; }

    KateRendererConfig *rendererConfig () { return m_rendererConfig; }

    KateScriptManager *scriptManager () { return m_scriptManager; }

    KateHlManager *hlManager () { return m_hlManager; }

    KateCmd *cmdManager () { return m_cmdManager; }

    KateViGlobal *viInputModeGlobal () { return m_viInputModeGlobal; }

    KateSpellCheckManager *spellCheckManager () { return m_spellCheckManager; }

    KateWordCompletionModel *wordCompletionModel () { return m_wordCompletionModel; }

    KateSnippetGlobal *snippetGlobal();

    bool registerCommand (KTextEditor::Command *cmd);

    bool unregisterCommand (KTextEditor::Command *cmd);

    KTextEditor::Command *queryCommand (const QString &cmd) const;

    QList<KTextEditor::Command*> commands() const;

    QStringList commandList() const;


    QObject * container();

    void setContainer( QObject * container );

    KTextEditor::TemplateScript* registerTemplateScript (QObject* owner, const QString& script);
    void unregisterTemplateScript(KTextEditor::TemplateScript* templateScript);

    void copyToClipboard (const QString &text);
    
    const QStringList &clipboardHistory () const
    {
        return m_clipboardHistory;
    }
    
  Q_SIGNALS:
    void clipboardHistoryChanged ();
    
  private Q_SLOTS:
    void updateColorPalette();

  private:
    static KateGlobal *s_self;

    static int s_ref;

    KAboutData m_aboutData;

    KComponentData m_componentData;

    QList<KateDocument*> m_documents;

    QList<KateView*> m_views;

    KDirWatch *m_dirWatch;

    KateModeManager *m_modeManager;

    KateSchemaManager *m_schemaManager;

    KatePartPluginManager *m_pluginManager;

    KateGlobalConfig *m_globalConfig;

    KateDocumentConfig *m_documentConfig;

    KateViewConfig *m_viewConfig;

    KateRendererConfig *m_rendererConfig;

    QList<KTextEditor::Command *> m_cmds;

    KateScriptManager *m_scriptManager;

    KateHlManager *m_hlManager;

    KateCmd *m_cmdManager;

    KateViGlobal *m_viInputModeGlobal;

    KateSpellCheckManager *m_spellCheckManager;

    QList<KTextEditor::Document*> m_docs;

    QPointer<QObject> m_container;

    KateWordCompletionModel *m_wordCompletionModel;

    KateSnippetGlobal *m_snippetGlobal;

    KSharedConfig::Ptr m_sessionConfig;
    
    QStringList m_clipboardHistory;
};

#endif

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