diff options
author | Volker Hilsheimer <[email protected]> | 2023-01-09 13:55:09 +0100 |
---|---|---|
committer | Jan Arve Sæther <[email protected]> | 2023-01-31 00:20:31 +0100 |
commit | cb0bf5ad683b72d4ecb0d21dafde3a5acdaac800 (patch) | |
tree | d16f765a9d41bf178c7bcc0bccccf0fe59ac1fee /examples/widgets/doc/src | |
parent | 26f8ea1224e43bef9ba3f121c6d5d8e19a8756fc (diff) |
Merge "undo" and "undoframework" examples
The "undo" example didn't show anything that the "undoframework"
example doesn't, and the latter is more comprehensive and properly
documented. "undoframework" also uses QGraphicsView instead of
inventing its own diagram widget.
However, the "undo" example created a nicer UI with toolbuttons,
icons, and the undo view in a dock widget, so reuse those elements
in the "undoframework" example instead.
Update the documentation quoting tags accordingly, and clean up
a bit.
Pick-to: 6.5
Change-Id: I3c91feecbd5fe3e5900838b0b51f9fe7bd190280
Reviewed-by: Jan Arve Sæther <[email protected]>
Diffstat (limited to 'examples/widgets/doc/src')
-rw-r--r-- | examples/widgets/doc/src/undo.qdoc | 20 | ||||
-rw-r--r-- | examples/widgets/doc/src/undoframework.qdoc | 41 |
2 files changed, 17 insertions, 44 deletions
diff --git a/examples/widgets/doc/src/undo.qdoc b/examples/widgets/doc/src/undo.qdoc deleted file mode 100644 index 3ffe10ddf3d..00000000000 --- a/examples/widgets/doc/src/undo.qdoc +++ /dev/null @@ -1,20 +0,0 @@ -// Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only - -/*! - \example tools/undo - \title Undo Framework - \ingroup examples-widgets-tools - - \brief This example shows Qt's undo framework in action. - - \image undodemo.png - - Qt's undo framework is an implementation of the Command - pattern, which provides advanced undo/redo functionality. - - To show the abilities of the framework, we have implemented a - small diagram application in which the diagram items are geometric - primitives. You can edit the diagram in the following ways: add, - move, change the color of, and delete the items. -*/ diff --git a/examples/widgets/doc/src/undoframework.qdoc b/examples/widgets/doc/src/undoframework.qdoc index 3d275788f60..6ca2b4b138f 100644 --- a/examples/widgets/doc/src/undoframework.qdoc +++ b/examples/widgets/doc/src/undoframework.qdoc @@ -69,6 +69,9 @@ \snippet tools/undoframework/mainwindow.cpp 0 In the constructor, we set up the DiagramScene and QGraphicsView. + We only want \c deleteAction to be enabled when we have selected an + item, so we connect to the \c selectionChanged() signal of the scene + to \c updateActions() slot. Here is the \c createUndoView() function: @@ -76,13 +79,11 @@ The QUndoView is a widget that display the text, which is set with the \l{QUndoCommand::}{setText()} function, for each QUndoCommand - in the undo stack in a list. + in the undo stack in a list. We put it into a docking widget. Here is the \c createActions() function: \snippet tools/undoframework/mainwindow.cpp 2 - \codeline - \snippet tools/undoframework/mainwindow.cpp 3 \dots \snippet tools/undoframework/mainwindow.cpp 5 @@ -95,46 +96,38 @@ \l{QUndoCommand::}{text()} of the undo commands. For the other actions we have implemented slots in the \c MainWindow class. - Here is the \c createMenus() function: - + \dots \snippet tools/undoframework/mainwindow.cpp 6 - \dots + Once all actions are created we update their state by calling the + same function that is connected to the \c selectionChanged signal of + the scene. + + The \c createMenus() and \c createToolBars() functions add the + actions to menus and toolbars: + \snippet tools/undoframework/mainwindow.cpp 7 \dots \snippet tools/undoframework/mainwindow.cpp 8 - - We have to use the QMenu \c aboutToShow() and \c aboutToHide() - signals since we only want \c deleteAction to be enabled when we - have selected an item. + \dots + \snippet tools/undoframework/mainwindow.cpp 9 Here is the \c itemMoved() slot: - \snippet tools/undoframework/mainwindow.cpp 9 + \snippet tools/undoframework/mainwindow.cpp 11 We simply push a MoveCommand on the stack, which calls \c redo() on it. Here is the \c deleteItem() slot: - \snippet tools/undoframework/mainwindow.cpp 10 + \snippet tools/undoframework/mainwindow.cpp 12 - An item must be selected to be deleted. We need to check if it is + An item must be selected to be deleted. We need to check if it is selected as the \c deleteAction may be enabled even if an item is not selected. This can happen as we do not catch a signal or event when an item is selected. - Here is the \c itemMenuAboutToShow() and itemMenuAboutToHide() slots: - - \snippet tools/undoframework/mainwindow.cpp 11 - \codeline - \snippet tools/undoframework/mainwindow.cpp 12 - - We implement \c itemMenuAboutToShow() and \c itemMenuAboutToHide() - to get a dynamic item menu. These slots are connected to the - \l{QMenu::}{aboutToShow()} and \l{QMenu::}{aboutToHide()} signals. - We need this to disable or enable the \c deleteAction. - Here is the \c addBox() slot: \snippet tools/undoframework/mainwindow.cpp 13 |