kmainwindow.h

/*
    This file is part of the KDE libraries
    SPDX-FileCopyrightText: 2000 Reginald Stadlbauer <[email protected]>
    SPDX-FileCopyrightText: 1997 Stephan Kulow <[email protected]>
    SPDX-FileCopyrightText: 1997-2000 Sven Radej <[email protected]>
    SPDX-FileCopyrightText: 1997-2000 Matthias Ettrich <[email protected]>
    SPDX-FileCopyrightText: 1999 Chris Schlaeger <[email protected]>
    SPDX-FileCopyrightText: 2002 Joseph Wenninger <[email protected]>
    SPDX-FileCopyrightText: 2005-2006 Hamish Rodda <[email protected]>
    SPDX-FileCopyrightText: 2000-2008 David Faure <[email protected]>

    SPDX-License-Identifier: LGPL-2.0-only
*/

#ifndef KMAINWINDOW_H
#define KMAINWINDOW_H

#include <kxmlgui_export.h>

#include <QMainWindow>

class QMenu;
class KConfig;
class KConfigGroup;
class KMWSessionManager;
class KMainWindowPrivate;
class KToolBar;

// internal, not public API, may change any time
#define XMLGUI_DECLARE_PRIVATE(classname) \
    inline classname ## Private *k_func() { return reinterpret_cast<classname ## Private *>(k_ptr); } \
    inline const classname ## Private *k_func() const { return reinterpret_cast<classname ## Private *>(k_ptr); } \
    friend class classname ## Private;

#if KXMLGUI_ENABLE_DEPRECATED_SINCE(5, 65)

#define KDE_DEFAULT_WINDOWFLAGS 0
#else
#define KDE_DEFAULT_WINDOWFLAGS KDE_DEFAULT_WINDOWFLAGS_is_deprecated_use_Qt_WindowFlags()
#endif

class KXMLGUI_EXPORT KMainWindow : public QMainWindow
{
    friend class KMWSessionManager;
    friend class DockResizeListener;
    XMLGUI_DECLARE_PRIVATE(KMainWindow)
    Q_OBJECT
    Q_PROPERTY(bool hasMenuBar READ hasMenuBar)
    Q_PROPERTY(bool autoSaveSettings READ autoSaveSettings)
    Q_PROPERTY(QString autoSaveGroup READ autoSaveGroup)

public:
    explicit KMainWindow(QWidget *parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags());

    ~KMainWindow() override;

#if KXMLGUI_ENABLE_DEPRECATED_SINCE(5, 0)

    KXMLGUI_DEPRECATED_VERSION(5, 0, "Use KHelpMenu directly")
    QMenu *helpMenu(const QString &aboutAppText = QString(),
                    bool showWhatsThis = true);
#endif

#if KXMLGUI_ENABLE_DEPRECATED_SINCE(5, 0)

    KXMLGUI_DEPRECATED_VERSION(5, 0, "Use XMLGUI or KHelpMenu")
    QMenu *customHelpMenu(bool showWhatsThis = true);
#endif

    static bool canBeRestored(int number);

    static const QString classNameOfToplevel(int number);

    bool restore(int number, bool show = true);

    bool hasMenuBar();

    static QList<KMainWindow *> memberList();

    KToolBar *toolBar(const QString &name = QString());

    QList<KToolBar *> toolBars() const;

    void setAutoSaveSettings(const QString &groupName = QStringLiteral("MainWindow"),
                             bool saveWindowSize = true);

    void setAutoSaveSettings(const KConfigGroup &group,
                             bool saveWindowSize = true);

    void resetAutoSaveSettings();

    bool autoSaveSettings() const;

    QString autoSaveGroup() const;

    KConfigGroup autoSaveConfigGroup() const;

    virtual void applyMainWindowSettings(const KConfigGroup &config);

    void saveMainWindowSettings(KConfigGroup &config);

    QString dbusName() const;

#if KXMLGUI_ENABLE_DEPRECATED_SINCE(5, 0)

    KXMLGUI_DEPRECATED_VERSION(5, 0, "Remove usage, is a no-op now")
    bool initialGeometrySet() const { return false; }
#endif

public Q_SLOTS:
    virtual void setCaption(const QString &caption);
    virtual void setCaption(const QString &caption, bool modified);

    virtual void setPlainCaption(const QString &caption);

    void appHelpActivated();

    void setSettingsDirty();

protected:
    bool event(QEvent *event) override;

    void closeEvent(QCloseEvent *) override;

    virtual bool queryClose();

    virtual void saveProperties(KConfigGroup &) {}

    virtual void readProperties(const KConfigGroup &) {}

    virtual void saveGlobalProperties(KConfig *sessionConfig);

    virtual void readGlobalProperties(KConfig *sessionConfig);
    void savePropertiesInternal(KConfig *, int);
    bool readPropertiesInternal(KConfig *, int);

    bool settingsDirty() const;
#if KXMLGUI_ENABLE_DEPRECATED_SINCE(5, 0)

    KXMLGUI_DEPRECATED_VERSION(5, 0, "Use KWindowConfig::saveWindowSize(...)")
    void saveWindowSize(KConfigGroup &config) const;
#endif

#if KXMLGUI_ENABLE_DEPRECATED_SINCE(5, 0)

    KXMLGUI_DEPRECATED_VERSION(5, 0, "Use KWindowConfig::restoreWindowSize(...)")
    void restoreWindowSize(const KConfigGroup &config);
#endif

protected Q_SLOTS:
#if KXMLGUI_BUILD_DEPRECATED_SINCE(5, 0)

    KXMLGUI_DEPRECATED_VERSION(5, 0, "Use KHelpMenu")
    virtual void showAboutApplication() {}
#endif

    void saveAutoSaveSettings();

protected:
    KMainWindow(KMainWindowPrivate &dd, QWidget *parent, Qt::WindowFlags f);

    KMainWindowPrivate *const k_ptr;
private:
    Q_PRIVATE_SLOT(k_func(), void _k_slotSettingsChanged(int))
    Q_PRIVATE_SLOT(k_func(), void _k_slotSaveAutoSaveSize())
};


#if KXMLGUI_ENABLE_DEPRECATED_SINCE(5, 0)

#define RESTORE(type) { int n = 1;\
        while (KMainWindow::canBeRestored(n)){\
            (new type)->restore(n);\
            n++;}}
#endif

#define KDE_RESTORE_MAIN_WINDOWS_NUM_TEMPLATE_ARGS 3

template <typename T>
inline void kRestoreMainWindows()
{
    for (int n = 1; KMainWindow::canBeRestored(n); ++n) {
        const QString className = KMainWindow::classNameOfToplevel(n);
        if (className == QLatin1String(T::staticMetaObject.className())) {
            (new T)->restore(n);
        }
    }
} 

template <typename T0, typename T1, typename ...Tn>
inline void kRestoreMainWindows()
{
    kRestoreMainWindows<T0>();
    kRestoreMainWindows<T1, Tn...>();
}
#endif