ScummVM API documentation
scalpel_fixed_text.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 #ifndef SHERLOCK_SCALPEL_FIXED_TEXT_H
23 #define SHERLOCK_SCALPEL_FIXED_TEXT_H
24 
25 #include "sherlock/fixed_text.h"
26 
27 namespace Sherlock {
28 
29 namespace Scalpel {
30 
31 enum FixedTextId {
32  // Game hotkeys
33  kFixedText_Game_Hotkeys = 0,
34  // Window buttons
35  kFixedText_Window_Exit,
36  kFixedText_Window_Up,
37  kFixedText_Window_Down,
38  // Inventory buttons
39  kFixedText_Inventory_Exit,
40  kFixedText_Inventory_Look,
41  kFixedText_Inventory_Use,
42  kFixedText_Inventory_Give,
43  // Journal text
44  kFixedText_Journal_WatsonsJournal,
45  kFixedText_Journal_Page,
46  // Journal buttons
47  kFixedText_Journal_Exit,
48  kFixedText_Journal_Back10,
49  kFixedText_Journal_Up,
50  kFixedText_Journal_Down,
51  kFixedText_Journal_Ahead10,
52  kFixedText_Journal_Search,
53  kFixedText_Journal_FirstPage,
54  kFixedText_Journal_LastPage,
55  kFixedText_Journal_PrintText,
56  // Journal search
57  kFixedText_JournalSearch_Exit,
58  kFixedText_JournalSearch_Backward,
59  kFixedText_JournalSearch_Forward,
60  kFixedText_JournalSearch_NotFound,
61  // Settings
62  kFixedText_Settings_Exit,
63  kFixedText_Settings_MusicOn,
64  kFixedText_Settings_MusicOff,
65  kFixedText_Settings_PortraitsOn,
66  kFixedText_Settings_PortraitsOff,
67  kFixedText_Settings_JoystickOff,
68  kFixedText_Settings_NewFontStyle,
69  kFixedText_Settings_SoundEffectsOn,
70  kFixedText_Settings_SoundEffectsOff,
71  kFixedText_Settings_WindowsSlide,
72  kFixedText_Settings_WindowsAppear,
73  kFixedText_Settings_CalibrateJoystick,
74  kFixedText_Settings_AutoHelpLeft,
75  kFixedText_Settings_AutoHelpRight,
76  kFixedText_Settings_VoicesOn,
77  kFixedText_Settings_VoicesOff,
78  kFixedText_Settings_FadeByPixel,
79  kFixedText_Settings_FadeDirectly,
80  kFixedText_Settings_KeyPadSlow,
81  kFixedText_Settings_KeyPadFast,
82  // Load/Save
83  kFixedText_LoadSave_Exit,
84  kFixedText_LoadSave_Load,
85  kFixedText_LoadSave_Save,
86  kFixedText_LoadSave_Up,
87  kFixedText_LoadSave_Down,
88  kFixedText_LoadSave_Quit,
89  // Quit Game
90  kFixedText_QuitGame_Question,
91  kFixedText_QuitGame_Yes,
92  kFixedText_QuitGame_No,
93  // Press key text
94  kFixedText_PressKey_ForMore,
95  kFixedText_PressKey_ToContinue,
96  // Initial inventory
97  kFixedText_InitInventory_Message,
98  kFixedText_InitInventory_HolmesCard,
99  kFixedText_InitInventory_Tickets,
100  kFixedText_InitInventory_CuffLink,
101  kFixedText_InitInventory_WireHook,
102  kFixedText_InitInventory_Note,
103  kFixedText_InitInventory_OpenWatch,
104  kFixedText_InitInventory_Paper,
105  kFixedText_InitInventory_Letter,
106  kFixedText_InitInventory_Tarot,
107  kFixedText_InitInventory_OrnateKey,
108  kFixedText_InitInventory_PawnTicket,
109  // SH1: User Interface
110  kFixedText_UserInterface_NoThankYou,
111  kFixedText_UserInterface_YouCantDoThat,
112  kFixedText_UserInterface_Done,
113  kFixedText_UserInterface_Use,
114  kFixedText_UserInterface_UseOn,
115  kFixedText_UserInterface_Give,
116  kFixedText_UserInterface_GiveTo,
117  // People names
118  kFixedText_People_SherlockHolmes,
119  kFixedText_People_DrWatson,
120  kFixedText_People_InspectorLestrade,
121  kFixedText_People_ConstableOBrien,
122  kFixedText_People_ConstableLewis,
123  kFixedText_People_SheilaParker,
124  kFixedText_People_HenryCarruthers,
125  kFixedText_People_Lesley,
126  kFixedText_People_AnUsher,
127  kFixedText_People_FredrickEpstein,
128  kFixedText_People_MrsWorthington,
129  kFixedText_People_TheCoach,
130  kFixedText_People_APlayer,
131  kFixedText_People_Tim,
132  kFixedText_People_JamesSanders,
133  kFixedText_People_Belle,
134  kFixedText_People_CleaningGirl,
135  kFixedText_People_Wiggins,
136  kFixedText_People_Paul,
137  kFixedText_People_TheBartender,
138  kFixedText_People_ADirtyDrunk,
139  kFixedText_People_AShoutingDrunk,
140  kFixedText_People_AStaggeringDrunk,
141  kFixedText_People_TheBouncer,
142  kFixedText_People_TheCoroner,
143  kFixedText_People_ReginaldSnipes,
144  kFixedText_People_GeorgeBlackwood,
145  kFixedText_People_Lars,
146  kFixedText_People_TheChemist,
147  kFixedText_People_InspectorGregson,
148  kFixedText_People_JacobFarthington,
149  kFixedText_People_Mycroft,
150  kFixedText_People_OldSherman,
151  kFixedText_People_Richard,
152  kFixedText_People_TheBarman,
153  kFixedText_People_ADandyPlayer,
154  kFixedText_People_ARoughlookingPlayer,
155  kFixedText_People_ASpectator,
156  kFixedText_People_RobertHunt,
157  kFixedText_People_Violet,
158  kFixedText_People_Pettigrew,
159  kFixedText_People_Augie,
160  kFixedText_People_AnnaCarroway,
161  kFixedText_People_AGuard,
162  kFixedText_People_AntonioCaruso,
163  kFixedText_People_TobyTheDog,
164  kFixedText_People_SimonKingsley,
165  kFixedText_People_Alfred,
166  kFixedText_People_LadyBrumwell,
167  kFixedText_People_MadameRosa,
168  kFixedText_People_JosephMoorehead,
169  kFixedText_People_MrsBeale,
170  kFixedText_People_Felix,
171  kFixedText_People_Hollingston,
172  kFixedText_People_ConstableCallaghan,
173  kFixedText_People_SergeantDuncan,
174  kFixedText_People_LordBrumwell,
175  kFixedText_People_NigelJaimeson,
176  kFixedText_People_Jonas,
177  kFixedText_People_ConstableDugan
178 };
179 
180 struct FixedTextActionEntry {
181  const char *const *fixedTextArray;
182  int fixedTextArrayCount;
183 };
184 
185 struct FixedTextLanguageEntry {
186  Common::Language language;
187  const char *const *fixedTextArray;
188  const FixedTextActionEntry *actionArray;
189 };
190 
191 class ScalpelFixedText: public FixedText {
192 private:
193  const FixedTextLanguageEntry *_curLanguageEntry;
194 public:
195  ScalpelFixedText(SherlockEngine *vm);
196  ~ScalpelFixedText() override {}
197 
201  const char *getText(int fixedTextId) override;
202 
206  const Common::String getActionMessage(FixedTextActionId actionId, int messageIndex) override;
207 };
208 
209 } // End of namespace Scalpel
210 
211 } // End of namespace Sherlock
212 
213 #endif
Sherlock::FixedText
Definition: fixed_text.h:74
Common::String
Definition: str.h:59
Sherlock
Definition: animation.h:29
Sherlock::Scalpel::FixedTextLanguageEntry
Definition: scalpel_fixed_text.h:185
Sherlock::SherlockEngine
Definition: sherlock.h:76
Sherlock::Scalpel::ScalpelFixedText
Definition: scalpel_fixed_text.h:191
Sherlock::Scalpel::FixedTextActionEntry
Definition: scalpel_fixed_text.h:180
Common::Language
Language
Definition: language.h:45