summaryrefslogtreecommitdiff
path: root/inputmethods/dasher/DasherSettingsInterface.h
Unidiff
Diffstat (limited to 'inputmethods/dasher/DasherSettingsInterface.h') (more/less context) (ignore whitespace changes)
-rw-r--r--inputmethods/dasher/DasherSettingsInterface.h149
1 files changed, 149 insertions, 0 deletions
diff --git a/inputmethods/dasher/DasherSettingsInterface.h b/inputmethods/dasher/DasherSettingsInterface.h
new file mode 100644
index 0000000..9d03eba
--- a/dev/null
+++ b/inputmethods/dasher/DasherSettingsInterface.h
@@ -0,0 +1,149 @@
1// DasherSettingsInterface.h
2//
3/////////////////////////////////////////////////////////////////////////////
4//
5// Copyright (c) 2002 Iain Murray
6//
7/////////////////////////////////////////////////////////////////////////////
8
9
10#ifndef __DasherSettingsInterface_h__
11#define __DasherSettingsInterface_h__
12
13#include "DasherTypes.h"
14#include "SettingsStore.h"
15
16namespace Dasher {class CDasherSettingsInterface;}
17class Dasher::CDasherSettingsInterface
18{
19public:
20 void SettingsDefaults(CSettingsStore* Store);
21
22 // These actually affect the way Dasher works
23 //! Change the alphabet in use to NewAlphabetID
24 virtual void ChangeAlphabet(const std::string& NewAlphabetID) {};
25
26 //! Change the maximum bitrate (effectively the speed) of Dasher
27 virtual void ChangeMaxBitRate(double NewMaxBitRate) {};
28
29 //! Generate a new langage model. Not usually needed
30 virtual void ChangeLanguageModel(unsigned int NewLanguageModelID) {};
31
32 //! Generate a new view of the model. Call it with 0 when starting up
33 virtual void ChangeView(unsigned int NewViewID) {};
34
35 //! Change the orientation (l->r, r->l, so on) of the model
36 virtual void ChangeOrientation(Opts::ScreenOrientations Orientation) {};
37
38 //! Set the file encoding of output files to Encoding
39 virtual void SetFileEncoding(Opts::FileEncodingFormats Encoding) {};
40
41 //! Inform the core that the screen has this size
42 virtual void SetScreenSize(long Width, long Height) {};
43
44 //! Set the size of the font used in the Dasher canvas
45 virtual void SetDasherFontSize(Dasher::Opts::FontSize fontsize) {};
46
47 //! Set the number of dimensions of input (either 1 or 2)
48 virtual void SetDasherDimensions(bool Value) {};
49
50 // These are recommended options for the Dasher GUI. {{{ They don't actually
51 // change the way Dasher works. They are part of the Dasher interface
52 // anyway so that it can handle option saving for you, and to make it
53 // easy for the Dasher engine to control the GUI later on. }}}
54
55 //! True if toolbar should be shown, false otherwise
56 virtual void ShowToolbar(bool Value) {};
57
58 //! True if toolbar should show text, false otherwse
59 virtual void ShowToolbarText(bool Value) {};
60
61 //! True if toolbar should have large icons, false otherwise
62 virtual void ShowToolbarLargeIcons(bool Value) {};
63
64 //! True if the speed slider should be shown, false otherwise
65 virtual void ShowSpeedSlider(bool Value) {};
66
67 //! True if the window layout should be fixed, false otherwise
68 virtual void FixLayout(bool Value) {};
69
70 //! True if new files should be timestamped, false otherwise
71 virtual void TimeStampNewFiles(bool Value) {};
72
73 //! True if all text should be copied to clipboard when Dasher is stopped, false otherwise
74 virtual void CopyAllOnStop(bool Value) {};
75
76 //! True if a box should be drawn to represent the logical position of the mouse
77 virtual void DrawMouse(bool Value) {};
78
79 //! Set the editbox font
80 virtual void SetEditFont(std::string Name, long Size) {};
81
82 //! Set the canvas font
83 virtual void SetDasherFont(std::string Name) {};
84
85 //! Set the height of the edit box
86 virtual void SetEditHeight(long Value) {};
87
88 //! Should Dasher start and stop on space bar?
89 virtual void StartOnSpace(bool Value) {};
90
91 //! Should Dasher start and stop on left mouse button?
92 virtual void StartOnLeft(bool Value) {};
93
94 //! Should Dasher be keyboard controlled?
95 virtual void KeyControl(bool Value) {};
96
97 //! Should Dasher pause when the pointer leaves the window?
98 virtual void WindowPause(bool Value) {};
99};
100
101
102#include <string>
103
104namespace Dasher
105{
106namespace Keys
107{
108 // Standard Option strings. You are encouraged to use these constants.
109 // -------------------------------------------------------------------
110
111 // bool options
112 extern const std::string TIME_STAMP;
113 extern const std::string SHOW_TOOLBAR;
114 extern const std::string SHOW_TOOLBAR_TEXT;
115 extern const std::string SHOW_LARGE_ICONS;
116 extern const std::string FIX_LAYOUT;
117 extern const std::string SHOW_SLIDER;
118 extern const std::string COPY_ALL_ON_STOP;
119 extern const std::string DRAW_MOUSE;
120 extern const std::string START_SPACE;
121 extern const std::string START_MOUSE;
122 extern const std::string KEY_CONTROL;
123 extern const std::string WINDOW_PAUSE;
124 // long options
125 extern const std::string FILE_ENCODING;
126 extern const std::string MAX_BITRATE_TIMES100;
127 extern const std::string SCREEN_ORIENTATION;
128 extern const std::string VIEW_ID;
129 extern const std::string LANGUAGE_MODEL_ID;
130 extern const std::string EDIT_FONT_SIZE;
131 extern const std::string EDIT_HEIGHT;
132 extern const std::string SCREEN_WIDTH;
133 extern const std::string SCREEN_HEIGHT;
134 extern const std::string DASHER_FONTSIZE;
135 extern const std::string DASHER_DIMENSIONS;
136
137 // string options
138 extern const std::string ALPHABET_ID;
139 extern const std::string DASHER_FONT;
140 extern const std::string EDIT_FONT;
141}
142} // namespace Dasher
143
144
145#endif /* #ifndef __DasherSettingsInterface_h__ */
146
147
148
149