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
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef GRAPHICS_MACGUI_MACWINDOWBORDER_H
#define GRAPHICS_MACGUI_MACWINDOWBORDER_H
#include "common/str.h"
#include "common/list.h"
#include "graphics/nine_patch.h"
#include "graphics/managed_surface.h"
#include "graphics/transparent_surface.h"
namespace Graphics {
/**
* A representation of a custom border, which allows for arbitrary border offsets
* and nine-patch resizable displays for both active and inactive states.
* However, the border offsets are the same for both active and inactive states.
*/
class MacWindowBorder {
public:
MacWindowBorder();
~MacWindowBorder();
/**
* Accessor to check whether or not a border is loaded.
* @param active State that we want to check. If true it checks for active border, if false it checks for inactive.
* @return True if the checked state has a border loaded, false otherwise.
*/
bool hasBorder(bool active);
/**
* Add the given surface as the display of the border in the active state.
* Will fail if there is already an active border.
* @param The surface that will be displayed.
*/
void addActiveBorder(TransparentSurface *source);
/**
* Add the given surface as the display of the border in the inactive state.
* Will fail if there is already an inactive border.
* @param The surface that will be displayed.
*/
void addInactiveBorder(TransparentSurface *source);
/**
* Accessor function for the custom offsets.
* @return True if custom offsets have been indicated (setOffsets has been called previously).
*/
bool hasOffsets();
/**
* Mutator method to indicate the custom border offsets.
* These should be set to the desired thickness of each side of the border.
* e.g. For a border that is 10 pixels wide and 5 pixels tall, the call should be:
* setOffsets(10, 10, 5, 5)
* Note that this function does not check whether those borders form
* a valid rect when combined with the window dimensions.
* @param left Thickness (in pixels) of the left side of the border.
* @param right Thickness (in pixels) of the right side of the border.
* @param top Thickness (in pixels) of the top side of the border.
* @param bottom Thickness (in pixels) of the bottom side of the border.
*/
void setOffsets(int left, int right, int top, int bottom);
void setOffsets(Common::Rect &rect);
/**
* Accessor method to retrieve a given border.
* Note that it does not check for validity, and thus if setOffsets
* was not called before it might return garbage.
* @param offset The identifier of the offset wanted.
* @return The desired offset in pixels.
*/
Common::Rect &getOffset();
/**
* Blit the desired border (active or inactive) into a destination surface.
* It automatically resizes the border to fit the given surface.
* @param destination The surface we want to blit into.
* @param active True if we want to blit the active border, false otherwise.
*/
void blitBorderInto(ManagedSurface &destination, bool active);
private:
NinePatchBitmap *_activeBorder;
NinePatchBitmap *_inactiveBorder;
bool _activeInitialized;
bool _inactiveInitialized;
Common::Rect _borderOffsets;
};
} // End of namespace Graphics
#endif
|
