File indexing completed on 2024-05-19 04:36:33

 /* This file is part of the TikZKit project.
  *
  * Copyright (C) 2014-2016 Dominik Haumann <dhaumann@kde.org>
  *
  * 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, see
  * <http://www.gnu.org/licenses/>.
  */
 
 #ifndef TIKZUI_EDITOR_PRIVATE_H
 #define TIKZUI_EDITOR_PRIVATE_H
 
 #include <tikz/ui/Editor.h>
 #include <tikz/ui/Application.h>
 #include <tikz/ui/MainWindow.h>
 
 #include <QList>
 #include <QPointer>
 #include <QVector>
 
 namespace tikz {
 namespace ui {
 
 class DocumentPrivate;
 class ViewPrivate;
 
 /**
  * tikz::ui::EditorPrivate
  * One instance of this class is hold alive during
  * a kate part session, as long as any factory, document
  * or view stay around, here is the place to put things
  * which are needed and shared by all this objects ;)
  */
 class EditorPrivate : public tikz::ui::Editor
 {
     Q_OBJECT
 
     friend class tikz::ui::Editor;
 
 private:
     /**
      * Default constructor, private, as singleton
      * @param staticInstance pointer to fill with content of this
      */
     EditorPrivate(QPointer<tikz::ui::EditorPrivate> &staticInstance);
 
 public:
     /**
      * Destructor
      */
     ~EditorPrivate();
 
     /**
      * Create a new document object
      * @param parent parent object
      * @return created tikz::ui::Document
      */
     tikz::ui::Document *createDocument(QObject *parent) override;
 
     /**
      * Returns a list of all documents of this editor.
      * @return list of all existing documents
      */
     QVector<tikz::ui::Document *> documents() override;
 
     /**
      * Get a list of all Views of this editor.
      * \return list of all existing Views
      */
     QVector<tikz::ui::View *> views() override;
 
     /**
      * Set the global application object.
      * This will allow the editor component to access
      * the hosting application.
      * @param application application object
      */
     void setApplication(tikz::ui::Application *application) override
     {
         // switch back to dummy application?
         m_application = application ? application : &m_dummyApplication;
     }
 
     /**
      * Current hosting application, if any set.
      * @return current application object or nullptr
      */
     tikz::ui::Application *application() const override
     {
         return m_application;
     }
 
     /**
      * Configuration management
      */
 public:
     /**
      * Number of available config pages
      * If the editor returns a number < 1, it doesn't support this
      * and the embedding app should use the configDialog () instead
      * @return number of config pages
      */
     int configPages() const override;
 
     /**
      * Returns config page with the given number,
      * config pages from 0 to configPages()-1 are available
      * if configPages() > 0
      */
     tikz::ui::ConfigPage *configPage(int number, QWidget *parent) override;
 
     /**
      * TikZKit Internal stuff ;)
      */
 public:
     /**
      * singleton accessor
      * @return instance of the factory
      */
     static EditorPrivate *self();
 
     /**
      * register document at the factory
      * this allows us to loop over all docs for example on config changes
      * @param doc document to register
      */
     void registerDocument(tikz::ui::DocumentPrivate *doc);
 
     /**
      * unregister document at the factory
      * @param doc document to register
      */
     void unregisterDocument(tikz::ui::DocumentPrivate *doc);
 
     /**
      * return a list of all registered docs
      * @return all known documents
      */
     QVector<tikz::ui::DocumentPrivate *> tikzDocuments();
 
     /**
      * register view at the factory
      * this allows us to loop over all views for example on config changes
      * @param view view to register
      */
     void registerView(tikz::ui::ViewPrivate *view);
 
     /**
      * unregister view at the factory
      * @param view view to unregister
      */
     void unregisterView(tikz::ui::ViewPrivate *view);
 
     /**
      * Return a list of all registered tikz::ui::ViewPrivate%s
      */
     QVector<tikz::ui::ViewPrivate *> tikzViews();
 
 public:
     /**
      * Dummy main window to be null safe.
      * @return dummy main window
      */
     tikz::ui::MainWindow *dummyMainWindow()
     {
         return &m_dummyMainWindow;
     }
 
 private:
     /**
      * Dummy application object to be null safe
      */
     tikz::ui::Application m_dummyApplication;
 
     /**
      * Dummy main window to be null safe
      */
     tikz::ui::MainWindow m_dummyMainWindow;
 
     /**
      * registered docs, map from general to specialized pointer
      */
     QVector<tikz::ui::DocumentPrivate *> m_documents;
 
     /**
      * registered views
      */
     QVector<tikz::ui::ViewPrivate *> m_views;
 
     /**
      * access to application
      */
     QPointer<tikz::ui::Application> m_application;
 };
 
 }
 }
 
 #endif // TIKZUI_EDITOR_PRIVATE_H
 
 // kate: indent-width 4; replace-tabs on;