Define recorder modes in area_data.h

+ Some documentation

include/area_data.h

@@ -272,6 +272,55 @@ class AreaData : public QObject {
      */
     EvidenceMod evi_mod;
     QMap<QString, QString> notecards;
+
+    /**
+     * @brief The three "states" the testimony recording system can have in an area.
+     */
+    enum TestimonyRecording{
+        STOPPED,
+        RECORDING,
+        UPDATE,
+        AMEND,
+        PLAYBACK,
+    };
+
+    /**
+     * @var TestimonyRecording STOPPED
+     * The testimony recorder is inactive and no ic-messages can be played back.
+     * If messages are inside the buffer when its stopped, the messages will remain until the recorder is set to RECORDING
+     */
+
+    /**
+     * @var TestimonyRecording RECORDING
+     * The testimony recorder is active and any ic-message send is recorded for playback.
+     * It does not differentiate between positions, so any message is recorded. Further improvement?
+     * When the recorder is started, it will clear the buffer and will make the first message the title.
+     * To prevent accidental recording by not disabling the recorder, a configurable buffer size can be set in the config.
+     */
+
+    /**
+     * @var TestimonyRecording UPDATE
+     * The testimony recorder is active and replaces the current message at the index with the next ic-message
+     * Once the IC-Message is send the recorder will default back into playback mode to prevent accidental overwriting of messages.
+     */
+
+    /**
+     * @var TestimonyRecording AMEND
+     * The testimony recorder is active and inserts the next message after the currently displayed ic-message
+     * This will increase the size by 1.
+     */
+
+    /**
+     * @var TestimonyRecording PLAYBACK
+     * The testimony recorder is inactive and ic-messages in the buffer will be played back.
+     */
+
+    /// Exposes the metadata of the TestimonyRecording enum.
+    Q_ENUM(TestimonyRecording);
+    TestimonyRecording test_rec;
+
+    QVector<QStringList> testimony;
+
 };
 
 #endif // AREA_DATA_H