kxmlguiwindow.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-License-Identifier: LGPL-2.0-only
*/

#ifndef KXMLGUIWINDOW_H
#define KXMLGUIWINDOW_H

#include "kxmlguiclient.h"
#include "kxmlguibuilder.h"
#include "kmainwindow.h"

class KMenu;
class KXMLGUIFactory;
class KConfig;
class KConfigGroup;
class KToolBar;
class KXmlGuiWindowPrivate;

class KXMLGUI_EXPORT KXmlGuiWindow : public KMainWindow, public KXMLGUIBuilder, virtual public KXMLGUIClient
{
    XMLGUI_DECLARE_PRIVATE(KXmlGuiWindow)
    Q_OBJECT
    Q_PROPERTY(bool hasMenuBar READ hasMenuBar)
    Q_PROPERTY(bool autoSaveSettings READ autoSaveSettings)
    Q_PROPERTY(QString autoSaveGroup READ autoSaveGroup)
    Q_PROPERTY(bool standardToolBarMenuEnabled READ isStandardToolBarMenuEnabled WRITE setStandardToolBarMenuEnabled)

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

    ~KXmlGuiWindow() override;

    void setHelpMenuEnabled(bool showHelpMenu = true);

    bool isHelpMenuEnabled() const;

    virtual KXMLGUIFactory *guiFactory();

    void createGUI(const QString &xmlfile = QString());

    void setStandardToolBarMenuEnabled(bool enable);
    bool isStandardToolBarMenuEnabled() const;

    void createStandardStatusBarAction();

    enum StandardWindowOption {
        ToolBar = 1,

        Keys = 2,

        StatusBar = 4,

        Save = 8,

        Create = 16,

        Default = ToolBar | Keys | StatusBar | Save | Create
    };
    Q_FLAG(StandardWindowOption)
    Q_DECLARE_FLAGS(StandardWindowOptions, StandardWindowOption)

    void setupGUI(StandardWindowOptions options = Default, const QString &xmlfile = QString());

    void setupGUI(const QSize &defaultSize, StandardWindowOptions options = Default, const QString &xmlfile = QString());

    QAction *toolBarMenuAction();

    void setupToolbarMenuActions();

    // TODO KF6 change it to "using KXMLGUIBuilder::finalizeGUI;"
    void finalizeGUI(KXMLGUIClient *client) override;

    void finalizeGUI(bool force);

    // reimplemented for internal reasons
    void applyMainWindowSettings(const KConfigGroup &config) override;

public Q_SLOTS:
    virtual void configureToolbars();

    virtual void slotStateChanged(const QString &newstate);

    void slotStateChanged(const QString &newstate,
                          bool reverse);

protected:
    bool event(QEvent *event) override;

    void checkAmbiguousShortcuts();

protected Q_SLOTS:
    virtual void saveNewToolbarConfig();

private:
    Q_PRIVATE_SLOT(k_func(), void _k_slotFactoryMakingChanges(bool))
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KXmlGuiWindow::StandardWindowOptions)

#endif