qdesigner_widgetbox_p.h

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists for the convenience
// of Qt Designer.  This header
// file may change from version to version without notice, or even be removed.
//
// We mean it.
//
 
#ifndef QDESIGNER_WIDGETBOX_H
#define QDESIGNER_WIDGETBOX_H
 
#include "shared_global_p.h"
#include <QtDesigner/abstractwidgetbox.h>
 
QT_BEGIN_NAMESPACE
 
class DomUI;
 
namespace qdesigner_internal {
 
// A widget box with a load mode that allows for updating custom widgets.
 
class QDESIGNER_SHARED_EXPORT QDesignerWidgetBox : public QDesignerWidgetBoxInterface
{
    Q_OBJECT
public:
    enum LoadMode { LoadMerge, LoadReplace, LoadCustomWidgetsOnly };
 
    explicit QDesignerWidgetBox(QWidget *parent = nullptr, Qt::WindowFlags flags = {});
 
    LoadMode loadMode() const;
    void setLoadMode(LoadMode lm);
 
    virtual bool loadContents(const QString &contents) = 0;
 
    // Convenience to access the widget box icon of a widget. Empty category
    // matches all
    virtual QIcon iconForWidget(const QString &className,
                                const QString &category = QString()) const = 0;
 
    // Convenience to find a widget by class name. Empty category matches all
    static bool findWidget(const QDesignerWidgetBoxInterface *wbox,
                           const QString &className,
                           const QString &category /* = QString()  */,
                           Widget *widgetData);
    // Convenience functions to create a DomWidget from widget box xml.
    static DomUI *xmlToUi(const QString &name, const QString &xml, bool insertFakeTopLevel, QString *errorMessage);
    static DomUI *xmlToUi(const QString &name, const QString &xml, bool insertFakeTopLevel);
 
private:
    LoadMode m_loadMode = LoadMerge;
};
}  // namespace qdesigner_internal
 
QT_END_NAMESPACE
 
#endif // QDESIGNER_WIDGETBOX_H