mainwindow.h

/*  SPDX-License-Identifier: LGPL-2.0-or-later

    Copyright (C) 2013 Christoph Cullmann <[email protected]>

    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 KTEXTEDITOR_MAINWINDOW_H
#define KTEXTEDITOR_MAINWINDOW_H

#include <ktexteditor_export.h>

#include <QObject>

class QEvent;
class QIcon;
class QUrl;
class QWidget;

class KXMLGUIFactory;

namespace KTextEditor
{
class Plugin;
class Document;
class View;

class KTEXTEDITOR_EXPORT MainWindow : public QObject
{
    Q_OBJECT

public:
    MainWindow(QObject *parent);

    virtual ~MainWindow();

    //
    // Accessors to some window properties and contents
    //
public:
    QWidget *window();

    KXMLGUIFactory *guiFactory();

    //
    // Signals related to the main window
    //
Q_SIGNALS:
    void unhandledShortcutOverride(QEvent *e);

    //
    // View access and manipulation interface
    //
public:
    QList<KTextEditor::View *> views();

    KTextEditor::View *activeView();

    KTextEditor::View *activateView(KTextEditor::Document *document);

    KTextEditor::View *openUrl(const QUrl &url, const QString &encoding = QString());

    bool closeView(KTextEditor::View *view);

    void splitView(Qt::Orientation orientation);

    bool closeSplitView(KTextEditor::View *view);

    bool viewsInSameSplitView(KTextEditor::View *view1, KTextEditor::View *view2);

    //
    // Signals related to view handling
    //
Q_SIGNALS:
    void viewChanged(KTextEditor::View *view);

    void viewCreated(KTextEditor::View *view);

    //
    // Interface to allow view bars to be constructed in a central place per window
    //
public:
    QWidget *createViewBar(KTextEditor::View *view);

    void deleteViewBar(KTextEditor::View *view);

    void addWidgetToViewBar(KTextEditor::View *view, QWidget *bar);

    void showViewBar(KTextEditor::View *view);

    void hideViewBar(KTextEditor::View *view);

    //
    // ToolView stuff, here all stuff belong which allows to
    // add/remove and manipulate the toolview of this main windows
    //
public:
    enum ToolViewPosition {
        Left = 0,  
        Right = 1, 
        Top = 2,   
        Bottom = 3 
    };

    QWidget *createToolView(KTextEditor::Plugin *plugin, const QString &identifier, KTextEditor::MainWindow::ToolViewPosition pos, const QIcon &icon, const QString &text);

    bool moveToolView(QWidget *widget, KTextEditor::MainWindow::ToolViewPosition pos);

    bool showToolView(QWidget *widget);

    bool hideToolView(QWidget *widget);

    //
    // Application plugin accessors
    //
public:
    bool showPluginConfigPage(KTextEditor::Plugin *plugin, int page);

    QObject *pluginView(const QString &name);

    //
    // Signals related to application plugins
    //
Q_SIGNALS:
    void pluginViewCreated(const QString &name, QObject *pluginView);

    void pluginViewDeleted(const QString &name, QObject *pluginView);

private:
    friend class MainWindowPrivate;

    class MainWindowPrivate *const d;
};

} // namespace KTextEditor

#endif