xref: /haiku/src/kits/tracker/Settings.h (revision 1294543de9ac0eff000eaea1b18368c36435d08e)
1 /*
2 Open Tracker License
3 
4 Terms and Conditions
5 
6 Copyright (c) 1991-2000, Be Incorporated. All rights reserved.
7 
8 Permission is hereby granted, free of charge, to any person obtaining a copy of
9 this software and associated documentation files (the "Software"), to deal in
10 the Software without restriction, including without limitation the rights to
11 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
12 of the Software, and to permit persons to whom the Software is furnished to do
13 so, subject to the following conditions:
14 
15 The above copyright notice and this permission notice applies to all licensees
16 and shall be included in all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF TITLE, MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 BE INCORPORATED BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
22 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION
23 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 
25 Except as contained in this notice, the name of Be Incorporated shall not be
26 used in advertising or otherwise to promote the sale, use or other dealings in
27 this Software without prior written authorization from Be Incorporated.
28 
29 Tracker(TM), Be(R), BeOS(R), and BeIA(TM) are trademarks or registered trademarks
30 of Be Incorporated in the United States and other countries. Other brand product
31 names are registered trademarks or trademarks of their respective holders.
32 All rights reserved.
33 */
34 
35 #ifndef _SETTINGS_H_
36 #define _SETTINGS_H_
37 
38 #include <String.h>
39 #include "SettingsHandler.h"
40 
41 namespace BPrivate {
42 
43 extern Settings *settings;
44 
45 class StringValueSetting : public SettingsArgvDispatcher {
46 	// simple string setting
47 public:
48 	StringValueSetting(const char *name, const char *defaultValue,
49 		const char *valueExpectedErrorString,
50 		const char *wrongValueErrorString);
51 
52 	virtual ~StringValueSetting();
53 
54 	void ValueChanged(const char *newValue);
55 	const char *Value() const;
56 	virtual const char *Handle(const char *const *argv);
57 
58 protected:
59 	virtual void SaveSettingValue(Settings *);
60 	virtual bool NeedsSaving() const;
61 
62 	const char *fDefaultValue;
63 	const char *fValueExpectedErrorString;
64 	const char *fWrongValueErrorString;
65 	BString fValue;
66 };
67 
68 class EnumeratedStringValueSetting : public StringValueSetting {
69 	// string setting, values that do not match string enumeration
70 	// are rejected
71 public:
72 	EnumeratedStringValueSetting(const char *name, const char *defaultValue,
73 		const char *const *values, const char *valueExpectedErrorString,
74 		const char *wrongValueErrorString);
75 
76 	void ValueChanged(const char *newValue);
77 	virtual const char *Handle(const char *const *argv);
78 
79 protected:
80 	const char *const *fValues;
81 };
82 
83 class ScalarValueSetting : public SettingsArgvDispatcher {
84 	// simple int32 setting
85 public:
86 	ScalarValueSetting(const char *name, int32 defaultValue,
87 		const char *valueExpectedErrorString, const char *wrongValueErrorString,
88 		int32 min = LONG_MIN, int32 max = LONG_MAX);
89 
90 	void ValueChanged(int32 newValue);
91 	int32 Value() const;
92 	void GetValueAsString(char *) const;
93 	virtual const char *Handle(const char *const *argv);
94 
95 protected:
96 	virtual void SaveSettingValue(Settings *);
97 	virtual bool NeedsSaving() const;
98 
99 	int32 fDefaultValue;
100 	int32 fValue;
101 	int32 fMax;
102 	int32 fMin;
103 
104 	const char *fValueExpectedErrorString;
105 	const char *fWrongValueErrorString;
106 };
107 
108 class HexScalarValueSetting : public ScalarValueSetting {
109 	// hexadecimal int32 setting
110 public:
111 	HexScalarValueSetting(const char *name, int32 defaultValue,
112 		const char *valueExpectedErrorString, const char *wrongValueErrorString,
113 		int32 min = LONG_MIN, int32 max = LONG_MAX);
114 
115 	void GetValueAsString(char *buffer) const;
116 
117 protected:
118 	virtual void SaveSettingValue(Settings *settings);
119 };
120 
121 class BooleanValueSetting : public ScalarValueSetting {
122 	// on-off setting
123 public:
124 	BooleanValueSetting(const char *name, bool defaultValue);
125 
126 	bool Value() const;
127 	void SetValue(bool value);
128 	virtual const char *Handle(const char *const *argv);
129 
130 protected:
131 	virtual void SaveSettingValue(Settings *);
132 };
133 
134 }
135 
136 using namespace BPrivate;
137 
138 #endif	/* _SETTINGS_H_ */
139