kxmlguibuilder.h

/*
    This file is part of the KDE project
    SPDX-FileCopyrightText: 2000 Simon Hausmann <[email protected]>
    SPDX-FileCopyrightText: 2000 David Faure <[email protected]>

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

#ifndef kxmlguibuilder_h
#define kxmlguibuilder_h

#include <kxmlgui_export.h>
#include <memory>

class KXMLGUIBuilderPrivate;
class KXMLGUIClient;

class QAction;
class QDomElement;
class QStringList;
class QWidget;

class KXMLGUI_EXPORT KXMLGUIBuilder
{
public:

    explicit KXMLGUIBuilder(QWidget *widget);
    virtual ~KXMLGUIBuilder();

    /* @internal */
    KXMLGUIClient *builderClient() const;
    /* @internal */
    void setBuilderClient(KXMLGUIClient *client);
    /* @internal */
    QWidget *widget();

    virtual QStringList containerTags() const;

    virtual QWidget *createContainer(QWidget *parent, int index,
                                     const QDomElement &element, QAction *&containerAction);

    virtual void removeContainer(QWidget *container, QWidget *parent,
                                 QDomElement &element, QAction *containerAction);

    virtual QStringList customTags() const;

    virtual QAction *createCustomElement(QWidget *parent, int index, const QDomElement &element);

#if KXMLGUI_BUILD_DEPRECATED_SINCE(5, 0)
    // KF6 TODO: REMOVE
    KXMLGUI_DEPRECATED_VERSION(5, 0, "Do not use")
    virtual void removeCustomElement(QWidget *parent, QAction *action);
#endif

    virtual void finalizeGUI(KXMLGUIClient *client);

protected:
    virtual void virtual_hook(int id, void *data);

private:
    std::unique_ptr<KXMLGUIBuilderPrivate> const d;
};

#endif