HandlerChain_MessageWindow.h File Reference

Declaration of the MessageWindow support functions, MessageWindow_Create(), MessageWindow_Destroy(), MessageWindow_ProcessMessage(), and MessageWindow_ToString(), as used in the HandlerChain Pattern. More...

#include <stdbool.h>
#include "HandlerChain_Message.h"

Include dependency graph for HandlerChain_MessageWindow.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	__HANDLERCHAIN_WINDOW_H__

Functions
int	MessageWindow_Create (const char *title, int x, int y, int w, int h)
	Create a MessageWindow object with the given properties and return the ID of the object.
void	MessageWindow_Destroy (int windowId)
	Destroy the MessageWindow object with the given ID. Removes the window from any message handling as well.
bool	MessageWindow_ProcessMessage (int windowId, Message *message)
	Pass a Message object to a window for processing.
bool	MessageWindow_ToString (int windowId, DynamicString *output)
	Convert the specified window to a string representation.

Detailed Description

Declaration of the MessageWindow support functions, MessageWindow_Create(), MessageWindow_Destroy(), MessageWindow_ProcessMessage(), and MessageWindow_ToString(), as used in the HandlerChain Pattern.

Definition in file HandlerChain_MessageWindow.h.

Macro Definition Documentation

__HANDLERCHAIN_WINDOW_H__

#define __HANDLERCHAIN_WINDOW_H__

Definition at line 10 of file HandlerChain_MessageWindow.h.

Function Documentation

MessageWindow_Create()

int MessageWindow_Create	(	const char *	title,
		int	x,
		int	y,
		int	w,
		int	h
	)

Create a MessageWindow object with the given properties and return the ID of the object.

Parameters

title	Title of the window.
x	Horizontal position of the upper left corner of the window.
y	Vertical position of the upper left corner of the window.
w	Width of the window.
h	Height of the window.

Returns

Returns the ID of the window, if successfully created; otherwise, returns false.

Definition at line 318 of file HandlerChain_MessageWindow.c.

References _AppendWindowToList(), _Window::_closeBox, _nextWindowId, _Window::_title, _Window::_windowBox, _Window::_windowId, CLOSE_HEIGHT, CLOSE_WIDTH, HandlerChain_AddWindow(), WindowRectangle::Right, WindowRectangle::Top, and WindowRectangle_Initialize().

Referenced by _HandlerChain_ConstructWindowChain().

MessageWindow_Destroy()

void MessageWindow_Destroy

(

int

windowId

)

Destroy the MessageWindow object with the given ID. Removes the window from any message handling as well.

Parameters

windowId

ID of the MessageWindow to destroy.

Definition at line 354 of file HandlerChain_MessageWindow.c.

References _FindWindow(), and _RemoveWindowFromList().

Referenced by _HandleDestroyMessage().

MessageWindow_ProcessMessage()

bool MessageWindow_ProcessMessage	(	int	windowId,
		Message *	message
	)

Pass a Message object to a window for processing.

Parameters

windowId	The ID of the window who will get the message.
message	The Message object to process.

Returns

Returns true if the message was handled and no further windows should be notified; otherwise return false to allow the message to be passed to subsequent windows.

Definition at line 367 of file HandlerChain_MessageWindow.c.

References _FindWindow(), _HandleButtonDownMessage(), _HandleButtonUpMessage(), _HandleCloseMessage(), _HandleDestroyMessage(), ButtonDown, ButtonUp, Close, Destroy, and Message::MessageType.

Referenced by HandlerChain_SendMessage().

MessageWindow_ToString()

bool MessageWindow_ToString	(	int	windowId,
		DynamicString *	output
	)

Convert the specified window to a string representation.

Parameters

windowId	ID of the window to convert.
output	A DynamicString that returns the string version of the window. Call DynamicString_Initialize() on this object before passing as an argument.

Returns

Returns true if the message window was converted to a string; otherwise, returns false, indicating an out of memory condition (or a NULL argument).

Definition at line 409 of file HandlerChain_MessageWindow.c.

References _FindWindow(), _Window::_selected, _Window::_title, _Window::_windowBox, _Window::_windowId, DynamicString_Append(), DynamicString_Clear(), formatstring(), DynamicString::string, and WindowRectangle_ToString().

Referenced by HandlerChain_ToString().