Initial commit

graphics/macgui/macwindowborder.h

@@ -0,0 +1,184 @@
+/* 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 closeButtonTop;
+	int closeButtonLeft;
+	int closeButtonWidth;
+	int resizeButtonTop;
+	int resizeButtonHeight;
+	int upperScrollHeight;
+	int lowerScrollHeight;
+	int titlePadding;
+};
+
+/**
+ * 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;
+
+	int getMinWidth(uint32 flags) const;
+	int getMinHeight(uint32 flags) 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);
+
+	void setTitle(const Common::String& title, int width);
+
+	void setScroll(int scrollPos, int scrollSize) { _scrollPos = scrollPos, _scrollSize = scrollSize; }
+
+	void drawTitle(ManagedSurface *g, int titleOffset, int minWidth);
+
+	void drawScrollBar(ManagedSurface *g);
+
+	// we should call this method as soon as the macwindowborder is constructed
+	void setWindow(MacWindow *window) { _window = window; }
+	void setWindowManager(MacWindowManager *wm) { _wm = wm; }
+
+	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, const 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, const BorderOffsets &offsets);
+private:
+	int _scrollPos, _scrollSize;
+	Common::String _title;
+
+	Common::Array<NinePatchBitmap *> _border;
+
+	MacWindow *_window;
+	MacWindowManager *_wm;
+	BorderOffsets _borderOffsets;
+
+	bool _useInternalBorder;
+
+	int _borderType;
+};
+
+} // End of namespace Graphics
+#endif