diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2023-01-31 13:35:13 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-01-31 19:35:09 +0000 |
commit | 11256912476124f65cfbd98248aac184cf227448 (patch) | |
tree | 8b8b3d824b62d6da34a37d2ca56abddcfee2ab8b | |
parent | 8c151e146d7728c7c355f5a61a1365f1d58d565f (diff) | |
download | qttools-11256912476124f65cfbd98248aac184cf227448.tar.gz |
Qt Designer: Brush up the documentation code snippets
Remove redundant snippets.
Task-number: QTBUG-110447
Change-Id: I04c43df29ea1356bd3104a988c2c87f1cdba5588
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
(cherry picked from commit ce7282133ac8b67da21ea625538a342def2e2953)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
14 files changed, 34 insertions, 84 deletions
diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_default_extensionfactory.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_default_extensionfactory.cpp index e2dc3715d..ab2b5d2d5 100644 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_default_extensionfactory.cpp +++ b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_default_extensionfactory.cpp @@ -6,13 +6,12 @@ const QString &iid, QObject *parent) const { if (iid != Q_TYPEID(QDesignerContainerExtension)) - return 0; + return nullptr; - if (MyCustomWidget *widget = qobject_cast<MyCustomWidget*> - (object)) + if (auto *widget = qobject_cast<MyCustomWidget*>(object)) return new MyContainerExtension(widget, parent); - return 0; + return nullptr; } //! [0] @@ -21,17 +20,17 @@ QObject *AGeneralExtensionFactory::createExtension(QObject *object, const QString &iid, QObject *parent) const { - MyCustomWidget *widget = qobject_cast<MyCustomWidget*>(object); + auto *widget = qobject_cast<MyCustomWidget*>(object); + if (!widget) + return nullptr; - if (widget && (iid == Q_TYPEID(QDesignerTaskMenuExtension))) { + if (iid == Q_TYPEID(QDesignerTaskMenuExtension)) return new MyTaskMenuExtension(widget, parent); - } else if (widget && (iid == Q_TYPEID(QDesignerContainerExtension))) { + if (iid == Q_TYPEID(QDesignerContainerExtension)) return new MyContainerExtension(widget, parent); - } else { - return 0; - } + return nullptr; } //! [1] diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_extension.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_extension.cpp index 8b8793a08..b5ed7f4c4 100644 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_extension.cpp +++ b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_extension.cpp @@ -2,10 +2,9 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] - QDesignerPropertySheetExtension *propertySheet; - QExtensionManager manager = formEditor->extensionManager(); + auto *manager = formEditor->extensionManager(); - propertySheet = qt_extension<QDesignerPropertySheetExtension*>(manager, widget); + auto *propertySheet = qt_extension<QDesignerPropertySheetExtension*>(manager, widget); if(propertySheet) {...} //! [0] diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_qextensionmanager.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_qextensionmanager.cpp index 284f7a4fe..0b79dd60d 100644 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_qextensionmanager.cpp +++ b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_extension_qextensionmanager.cpp @@ -7,8 +7,8 @@ if (initialized) return; - QExtensionManager *manager = formEditor->extensionManager(); - Q_ASSERT(manager != 0); + auto *manager = formEditor->extensionManager(); + Q_ASSERT(manager != nullptr); manager->registerExtensions(new MyExtensionFactory(manager), Q_TYPEID(QDesignerTaskMenuExtension)); diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformeditor.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformeditor.cpp deleted file mode 100644 index de0739ed3..000000000 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformeditor.cpp +++ /dev/null @@ -1,14 +0,0 @@ -// Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -//! [0] - QDesignerObjectInspectorInterface *objectInspector = nullptr; - objectInspector = formEditor->objectInspector(); - - QDesignerFormWindowManagerInterface *manager = nullptr; - manager = formEditor->formWindowManager(); - - objectInspector->setFormWindow(manager->formWindow(0)); -//! [0] - - diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindow.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindow.cpp index d3735442c..4a8f5df6b 100644 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindow.cpp +++ b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindow.cpp @@ -2,21 +2,17 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] - QDesignerFormWindowInterface *formWindow; - formWindow = QDesignerFormWindowInterface::findFormWindow(myWidget); + auto *formWindow = QDesignerFormWindowInterface::findFormWindow(myWidget); //! [0] //! [1] QList<QDesignerFormWindowInterface *> forms; - QDesignerFormWindowInterface *formWindow; - QDesignerFormWindowManagerInterface *manager = formEditor->formWindowManager(); + auto *manager = formEditor->formWindowManager(); - for (int i = 0; i < manager->formWindowCount(); i++) { - formWindow = manager->formWindow(i); - forms.append(formWindow); - } + for (int i = 0; i < manager->formWindowCount(); ++i) + forms.append(manager->formWindow(i)); //! [1] diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindowcursor.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindowcursor.cpp index e8aa38de2..c6552713b 100644 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindowcursor.cpp +++ b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindowcursor.cpp @@ -2,8 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] - QDesignerFormWindowInterface *formWindow = nullptr; - formWindow = QDesignerFormWindowInterface::findFormWindow(myWidget); + auto *formWindow = QDesignerFormWindowInterface::findFormWindow(myWidget); formWindow->cursor()->setProperty(myWidget, myProperty, newValue); //! [0] diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindowmanager.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindowmanager.cpp index 9762f526d..9427dbdc3 100644 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindowmanager.cpp +++ b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractformwindowmanager.cpp @@ -2,11 +2,8 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] - QDesignerFormWindowManagerInterface *manager = nullptr; - QDesignerFormWindowInterface *formWindow = nullptr; - - manager = formEditor->formWindowManager(); - formWindow = manager->formWindow(0); + auto *manager = formEditor->formWindowManager(); + auto *formWindow = manager->formWindow(0); manager->setActiveFormWindow(formWindow); //! [0] diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractobjectinspector.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractobjectinspector.cpp index de0739ed3..9d806a846 100644 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractobjectinspector.cpp +++ b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractobjectinspector.cpp @@ -2,11 +2,8 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] - QDesignerObjectInspectorInterface *objectInspector = nullptr; - objectInspector = formEditor->objectInspector(); - - QDesignerFormWindowManagerInterface *manager = nullptr; - manager = formEditor->formWindowManager(); + auto *objectInspector = formEditor->objectInspector(); + auto *manager = formEditor->formWindowManager(); objectInspector->setFormWindow(manager->formWindow(0)); //! [0] diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractpropertyeditor.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractpropertyeditor.cpp index be84d4e1c..347988365 100644 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractpropertyeditor.cpp +++ b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractpropertyeditor.cpp @@ -2,21 +2,20 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] - QDesignerPropertyEditorInterface *propertyEditor = nullptr; - propertyEditor = formEditor->propertyEditor(); + auto *propertyEditor = formEditor->propertyEditor(); - connect(propertyEditor, SIGNAL(propertyChanged(QString,QVariant)), - this, SLOT(checkProperty(QString,QVariant))); + connect(propertyEditor, &QDesignerPropertyEditorInterface::propertyChanged, + this, &MyClass::checkProperty); //! [0] //! [1] - void checkProperty(QString property, QVariant value) { - QDesignerPropertyEditorInterface *propertyEditor = nullptr; - propertyEditor = formEditor->propertyEditor(); + void checkProperty(const QString &property, const QVariant &value) + { + auto *propertyEditor = formEditor->propertyEditor(); - QObject *object = propertyeditor->object(); - MyCustomWidget *widget = qobject_cast<MyCustomWidget>(object); + auto *object = propertyeditor->object(); + auto *widget = qobject_cast<MyCustomWidget *>(object); if (widget && property == aProperty && value != expectedValue) {...} diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractwidgetbox.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractwidgetbox.cpp index 38b58a1cd..a893306ea 100644 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractwidgetbox.cpp +++ b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_sdk_abstractwidgetbox.cpp @@ -2,8 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] - QDesignerWidgetBoxInterface *widgetBox = 0: - widgetBox = formEditor->widgetBox(); + auto *widgetBox = formEditor->widgetBox(); widgetBox->load(); //! [0] diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_uilib_abstractformbuilder.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_uilib_abstractformbuilder.cpp deleted file mode 100644 index 5f7f6760e..000000000 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_uilib_abstractformbuilder.cpp +++ /dev/null @@ -1,20 +0,0 @@ -// Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -//! [0] - MyForm::MyForm(QWidget *parent) - : QWidget(parent) - { - QFormBuilder builder; - QFile file(":/forms/myWidget.ui"); - file.open(QFile::ReadOnly); - QWidget *myWidget = builder.load(&file, this); - file.close(); - - QVBoxLayout *layout = new QVBoxLayout; - layout->addWidget(myWidget); - setLayout(layout); - } -//! [0] - - diff --git a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_uilib_formbuilder.cpp b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_uilib_formbuilder.cpp index 107f2e106..2120dcacb 100644 --- a/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_uilib_formbuilder.cpp +++ b/src/designer/src/designer/doc/snippets/lib/tools_designer_src_lib_uilib_formbuilder.cpp @@ -11,9 +11,8 @@ QWidget *myWidget = builder.load(&file, this); file.close(); - QVBoxLayout *layout = new QVBoxLayout; + auto *layout = new QVBoxLayout(this); layout->addWidget(myWidget); - setLayout(layout); } //! [0] diff --git a/src/designer/src/lib/sdk/abstractformeditor.cpp b/src/designer/src/lib/sdk/abstractformeditor.cpp index 077924ffc..5f34febb7 100644 --- a/src/designer/src/lib/sdk/abstractformeditor.cpp +++ b/src/designer/src/lib/sdk/abstractformeditor.cpp @@ -103,7 +103,7 @@ QDesignerFormEditorInterfacePrivate::~QDesignerFormEditorInterfacePrivate() these components. They are typically used to query (and manipulate) the respective component. For example: - \snippet lib/tools_designer_src_lib_sdk_abstractformeditor.cpp 0 + \snippet lib/tools_designer_src_lib_sdk_abstractobjectinspector.cpp 0 QDesignerFormEditorInterface is not intended to be instantiated directly. A pointer to \QD's current QDesignerFormEditorInterface diff --git a/src/designer/src/lib/uilib/abstractformbuilder.cpp b/src/designer/src/lib/uilib/abstractformbuilder.cpp index d4f30aab3..21f695f16 100644 --- a/src/designer/src/lib/uilib/abstractformbuilder.cpp +++ b/src/designer/src/lib/uilib/abstractformbuilder.cpp @@ -91,7 +91,7 @@ public: QFormBuilder class to create user interfaces from UI files at run-time. For example: - \snippet lib/tools_designer_src_lib_uilib_abstractformbuilder.cpp 0 + \snippet lib/tools_designer_src_lib_uilib_formbuilder.cpp 0 To override certain aspects of the form builder's behavior, subclass QAbstractFormBuilder and reimplement the relevant virtual |