Mercurial > retraceit

comparison src/constants.h @ 66:098a10fc2e83 0.9.2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add doxygen files and improve doxygen comments
author Andre Heinecke <andre.heinecke@intevation.de>
date Thu, 21 May 2015 15:21:47 +0200
parents c4a5ef6db895
children 5923d569167b
comparison
equal deleted inserted replaced
65:508a71328d1f 66:098a10fc2e83
6 * This file is Free Software under the GNU GPL (v>=2) 6 * This file is Free Software under the GNU GPL (v>=2)
7 * and comes with ABSOLUTELY NO WARRANTY! 7 * and comes with ABSOLUTELY NO WARRANTY!
8 * See LICENSE.txt for details. 8 * See LICENSE.txt for details.
9 */ 9 */
10 10
11 /** @file Common definitions for this project. 11 /** @file constants.h
12 * @brief Common definitions for this project.
12 * 13 *
13 * This file can be included to pull in common 14 * @details This file can be included to pull in common
14 * definitions in the application. */ 15 * definitions in the application. */
15 16
16 /**@def The version of the software package. 17 /**
18 * @brief The version of the software package.
17 * 19 *
18 * Usually defined as Build parameter. 20 * Usually defined as Build parameter.
19 */ 21 */
20 #ifndef VERSION 22 #ifndef VERSION
21 #define VERSION "0.0.1" 23 #define VERSION "0.0.1"
22 #endif 24 #endif
23 25
24 /**@def The user visible application name. 26 /**
27 * @brief The user visible application name.
25 * 28 *
26 * Usually defined as Build parameter. 29 * Usually defined as Build parameter.
27 **/ 30 **/
28 #ifndef APPNAME 31 #ifndef APPNAME
29 #define APPNAME "unknown" 32 #define APPNAME "unknown"
30 #endif 33 #endif
31 34
32 /**@def Short command line description. */ 35 /**
36 * @brief Short command line description. */
33 #define DESCRIPTION "A tool to replay recorded user sessions." 37 #define DESCRIPTION "A tool to replay recorded user sessions."
34 38
35 /**@def Short copyright notice to show users. */ 39 /**
40 * @brief Short copyright notice to show users. */
36 #define COPYRIGHT "Copyright (C) 2015 ETH Zürich \n\n" \ 41 #define COPYRIGHT "Copyright (C) 2015 ETH Zürich \n\n" \
37 "This file is Free Software under the GNU GPL (v>=2)\n" \ 42 "This file is Free Software under the GNU GPL (v>=2)\n" \
38 "and comes with ABSOLUTELY NO WARRANTY!\n" 43 "and comes with ABSOLUTELY NO WARRANTY!\n"
39 44
40 /**@def the config key for the last selected root folder. */ 45 /**
46 * @brief the config key for the last selected root folder. */
41 #define ROOT_FOLDER_KEY "RootFolder" 47 #define ROOT_FOLDER_KEY "RootFolder"
42 48
43 /**@def the config key for the root folder info pattern. */ 49 /**
50 * @brief the config key for the root folder info pattern. */
44 #define ROOT_FOLDER_PATTERN_KEY "RootFolderPattern" 51 #define ROOT_FOLDER_PATTERN_KEY "RootFolderPattern"
45 52
46 /**@def the default value for the root folder pattern */ 53 /**
54 * @brief the default value for the root folder pattern */
47 #define DEFAULT_ROOT_PATTERN "Datum_Fachnummr_Batch-Nr." 55 #define DEFAULT_ROOT_PATTERN "Datum_Fachnummr_Batch-Nr."
48 56
49 /**@def the config key for the last selected subfolder. */ 57 /**
58 * @brief the config key for the last selected subfolder. */
50 #define SUB_FOLDER_KEY "SubFolder" 59 #define SUB_FOLDER_KEY "SubFolder"
51 60
52 /**@def the config key for the sub folder info pattern. */ 61 /**
62 * @brief the config key for the sub folder info pattern. */
53 #define SUB_FOLDER_PATTERN_KEY "SubFolderPattern" 63 #define SUB_FOLDER_PATTERN_KEY "SubFolderPattern"
54 64
55 /**@def the default value for the sub folder pattern */ 65 /**
66 * @brief the default value for the sub folder pattern */
56 //#define SUB_FOLDER_PATTERN "IP-Addr_Nethz-Login" 67 //#define SUB_FOLDER_PATTERN "IP-Addr_Nethz-Login"
57 #define SUB_FOLDER_PATTERN "IP-Addr" 68 #define SUB_FOLDER_PATTERN "IP-Addr"
58 69
59 /**@def how to format a timestamp */ 70 /**
71 * @brief how to format a timestamp */
60 #define LONG_DATE_FORMAT "dd.MM.yyyy, hh:mm:ss.zzz" 72 #define LONG_DATE_FORMAT "dd.MM.yyyy, hh:mm:ss.zzz"
61 73
62 /**@def the config key for the replay speed */ 74 /**
75 * @brief the config key for the replay speed */
63 #define REPLAY_SPEED_KEY "Speed" 76 #define REPLAY_SPEED_KEY "Speed"
64 77
65 /**@def the default value for the replay speed in seconds */ 78 /**
79 * @brief the default value for the replay speed in seconds */
66 #define REPLAY_SPEED_DEFAULT 1. 80 #define REPLAY_SPEED_DEFAULT 1.
67 81
68 /**@def the value for a step in the speed slider */ 82 /**
83 * @brief the value for a step in the speed slider */
69 #define REPLAY_SPEED_STEP_MS 500 84 #define REPLAY_SPEED_STEP_MS 500
70 85
71 /**@def The seperator used in the patterns. */ 86 /**
87 * @brief The seperator used in the patterns. */
72 #define PATTERN_SEPERATOR "_" 88 #define PATTERN_SEPERATOR "_"
73 89
74 /**@def The default sort column */ 90 /**
91 * @brief The default sort column */
75 #define SORT_COLUMN_KEY "Sort" 92 #define SORT_COLUMN_KEY "Sort"
76 93
77 /**@def The default value for the sort column */ 94 /**
95 * @brief The default value for the sort column */
78 #define SORT_COLUMN_DEFAULT "Date" 96 #define SORT_COLUMN_DEFAULT "Date"
79 97
80 /**@def The default sort order (boolean) */ 98 /**
99 * @brief The default sort order (boolean) */
81 #define SORT_ORDER_KEY "SortAscending" 100 #define SORT_ORDER_KEY "SortAscending"
82 101
83 /**@def The default sort order value. */ 102 /**
103 * @brief The default sort order value. */
84 #define SORT_ORDER_VALUE true 104 #define SORT_ORDER_VALUE true
85 105
86 /**@def The column to use (counted from 0 and including index nr) for the filename */ 106 /**
107 * @brief The column to use (counted from 0 and including index nr) for the filename */
87 #define FILENAME_COLUMN_IDX 1 108 #define FILENAME_COLUMN_IDX 1
88 109
89 /**@def The column to use as the timestamp in the player window */ 110 /**
111 * @brief The column to use as the timestamp in the player window */
90 #define DATE_COLUMN_KEY "DisplayDate" 112 #define DATE_COLUMN_KEY "DisplayDate"
91 113
92 /**@def The default value for the timestamp column */ 114 /**
115 * @brief The default value for the timestamp column */
93 #define DATE_COLUMN_DEFAULT "Date" 116 #define DATE_COLUMN_DEFAULT "Date"
94 117
95 /**@def The fallback value in case the DisplayDate column can't be found */ 118 /**
119 * @brief The fallback value in case the DisplayDate column can't be found */
96 #define DATE_COLUMN_FALLBACK_IDX 2 120 #define DATE_COLUMN_FALLBACK_IDX 2
97 121
98 /**@def Setting to control wether or not the image can be detached. */ 122 /**
123 * @brief Setting to control wether or not the image can be detached. */
99 #define DETACHABLE_IMAGE_KEY "DetachableImage" 124 #define DETACHABLE_IMAGE_KEY "DetachableImage"
100 125
101 /**@def Default value for the detachable image. */ 126 /**
127 * @brief Default value for the detachable image. */
102 #define DETACHABLE_IMAGE_DEFAULT false 128 #define DETACHABLE_IMAGE_DEFAULT false
103 129
104 #endif // CONSTANTS_H 130 #endif // CONSTANTS_H
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)