summaryrefslogtreecommitdiffstats
path: root/desktop-widgets/command.h
diff options
context:
space:
mode:
authorGravatar Berthold Stoeger <bstoeger@mail.tuwien.ac.at>2018-07-23 23:41:23 +0200
committerGravatar Dirk Hohndel <dirk@hohndel.org>2018-10-11 16:22:27 -0700
commit43c3885249fb867e7c33c8b3b5846d44e908774f (patch)
tree3675041ca82295a94c3bc48e9812e26543faacae /desktop-widgets/command.h
parentf427226b3b605523bc8285dbdaaa7f6993af6e6a (diff)
downloadsubsurface-43c3885249fb867e7c33c8b3b5846d44e908774f.tar.gz
Undo: isolate undo-commands
This refactors the undo-commands (which are now only "commands"). - Move everything in namespace Command. This allows shortening of names without polluting the global namespace. Moreover, the prefix Command:: will immediately signal that the undo-machinery is invoked. This is more terse than UndoCommands::instance()->... - Remove the Undo in front of the class-names. Creating an "UndoX" object to do "X" is paradoxical. - Create a base class for all commands that defines the Qt-translation functions. Thus all translations end up in the "Command" context. - Add a workToBeDone() function, which signals whether this should be added to the UndoStack. Thus the caller doesn't have to check itself whether this any work will be done. Note: Qt5.9 introduces "setObsolete" which does the same. - Split into public and internal header files. In the public header file only export the function calls, thus hiding all implementation details from the caller. - Split in different translation units: One for the stubs, one for the base classes and one for groups of commands. Currently, there is only one class of commands: divelist-commands. - Move the undoStack from the MainWindow class into commands_base.cpp. If we want to implement MDI, this can easily be moved into an appropriate Document class. Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
Diffstat (limited to 'desktop-widgets/command.h')
-rw-r--r--desktop-widgets/command.h33
1 files changed, 33 insertions, 0 deletions
diff --git a/desktop-widgets/command.h b/desktop-widgets/command.h
new file mode 100644
index 000000000..213d8bcda
--- /dev/null
+++ b/desktop-widgets/command.h
@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: GPL-2.0
+#ifndef COMMAND_H
+#define COMMAND_H
+
+#include "core/dive.h"
+#include <QVector>
+#include <QAction>
+
+// We put everything in a namespace, so that we can shorten names without polluting the global namespace
+namespace Command {
+
+// General commands
+void clear(); // Reset the undo stack. Delete all commands.
+QAction *undoAction(QObject *parent); // Create an undo action.
+QAction *redoAction(QObject *parent); // Create an redo action.
+
+// Dive-list related commands
+void addDive(dive *d);
+void deleteDive(const QVector<struct dive*> &divesToDelete);
+void shiftTime(const QVector<dive *> &changedDives, int amount);
+void renumberDives(const QVector<QPair<int, int>> &divesToRenumber);
+void removeDivesFromTrip(const QVector<dive *> &divesToRemove);
+void removeAutogenTrips();
+void addDivesToTrip(const QVector<dive *> &divesToAddIn, dive_trip *trip);
+void createTrip(const QVector<dive *> &divesToAddIn);
+void autogroupDives();
+void mergeTrips(dive_trip *trip1, dive_trip *trip2);
+void splitDives(dive *d, duration_t time);
+void mergeDives(const QVector <dive *> &dives);
+
+} // namespace Command
+
+#endif // COMMAND_H