summaryrefslogtreecommitdiffstats
path: root/kpilot/kpilotConfig.h
blob: a3e3508aacf9d8929bd12cf5a6a85f337890f05a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
#ifndef _KPILOT_KPILOTCONFIG_H
#define _KPILOT_KPILOTCONFIG_H
/* kpilotConfig.h			KPilot
**
** Copyright (C) 1998-2001 by Dan Pilone
** Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
**
** This class concentrates all the configuration
** information for the various parts of KPilot.
*/

/*
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program in a file called COPYING; if not, write to
** the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
** MA 02110-1301, USA.
*/

/*
** Bug reports and questions can be sent to kde-pim@kde.org
*/


#include "kpilotSettings.h"

class TDECmdLineArgs;


class KPilotConfig
{
public:
	typedef enum
	{
		Cancel=0,
		Normal,
		ConfigureKPilot,
		ConfigureConduits,
		ConfigureAndContinue,
		WizardAndContinue
	} RunMode;

	/**
	 * @return TQString of default path for the BackupDB files
	 * are located
	 */
	static TQString getDefaultDBPath();


	// Conduit configuration information
	static void addDirtyDatabase(TQString db);
	static void addAppBlockChangedDatabase(TQString db);
	static void addFlagsChangedDatabase(TQString db);

	/**
	* This number can be changed every time a new
	* KPilot version is released that absolutely requires
	* the user to take a look at the configuration of
	* KPilot.
	*/
	static const uint ConfigurationVersion;

	/**
	* Reads the configuration version from a configuration file.
	* TODO: Make this use the *standard* location.
	*/
	static int getConfigVersion();

	/**
	* Write the current configuration version to the standard
	* location. @em Only call this after the TDEApplication object
	* is created, or crashes will result.
	*/
	static void updateConfigVersion();

	/**
	* Warn the user that the config file is outdated.
	* versionDetails() returns a descriptive string. Pass in the
	*     actual version of the config file. Set @p run to true to add an
	*     admonition to run kpilot in config mode to fix this.
	* sorryVersionOutdated() uses KMessageBox to display it.
	*/
	static TQString versionDetails(int fileversion, bool run);
	static void sorryVersionOutdated(int fileversion);
	/**
	* Update the config file as best we can, and inform the user.
	* Returns a suggested run mode if it's ok (ie. update finished, or
	* file was already up-to-date) and Cancel if the user cancels.
	* If the user cancels, it's probably best to _not_ continue with
	* anything, since the config is bogus.
	*
	* The suggested run mode might be anything - usually normal,
	* but might return ConfigureAndContinue as well.
	*
	* This function can call functions to update from different versions
	* to current; these are static in kpilotConfig.cc.
	*/
	static RunMode interactiveUpdate();

	/**
	* Deal with --debug options.
	* @ret resulting debug level
	*/
	static int getDebugLevel(TDECmdLineArgs *p);

	/**
	* Returns the user's preference for the system-wide
	* fixed font.
	*/
	static const TQFont& fixed() ;

	static void sync();
} ;



#endif