1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
// -----------------------------------------------------------------------------
// This file is part of Broken Sword 2.5
// Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsd�rfer
//
// Broken Sword 2.5 is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// Broken Sword 2.5 is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Broken Sword 2.5; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
// -----------------------------------------------------------------------------
/*
BS_Window
---------
Simples Fensterklasseninterface.
Ist nur aus Gr�nden der Portabilit�t in einer Klasse gekapselt.
TODO: F�r andere Betriebssysteme implementieren
Autor: Malte Thiesen
*/
#ifndef SWORD25_WINDOW_H
#define SWORD25_WINDOW_H
// Includes
#include "sword25/kernel/common.h"
// Klassendefinition
/**
@brief Ein Simples Fensterklasseninterface.
Fenster werden ausschlie�lich mit BS_Window::CreateBSWindow() erstellt. BS_Window w�hlt
dann selbst�ndig die richtige Klasse f�r das Betriebssystem aus.
*/
class BS_Window
{
protected:
bool _InitSuccess;
bool _CloseWanted;
public:
virtual ~BS_Window(){};
/**
@brief Gibt den Sichtbarkeitsstatus des Fensters zur�ck
@return Gibt true zur�ck wenn das Fenster sichtbar ist, andernfalls false
*/
virtual bool IsVisible() = 0;
/**
@brief Setzt den Sichtbarkeitsstatus des Fensters
@param Visible gibt an, ob das Fenster sichtbar oder versteckt sein soll
*/
virtual void SetVisible(bool Visible) = 0;
/**
@brief Gibt die Position des Fensters auf der X-Achse zur�ck
@return Gibt die Position des Fensters auf der X-Achse zur�ck
*/
virtual int GetX() = 0;
/**
@brief Setzt die Position des Fensters auf der X-Achse
@param X die X-Position des Fensters oder -1 f�r zentrierte Ausrichtung auf der X-Achse
*/
virtual void SetX(int X) = 0;
/**
@brief Gibt die Position des Fensters auf der Y-Achse zur�ck
@return Gibt die Position des Fensters auf der Y-Achse zur�ck
*/
virtual int GetY() = 0;
/**
@brief Setzt die Position des Fensters auf der Y-Achse
@param Y die Y-Position des Fensters oder -1 f�r zentrierte Ausrichtung auf der Y-Achse
*/
virtual void SetY(int X) = 0;
/**
@brief Gibt die Position des Fensterinhaltes auf der X-Achse zur�ck
@return Gibt die Position des Fensterinhaltes auf der X-Achse zur�ck
*/
virtual int GetClientX() = 0;
/**
@brief Gibt die Position des Fensterinhaltes auf der Y-Achse zur�ck
@return Gibt die Position des Fensterinhaltes auf der Y-Achse zur�ck
*/
virtual int GetClientY() = 0;
/**
@brief Gibt die Breite des Fensters ohne Rahmen zur�ck
@return Gibt die Breite des Fensters ohne Rahmen zur�ck
*/
virtual int GetWidth() = 0;
/**
@brief Setzt die Breite des Fensters ohne Rahmen
@param Width die Breite des Fensters ohne Rahmen
*/
virtual void SetWidth(int Width) = 0;
/**
@brief Gibt die H�he des Fensters ohne Rahmen und Kopfzeile zur�ck
@return Gibt die H�he des Fensters ohne Rahmen und Kopfzeile zur�ck
*/
virtual int GetHeight() = 0;
/**
@brief Setzt die H�he des Fensters ohne Rahmen und Kopfzeile
@param Height die H�he des Fensters ohne Rahmen und Kopfzeile
*/
virtual void SetHeight(int Height) = 0;
/**
@brief Gibt den Titel der Fensters zur�ck
@return Gibt den Titel des Fenster zur�ck
*/
virtual std::string GetTitle() = 0;
/**
@brief Setzt den Titel des Fensters
@param Title der neue Titel des Fensters
*/
virtual void SetTitle(std::string Title) = 0;
/**
@brief Arbeitet die Windowmessages des Fensters ab.
Diese Methode sollte w�hrend des Main-Loops aufgerufen werden.
@return Gibt false zur�ck, falls das Fenster geschlossen wurde.
*/
virtual bool ProcessMessages() = 0;
/**
@brief Pausiert die Applikation bis das Fenster wieder den Focus hat oder geschlossen wurde.
@return Gibt false zur�ck, falls das Fenster geschlossen wurde.
*/
virtual bool WaitForFocus() = 0;
/**
@brief Gibt zur�ck, ob das Fenster den Focus hat.
@return Gibt true zur�ck, wenn das Fenster den Focus hat, ansonsten false
*/
virtual bool HasFocus() = 0;
/**
@brief Gibt das Windowhandle, des Systems zur�ck.
@return Das Windowhandle des Fensters
@remark Wenn das Windowshandle benutzt wird, sind die entsprechenden Codeteile
nat�rlich nicht mehr portable.
*/
virtual unsigned int GetWindowHandle() = 0;
/**
@brief Setzt den R�ckgabewert f�r den n�chsten Aufruf von CloseWanted. Sollte vom
Fenster selbst verwendet werden, wenn es geschlossen werden m�chte. Dieser
Mechanismus erlaubt den Scripten abzufragen, wann das Hauptfenster geschlossen
werden soll, und sich entsprechend zu beenden, bzw. beim Nutzer nachzufragen.
**/
void SetCloseWanted(bool Wanted);
/**
@brief Gibt einmal den Wert des letztes Aufrufs von SetCloseWanted zur�ck,
und danach sofort wieder false, solange bis mit SetCloseWanted wieder
ein neuer Wert gesetzt wird.
**/
bool CloseWanted();
/**
@brief Erstellt eine neue Fensterinstanz.
@param X die X-Position des Fensters oder -1 f�r zentrierte Ausrichtung auf der X-Achse
@param Y des Y-Position des Fensters oder -1 f�r zentrierte Ausrichtung auf der Y-Achsen
@param Width die Breite des Fensters ohne Rahmen
@param Height die H�he des Fensters ohne Rahmen und Kopfzeile
@param Visible gibt an, ob das Fenster dargestellt werden soll
@return Gibt einen Pointer auf ein Fensterobjekt zur�ck, oder NULL wenn das Erstellen
fehlgeschlagen ist.
@remark Das Fenster muss nach Benutzung mit delete freigegeben werden!
*/
static BS_Window* CreateBSWindow(int X, int Y, int Width, int Height, bool Visible);
};
#endif
|
