Mercurial > retraceit
view src/constants.h @ 41:ae8e859de68e
Clarify some comments about constants
author | Andre Heinecke <andre.heinecke@intevation.de> |
---|---|
date | Wed, 06 May 2015 18:18:26 +0200 |
parents | 0c05958d254c |
children | 73e6b6b12412 |
line wrap: on
line source
#ifndef CONSTANTS_H #define CONSTANTS_H /* Copyright (C) 2015 by ETH Zürich * Software engineering by Intevation GmbH * * This file is Free Software under the GNU GPL (v>=2) * and comes with ABSOLUTELY NO WARRANTY! * See LICENSE.txt for details. */ /** @file Common definitions for this project. * * This file can be included to pull in common * definitions in the application. */ /**@def The version of the software package. * * Usually defined as Build parameter. */ #ifndef VERSION #define VERSION "0.0.1" #endif /**@def The user visible application name. * * Usually defined as Build parameter. **/ #ifndef APPNAME #define APPNAME "unknown" #endif /**@def Short command line description. */ #define DESCRIPTION "A tool to replay recorded user sessions." /**@def Short copyright notice to show users. */ #define COPYRIGHT "Copyright (C) 2015 ETH Zürich \n\n" \ "This file is Free Software under the GNU GPL (v>=2)\n" \ "and comes with ABSOLUTELY NO WARRANTY!\n" /**@def the config key for the last selected root folder. */ #define ROOT_FOLDER_KEY "RootFolder" /**@def the config key for the root folder info pattern. */ #define ROOT_FOLDER_PATTERN_KEY "RootFolderPattern" /**@def the default value for the root folder pattern */ #define DEFAULT_ROOT_PATTERN "Datum_Fachnummr_Batch-Nr." /**@def the config key for the last selected subfolder. */ #define SUB_FOLDER_KEY "SubFolder" /**@def the config key for the sub folder info pattern. */ #define SUB_FOLDER_PATTERN_KEY "SubFolderPattern" /**@def the default value for the sub folder pattern */ //#define SUB_FOLDER_PATTERN "IP-Addr_Nethz-Login" #define SUB_FOLDER_PATTERN "IP-Addr" /**@def how to format a timestamp */ #define LONG_DATE_FORMAT "dd.MM.yyyy, hh:mm:ss.zzz" /**@def the config key for the replay speed */ #define REPLAY_SPEED_KEY "Speed" /**@def the default value for the replay speed in seconds */ #define REPLAY_SPEED_DEFAULT 1. /**@def the value for a step in the speed slider */ #define REPLAY_SPEED_STEP_MS 500 /**@def The seperator used in the patterns. */ #define PATTERN_SEPERATOR "_" /**@def The default sort column */ #define SORT_COLUMN_KEY "Sort" /**@def The default value for the sort column */ #define SORT_COLUMN_DEFAULT "Date" /**@def The default sort order (boolean) */ #define SORT_ORDER_KEY "SortAscending" /**@def The default sort order value. */ #define SORT_ORDER_VALUE true /**@def The column to use (counted from 0 and including index nr) for the filename */ #define FILENAME_COLUMN 1 /**@def The column to use as the date */ #define DATE_COLUMN 2 #endif // CONSTANTS_H