File : dialogs/saveAsDialog/SaveAsDialogData.js

1
/*
2
Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/
3
4
This  program is free software;
5
you can redistribute it and/or modify it under the terms of the
6
GNU General Public License as published by the Free Software Foundation;
7
either version 3 of the License, or any later version.
8
9
This program is distributed in the hope that it will be useful,
10
but WITHOUT ANY WARRANTY; without even the implied warranty of
11
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
GNU General Public License for more details.
13
14
You should have received a copy of the GNU General Public License
15
along with this program; if not, write to the Free Software
16
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
*/
18
/*
19
Changes:
20
    - v4.0.0:
21
        - created from v3.6.0
22
Doc reviewed 202208
23
 */
24
25
/* ------------------------------------------------------------------------------------------------------------------------- */
26
/**
27
A simple container with the user choices in the SaveAsDialog
28
*/
29
/* ------------------------------------------------------------------------------------------------------------------------- */
30
31
class SaveAsDialogData {
32
33
    /**
34
    A flag indicating that the travel notes have to be removed
35
    @type {Boolean}
36
    */
37
38
    #removeTravelNotes;
39
40
    /**
41
    A flag indicating that the route notes have to be removed
42
    @type {Boolean}
43
    */
44
45
    #removeRoutesNotes;
46
47
    /**
48
    A flag indicating that the maneuvers have to be removed
49
    @type {Boolean}
50
    */
51
52
    #removeManeuvers;
53
54
    /**
55
    The constructor
56
    @param {Boolean} removeTravelNotes A flag indicating that the travel notes have to be removed
57
    @param {Boolean} removeRoutesNotes A flag indicating that the route notes have to be removed
58
    @param {Boolean} removeManeuvers A flag indicating that the maneuvers have to be removed
59
    */
60
61
    constructor ( removeTravelNotes, removeRoutesNotes, removeManeuvers ) {
62
        Object.freeze ( this );
63
        this.#removeTravelNotes = removeTravelNotes;
64
        this.#removeRoutesNotes = removeRoutesNotes;
65
        this.#removeManeuvers = removeManeuvers;
66
    }
67
68
    /**
69
    A flag indicating that the travel notes have to be removed
70
    @type {Boolean}
71
    */
72
73
    get removeTravelNotes ( ) { return this.#removeTravelNotes; }
74
75
    /**
76
    A flag indicating that the route notes have to be removed
77
    @type {Boolean}
78
    */
79
80
    get removeRoutesNotes ( ) { return this.#removeRoutesNotes; }
81
82
    /**
83
    A flag indicating that the maneuvers have to be removed
84
    @type {Boolean}
85
    */
86
87
    get removeManeuvers ( ) { return this.#removeManeuvers; }
88
}
89
90
export default SaveAsDialogData;
91
92
/* --- End of file --------------------------------------------------------------------------------------------------------- */
93