File: macwindowborder.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (174 lines) | stat: -rw-r--r-- 5,551 bytes parent folder | download | duplicates (2)
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
/* 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef GRAPHICS_MACGUI_MACWINDOWBORDER_H
#define GRAPHICS_MACGUI_MACWINDOWBORDER_H

#include "common/str.h"
#include "common/list.h"

#include "graphics/managed_surface.h"
#include "graphics/primitives.h"

#include "image/bmp.h"

namespace Graphics {

class MacWindow;
class MacWindowManager;
class NinePatchBitmap;

enum {
	kWindowBorderActive    = 1 << 0,
	kWindowBorderTitle     = 1 << 1,
	kWindowBorderScrollbar = 1 << 2,

	kWindowBorderMaxFlag   = 1 << 3
};

enum {
	kBorderScroll = 1000
};

enum {
	kWinBorderWin95Scrollbar = kBorderScroll + 0x00,
	kWindowBorderWin95NoBorderScrollbar,
	kWindowBorderMacOSNoBorderScrollbar
};

struct BorderOffsets {
	int left;
	int right;
	int top;
	int bottom;
	int titleTop;
	int titleBottom;
	bool dark;
	int titlePos;
	int upperScrollHeight;
	int lowerScrollHeight;
};

/**
 * 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 check whether the border type we want has been initialized.
	 * @return True if the checked state has a border loaded, false otherwise.
	 */
	bool hasBorder(uint32 flags);

	/**
	 * Add the given surface as the display of the border in the state that is instructed by flag.
	 * Will fail if there is already a border.
	 * @param The surface that will be displayed.
	 * @param The border type indicated by flag
	 * @param The title position of bmp image
	 */
	void addBorder(ManagedSurface *source, uint32 flags, int titlePos = 0);

	/**
	 * Accessor function for the custom offsets.
	 * @return True if custom offsets have been indicated (setOffsets has been called previously).
	 */
	bool hasOffsets() const;

	/**
	 * 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);
	void setOffsets(const BorderOffsets &offsets);

	/**
	 * 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.
	 */
	BorderOffsets &getOffset();
	const BorderOffsets &getOffset() const;

	/**
	 * 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 border type that you want to draw
	 * @param wm The window manager.
	 */
	void blitBorderInto(ManagedSurface &destination, uint32 flags, MacWindowManager *wm);

	void setTitle(const Common::String& title, int width, MacWindowManager *wm);

	void setScroll(int scrollPos, int scrollSize) { _scrollPos = scrollPos, _scrollSize = scrollSize; }

	void drawTitle(ManagedSurface *g, MacWindowManager *wm, int titleOffset);

	void drawScrollBar(ManagedSurface *g, MacWindowManager *wm);

	// we should call this method as soon as the macwindowborder is constructed
	void setWindow(MacWindow *window) { _window = window; }

	void setBorderType(int type);

	void disableBorder();

	void loadBorder(Common::SeekableReadStream &file, uint32 flags, int lo = -1, int ro = -1, int to = -1, int bo = -1);
	void loadBorder(Common::SeekableReadStream &file, uint32 flags, BorderOffsets offsets);
	void loadInternalBorder(uint32 flags);

	void setBorder(Graphics::ManagedSurface *surface, uint32 flags, int lo = -1, int ro = -1, int to = -1, int bo = -1);
	void setBorder(Graphics::ManagedSurface *surface, uint32 flags, BorderOffsets offsets);
private:
	int _scrollPos, _scrollSize;
	Common::String _title;

	Common::Array<NinePatchBitmap *> _border;

	MacWindow *_window;

	BorderOffsets _borderOffsets;

	bool _useInternalBorder;

	int _borderType;
};

} // End of namespace Graphics
#endif