src/kits/tracker/Settings.h

   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 #ifndef _SETTINGS_H
  35 #define _SETTINGS_H
  36
  37
  38 #include <String.h>
  39 #include "SettingsHandler.h"
  40
  41
  42 namespace BPrivate {
  43
  44 extern Settings* settings;
  45
  46 class StringValueSetting : public SettingsArgvDispatcher {
  47         // simple string setting
  48 public:
  49         StringValueSetting(const char* name, const char* defaultValue,
  50                 const char* valueExpectedErrorString,
  51                 const char* wrongValueErrorString);
  52
  53         virtual ~StringValueSetting();
  54
  55         void ValueChanged(const char* newValue);
  56         const char* Value() const;
  57         virtual const char* Handle(const char* const *argv);
  58
  59 protected:
  60         virtual void SaveSettingValue(Settings*);
  61         virtual bool NeedsSaving() const;
  62
  63         const char* fDefaultValue;
  64         const char* fValueExpectedErrorString;
  65         const char* fWrongValueErrorString;
  66         BString fValue;
  67 };
  68
  69 class EnumeratedStringValueSetting : public StringValueSetting {
  70         // string setting, values that do not match string enumeration
  71         // are rejected
  72 public:
  73         EnumeratedStringValueSetting(const char* name, const char* defaultValue,
  74                 const char* const* values, const char* valueExpectedErrorString,
  75                 const char* wrongValueErrorString);
  76
  77         void ValueChanged(const char* newValue);
  78         virtual const char* Handle(const char* const *argv);
  79
  80 protected:
  81         const char* const* fValues;
  82 };
  83
  84 class ScalarValueSetting : public SettingsArgvDispatcher {
  85         // simple int32 setting
  86 public:
  87         ScalarValueSetting(const char* name, int32 defaultValue,
  88                 const char* valueExpectedErrorString,
  89                 const char* wrongValueErrorString, int32 min = INT32_MIN,
  90                 int32 max = INT32_MAX);
  91
  92         void ValueChanged(int32 newValue);
  93         int32 Value() const;
  94         void GetValueAsString(char*) const;
  95         virtual const char* Handle(const char* const *argv);
  96
  97 protected:
  98         virtual void SaveSettingValue(Settings*);
  99         virtual bool NeedsSaving() const;
 100
 101         int32 fDefaultValue;
 102         int32 fValue;
 103         int32 fMax;
 104         int32 fMin;
 105
 106         const char* fValueExpectedErrorString;
 107         const char* fWrongValueErrorString;
 108 };
 109
 110 class HexScalarValueSetting : public ScalarValueSetting {
 111         // hexadecimal int32 setting
 112 public:
 113         HexScalarValueSetting(const char* name, int32 defaultValue,
 114                 const char* valueExpectedErrorString,
 115                 const char* wrongValueErrorString, int32 min = INT32_MIN,
 116                 int32 max = INT32_MAX);
 117
 118         void GetValueAsString(char* buffer) const;
 119
 120 protected:
 121         virtual void SaveSettingValue(Settings* settings);
 122 };
 123
 124 class BooleanValueSetting : public ScalarValueSetting {
 125         // on-off setting
 126 public:
 127         BooleanValueSetting(const char* name, bool defaultValue);
 128
 129         bool Value() const;
 130         void SetValue(bool value);
 131         virtual const char* Handle(const char* const *argv);
 132
 133 protected:
 134         virtual void SaveSettingValue(Settings*);
 135 };
 136
 137 }
 138
 139 using namespace BPrivate;
 140
 141
 142 #endif  // _SETTINGS_H