summaryrefslogtreecommitdiffstats
path: root/commands/command.h
diff options
context:
space:
mode:
authorGravatar Berthold Stoeger <bstoeger@mail.tuwien.ac.at>2019-11-13 15:08:40 +0100
committerGravatar bstoeger <32835590+bstoeger@users.noreply.github.com>2019-11-14 21:02:07 +0100
commit5e29245e689fe9401ee1c33ebb07c601ce25e8c6 (patch)
treea656bcb0e9357b8cab78c5ad196fc6e5a4da4c31 /commands/command.h
parent685b92b9c2ddd6575ae5df7c95b928e60fcd7005 (diff)
downloadsubsurface-5e29245e689fe9401ee1c33ebb07c601ce25e8c6.tar.gz
Refactoring: move undo commands to top level
In the future we might want to use undo-commands for mobile as well (even if not implementing undo). Therefore, move the undo-command source from desktop-widgets to their own commands top-level folder. Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
Diffstat (limited to 'commands/command.h')
-rw-r--r--commands/command.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/commands/command.h b/commands/command.h
new file mode 100644
index 000000000..8fbed5069
--- /dev/null
+++ b/commands/command.h
@@ -0,0 +1,87 @@
+// 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 {
+
+// 1) General commands
+
+void init(); // Setup signals to inform frontend of clean status.
+void clear(); // Reset the undo stack. Delete all commands.
+void setClean(); // Call after save - this marks a state where no changes need to be saved.
+bool isClean(); // Any changes need to be saved?
+QAction *undoAction(QObject *parent); // Create an undo action.
+QAction *redoAction(QObject *parent); // Create an redo action.
+
+// 2) Dive-list related commands
+
+// If d->dive_trip is null and autogroup is true, dives within the auto-group
+// distance are added to a trip. dive d is consumed (the structure is reset)!
+// If newNumber is true, the dive is assigned a new number, depending on the
+// insertion position.
+void addDive(dive *d, const bool autogroup, bool newNumber);
+void importDives(struct dive_table *dives, struct trip_table *trips,
+ struct dive_site_table *sites, int flags, const QString &source); // The tables are consumed!
+void deleteDive(const QVector<struct dive*> &divesToDelete);
+void shiftTime(const QVector<dive *> &changedDives, int amount);
+void renumberDives(const QVector<QPair<dive *, 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 splitDiveComputer(dive *d, int dc_num);
+void moveDiveComputerToFront(dive *d, int dc_num);
+void deleteDiveComputer(dive *d, int dc_num);
+void mergeDives(const QVector <dive *> &dives);
+
+// 3) Dive-site related commands
+
+void deleteDiveSites(const QVector <dive_site *> &sites);
+void editDiveSiteName(dive_site *ds, const QString &value);
+void editDiveSiteDescription(dive_site *ds, const QString &value);
+void editDiveSiteNotes(dive_site *ds, const QString &value);
+void editDiveSiteCountry(dive_site *ds, const QString &value);
+void editDiveSiteLocation(dive_site *ds, location_t value);
+void editDiveSiteTaxonomy(dive_site *ds, taxonomy_data &value); // value is consumed (i.e. will be erased after call)!
+void addDiveSite(const QString &name);
+void importDiveSites(struct dive_site_table *sites, const QString &source);
+void mergeDiveSites(dive_site *ds, const QVector<dive_site *> &sites);
+void purgeUnusedDiveSites();
+
+// 4) Dive editing related commands
+
+int editNotes(const QString &newValue, bool currentDiveOnly);
+int editSuit(const QString &newValue, bool currentDiveOnly);
+int editMode(int index, int newValue, bool currentDiveOnly);
+int editNumber(int newValue, bool currentDiveOnly);
+int editRating(int newValue, bool currentDiveOnly);
+int editVisibility(int newValue, bool currentDiveOnly);
+int editAirTemp(int newValue, bool currentDiveOnly);
+int editWaterTemp(int newValue, bool currentDiveOnly);
+int editAtmPress(int newValue, bool currentDiveOnly);
+int editDepth(int newValue, bool currentDiveOnly);
+int editDuration(int newValue, bool currentDiveOnly);
+int editDiveSite(struct dive_site *newValue, bool currentDiveOnly);
+int editDiveSiteNew(const QString &newName, bool currentDiveOnly);
+int editTags(const QStringList &newList, bool currentDiveOnly);
+int editBuddies(const QStringList &newList, bool currentDiveOnly);
+int editDiveMaster(const QStringList &newList, bool currentDiveOnly);
+void pasteDives(const dive *d, dive_components what);
+void replanDive(dive *d); // dive computer(s) and cylinder(s) will be reset!
+
+// 5) Trip editing commands
+
+void editTripLocation(dive_trip *trip, const QString &s);
+void editTripNotes(dive_trip *trip, const QString &s);
+
+} // namespace Command
+
+#endif // COMMAND_H