ScummVM API documentation
ui_edit.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 /*
23  * This file is based on WME Lite.
24  * http://dead-code.org/redir.php?target=wmelite
25  * Copyright (c) 2011 Jan Nedoma
26  */
27 
28 #ifndef WINTERMUTE_UIEDIT_H
29 #define WINTERMUTE_UIEDIT_H
30 
31 #include "engines/wintermute/persistent.h"
32 #include "engines/wintermute/ui/ui_object.h"
33 #include "common/events.h"
34 
35 namespace Wintermute {
36 class BaseFont;
37 class UIEdit : public UIObject {
38 public:
39  DECLARE_PERSISTENT(UIEdit, UIObject)
40 
41  int insertChars(int pos, const byte *chars, int num);
42  int deleteChars(int start, int end);
43 
44  bool display(int offsetX, int offsetY) override;
45  bool handleKeypress(Common::Event *event, bool printable = false) override;
46 
47  void setCursorChar(const char *character);
48 
49  UIEdit(BaseGame *inGame);
50  ~UIEdit() override;
51 
52  bool loadFile(const char *filename);
53  bool loadBuffer(char *buffer, bool complete = true);
54  bool saveAsText(BaseDynamicBuffer *buffer, int indent) override;
55 
56  // scripting interface
57  ScValue *scGetProperty(const Common::String &name) override;
58  bool scSetProperty(const char *name, ScValue *value) override;
59  bool scCallMethod(ScScript *script, ScStack *stack, ScStack *thisStack, const char *name) override;
60  const char *scToString() override;
61 private:
62  uint32 _cursorBlinkRate;
63  uint32 _lastBlinkTime;
64  int32 _selEnd;
65  int32 _selStart;
66  int32 _scrollOffset;
67  int32 _frameWidth;
68  BaseFont *_fontSelected;
69  int32 _maxLength;
70  bool _cursorVisible;
71  char *_cursorChar;
72 };
73 
74 } // End of namespace Wintermute
75 
76 #endif
Definition: script.h:44
Definition: base_game.h:76
Definition: script_value.h:42
Definition: str.h:59
Definition: ui_edit.h:37
Definition: base_dynamic_buffer.h:35
Definition: events.h:199
Definition: script_stack.h:41
Definition: base_font.h:37
Definition: achievements_tables.h:27
Definition: ui_object.h:39