Graphics::MacWindowBorder Class Reference

#include <macwindowborder.h>

Public Member Functions
bool	hasBorder (uint32 flags)
void	addBorder (ManagedSurface *source, uint32 flags, int titlePos=0)
bool	hasOffsets () const
void	setOffsets (int left, int right, int top, int bottom)
void	setOffsets (Common::Rect &rect)
void	setOffsets (const BorderOffsets &offsets)
BorderOffsets &	getOffset ()
const BorderOffsets &	getOffset () const
int	getMinWidth (uint32 flags) const
int	getMinHeight (uint32 flags) const
void	blitBorderInto (ManagedSurface &destination, uint32 flags)
void	setTitle (const Common::String &title, int width)
void	setScroll (int scrollPos, int scrollSize)
void	drawTitle (ManagedSurface *g, int titleOffset, int minWidth)
void	drawScrollBar (ManagedSurface *g)
void	setWindow (MacWindow *window)
void	setWindowManager (MacWindowManager *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)

Detailed Description

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.

Member Function Documentation

hasBorder()

bool Graphics::MacWindowBorder::hasBorder

(

uint32

flags

)

Accessor to check whether or not a border is loaded.

Parameters

check

whether the border type we want has been initialized.

Returns

True if the checked state has a border loaded, false otherwise.

addBorder()

void Graphics::MacWindowBorder::addBorder	(	ManagedSurface *	source,
		uint32	flags,
		int	titlePos = 0
	)

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.

Parameters

The	surface that will be displayed.
The	border type indicated by flag
The	title position of bmp image

hasOffsets()

bool Graphics::MacWindowBorder::hasOffsets

(

)

const

Accessor function for the custom offsets.

Returns

True if custom offsets have been indicated (setOffsets has been called previously).

setOffsets()

void Graphics::MacWindowBorder::setOffsets	(	int	left,
		int	right,
		int	top,
		int	bottom
	)

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.

Parameters

left	Thickness (in pixels) of the left side of the border.
right	Thickness (in pixels) of the right side of the border.
top	Thickness (in pixels) of the top side of the border.
bottom	Thickness (in pixels) of the bottom side of the border.

getOffset()

BorderOffsets& Graphics::MacWindowBorder::getOffset

(

)

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.

Parameters

offset

The identifier of the offset wanted.

Returns

The desired offset in pixels.

blitBorderInto()

void Graphics::MacWindowBorder::blitBorderInto	(	ManagedSurface &	destination,
		uint32	flags
	)

Blit the desired border (active or inactive) into a destination surface. It automatically resizes the border to fit the given surface.

Parameters

destination	The surface we want to blit into.
border	type that you want to draw
wm	The window manager.

---

The documentation for this class was generated from the following file:

• graphics/macgui/macwindowborder.h