This class is the base class for all windows. More...

#include <Window.h>

Inheritance diagram for Ocean::Platform::Win::Window:

Public Types
enum	MouseButton { BUTTON_NONE = 0 , BUTTON_LEFT = 1 , BUTTON_MIDDLE = 2 , BUTTON_RIGHT = 4 }
	Definition of several mouse buttons. More...

using	Files = std::vector< std::wstring >
	Definition of a vector holding files.

Public Member Functions
virtual bool	initialize (const HICON icon=nullptr, const std::string &windowClass="window")
	Initializes the window.

bool	initialize (const HINSTANCE applicationInstance, const int iconId, const std::string &windowClass="window")
	Initializes the window.

virtual void	show ()
	Shows the window.

virtual void	hide ()
	Hides the window.

virtual void	update ()
	Updates the window.

virtual void	repaint (const bool eraseBackground=false)
	Repaints the window.

bool	move (const int x, const int y)
	Moves the window.

bool	resize (const unsigned int width, const unsigned int height)
	Resizes the window.

HINSTANCE	applicationInstance () const
	Returns the application instance the window belongs to.

const std::wstring &	name () const
	Returns the name of this window.

HWND	handle () const
	Returns the handle of this window.

HWND	parentHandle () const
	Returns the handle of a possible parent window.

HDC	dc () const
	Returns the device context of this window.

unsigned int	width () const
	Returns the width of the entire window.

unsigned int	height () const
	Returns the height of the window.

unsigned int	clientWidth () const
	Returns the width of the client window.

unsigned int	clientHeight () const
	Returns the height of the client window.

bool	setParent (const HWND parent)
	Sets the parent window handle.

void	setText (const std::wstring &text)
	Sets or changes the text of this windows.

void	setEnableDropAndDrop (const bool state=true)
	Enables or disables drag&drop support for files.

Protected Types
using	ClassMap = std::unordered_map< std::wstring, unsigned int >
	Map mapping class names to an reference counter.

Protected Member Functions
	Window (HINSTANCE applicationInstance, const std::wstring &name, const HWND parent=nullptr, const bool isChild=false)
	Creates a new window.

virtual	~Window ()
	Destructs a window.

virtual bool	registerWindowClass (const HICON icon=nullptr)
	Registers a new windows class for the application window.

virtual bool	createWindow ()
	Creates the window itself using the registered window class.

virtual void	modifyWindowClass (WNDCLASSW &windowClass)
	Allows the modification of the window class before registration.

virtual void	modifyWindowStyle (DWORD &windowStyle, int &windowLeft, int &windowTop, int &windowWidth, int &windowHeight)
	Allows the modification of the window style before creation.

virtual void	onInitialized ()
	Event function if the windows has been initialized successfully.

virtual void	onActivate (const bool active)
	Event function for an activate event.

virtual void	onPaint ()
	Event function to repaint the window.

virtual void	onIdle ()
	Function called by the windows message loop if the process is idling.

virtual void	onShow (const bool visible)
	Function for a show event.

virtual void	onDestroy ()
	Function for a destroy event.

virtual void	onResize (const unsigned int clientWidth, const unsigned int clientHeight)
	Function for window resize event.

virtual void	onKeyDown (const int key)
	Function for keyboard button down events.

virtual void	onMouseDoubleClick (const MouseButton button, const int x, const int y)
	Function for mouse double click events.

virtual void	onMouseDown (const MouseButton button, const int x, const int y)
	Function for mouse button down events.

virtual void	onMouseMove (const MouseButton buttons, const int x, const int y)
	Function for mouse move event.

virtual void	onKeyUp (const int key)
	Function for keyboard button up events.

virtual void	onMouseUp (const MouseButton button, const int x, const int y)
	Function for mouse button up events.

virtual void	onMouseWheel (const MouseButton buttons, const int wheel, const int x, const int y)
	Functions for mouse wheel events.

virtual void	onMinimize ()
	Functions for window minimize event.

virtual void	onDragAndDrop (const Files &files)
	Event functions for drag&drop events for files.

Static Protected Member Functions
static LRESULT CALLBACK	windowProc (HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
	Window message / event procedure.

static ClassMap &	classMap ()
	Returns the class map for all windows.

static Lock &	classMapLock ()
	Returns the lock of the window class map.

Protected Attributes
HWND	parentHandle_ = nullptr
	Window handle of a possible parent window, making this window to a child window.

std::wstring	className_
	Window class name.

HINSTANCE	applicationInstance_ = nullptr
	Application instance.

std::wstring	name_
	Name of the window.

HWND	handle_ = nullptr
	Window handle.

HDC	dc_ = nullptr
	Window device context.

bool	isChild_ = false
	True, if the window is a child window.

Detailed Description

This class is the base class for all windows.

Member Typedef Documentation

◆ ClassMap

using Ocean::Platform::Win::Window::ClassMap = std::unordered_map<std::wstring, unsigned int>

protected

Map mapping class names to an reference counter.

◆ Files

using Ocean::Platform::Win::Window::Files = std::vector<std::wstring>

Definition of a vector holding files.

Member Enumeration Documentation

◆ MouseButton

enum Ocean::Platform::Win::Window::MouseButton

Definition of several mouse buttons.

Enumerator
BUTTON_NONE	No mouse button.
BUTTON_LEFT	Left mouse button.
BUTTON_MIDDLE	Middle mouse button.
BUTTON_RIGHT	Right mouse button.

Constructor & Destructor Documentation

◆ Window()

Ocean::Platform::Win::Window::Window	(	HINSTANCE	applicationInstance,
		const std::wstring &	name,
		const HWND	parent = `nullptr`,
		const bool	isChild = `false`
	)

protected

Creates a new window.

Beware: If a derived window class will use a different window class as the default one you have to change the window class name in the constructor.

Parameters

applicationInstance	The instance of the application, must be valid
name	The name of the application window
parent	Possible parent window making this window to a child window
isChild	True, if the window is intended to be a child window

◆ ~Window()

virtual Ocean::Platform::Win::Window::~Window ( )

protectedvirtual

Destructs a window.

Member Function Documentation

◆ applicationInstance()

HINSTANCE Ocean::Platform::Win::Window::applicationInstance ( ) const

inline

Returns the application instance the window belongs to.

Returns: Application instance

◆ classMap()

static ClassMap & Ocean::Platform::Win::Window::classMap ( )

staticprotected

Returns the class map for all windows.

Returns: The window class map

◆ classMapLock()

static Lock & Ocean::Platform::Win::Window::classMapLock ( )

staticprotected

Returns the lock of the window class map.

Returns: The window class map's lock

◆ clientHeight()

unsigned int Ocean::Platform::Win::Window::clientHeight ( ) const

Returns the height of the client window.

Returns: Height in pixel

◆ clientWidth()

unsigned int Ocean::Platform::Win::Window::clientWidth ( ) const

Returns the width of the client window.

Returns: Width in pixel

◆ createWindow()

virtual bool Ocean::Platform::Win::Window::createWindow ( )

protectedvirtual

Creates the window itself using the registered window class.

Returns: True, if succeeded

Reimplemented in Ocean::Platform::Win::TextWindow.

◆ dc()

HDC Ocean::Platform::Win::Window::dc ( ) const

inline

Returns the device context of this window.

Returns: Device context

◆ handle()

HWND Ocean::Platform::Win::Window::handle ( ) const

inline

Returns the handle of this window.

Returns: Window handle

◆ height()

unsigned int Ocean::Platform::Win::Window::height ( ) const

Returns the height of the window.

Returns: Height in pixel

◆ hide()

virtual void Ocean::Platform::Win::Window::hide ( )

virtual

Hides the window.

◆ initialize() [1/2]

virtual bool Ocean::Platform::Win::Window::initialize	(	const HICON	icon = `nullptr`,
		const std::string &	windowClass = `"window"`
	)

virtual

Initializes the window.

Parameters

icon	The optional handle of the icon to be used, nullptr to use default icon
windowClass	The name of the window class

Returns: True, if succeeded

◆ initialize() [2/2]

bool Ocean::Platform::Win::Window::initialize	(	const HINSTANCE	applicationInstance,
		const int	iconId,
		const std::string &	windowClass = `"window"`
	)

inline

Initializes the window.

Parameters

applicationInstance	The instance of the application, must be valid
iconId	The id of the icon as specified in the resources, with range [0, infinity)
windowClass	The name of the window class

Returns: True, if succeeded

◆ modifyWindowClass()

virtual void Ocean::Platform::Win::Window::modifyWindowClass ( WNDCLASSW & windowClass )

protectedvirtual

Allows the modification of the window class before registration.

Overload this function to change the window type.
However do not change the class name.

Parameters

windowClass Window class to modify

Reimplemented in Ocean::Platform::Win::BitmapWindow.

◆ modifyWindowStyle()

virtual void Ocean::Platform::Win::Window::modifyWindowStyle	(	DWORD &	windowStyle,
		int &	windowLeft,
		int &	windowTop,
		int &	windowWidth,
		int &	windowHeight
	)

protectedvirtual

Allows the modification of the window style before creation.

Overload this function to change the window style.

Parameters

windowStyle	Window style to modify
windowLeft	Left position of the window
windowTop	Top position of the window
windowWidth	Width of the window
windowHeight	Height of the window

◆ move()

bool Ocean::Platform::Win::Window::move	(	const int	x,
		const int	y
	)

Moves the window.

Parameters

x	The new horizontal position
y	The new vertical position

◆ name()

const std::wstring & Ocean::Platform::Win::Window::name ( ) const

inline

Returns the name of this window.

Returns: Window name

◆ onActivate()

virtual void Ocean::Platform::Win::Window::onActivate ( const bool active )

protectedvirtual

Event function for an activate event.

Parameters

active True, if the window is activated, false if the window is inactivated

◆ onDestroy()

virtual void Ocean::Platform::Win::Window::onDestroy ( )

protectedvirtual

Function for a destroy event.

Reimplemented in Ocean::Platform::Win::ApplicationWindow.

◆ onDragAndDrop()

virtual void Ocean::Platform::Win::Window::onDragAndDrop ( const Files & files )

protectedvirtual

Event functions for drag&drop events for files.

Parameters

files The files which have been dropped

See also: setEnableDropAndDrop().

◆ onIdle()

virtual void Ocean::Platform::Win::Window::onIdle ( )

protectedvirtual

Function called by the windows message loop if the process is idling.

◆ onInitialized()

virtual void Ocean::Platform::Win::Window::onInitialized ( )

protectedvirtual

Event function if the windows has been initialized successfully.

Reimplemented in Ocean::Platform::GL::Win::WindowContext.

◆ onKeyDown()

virtual void Ocean::Platform::Win::Window::onKeyDown ( const int key )

protectedvirtual

Function for keyboard button down events.

Parameters

key	Specifies the key button

◆ onKeyUp()

virtual void Ocean::Platform::Win::Window::onKeyUp ( const int key )

protectedvirtual

Function for keyboard button up events.

Parameters

key	Specifies the key button

◆ onMinimize()

virtual void Ocean::Platform::Win::Window::onMinimize ( )

protectedvirtual

Functions for window minimize event.

◆ onMouseDoubleClick()

virtual void Ocean::Platform::Win::Window::onMouseDoubleClick	(	const MouseButton	button,
		const int	x,
		const int	y
	)

protectedvirtual

Function for mouse double click events.

Parameters

button	Specifies the mouse button
x	Specifies the x position of the cursor
y	Specifies the y position of the cursor

Reimplemented in Ocean::Platform::Win::BitmapWindow.

◆ onMouseDown()

virtual void Ocean::Platform::Win::Window::onMouseDown	(	const MouseButton	button,
		const int	x,
		const int	y
	)

protectedvirtual

Function for mouse button down events.

Parameters

button	Specifies the mouse button
x	Specifies the x position of the cursor
y	Specifies the y position of the cursor

◆ onMouseMove()

virtual void Ocean::Platform::Win::Window::onMouseMove	(	const MouseButton	buttons,
		const int	x,
		const int	y
	)

protectedvirtual

Function for mouse move event.

Parameters

buttons	Holds all pushed mouse buttons
x	Specifies the x position of the cursor
y	Specifies the y position of the cursor

◆ onMouseUp()

virtual void Ocean::Platform::Win::Window::onMouseUp	(	const MouseButton	button,
		const int	x,
		const int	y
	)

protectedvirtual

Function for mouse button up events.

Parameters

button	Specifies the mouse button
x	Specifies the x position of the cursor
y	Specifies the y position of the cursor

◆ onMouseWheel()

virtual void Ocean::Platform::Win::Window::onMouseWheel	(	const MouseButton	buttons,
		const int	wheel,
		const int	x,
		const int	y
	)

protectedvirtual

Functions for mouse wheel events.

Parameters

buttons	Holds all pushed mouse buttons
wheel	Specifies the wheel delta value
x	Specifies the x position of the cursor
y	Specifies the y position of the cursor

◆ onPaint()

virtual void Ocean::Platform::Win::Window::onPaint ( )

protectedvirtual

Event function to repaint the window.

Reimplemented in Ocean::Platform::Win::BitmapWindow.

◆ onResize()

virtual void Ocean::Platform::Win::Window::onResize	(	const unsigned int	clientWidth,
		const unsigned int	clientHeight
	)

protectedvirtual

Function for window resize event.

Parameters

clientWidth	New client width
clientHeight	New client height

Reimplemented in Ocean::Platform::Win::BitmapWindow.

◆ onShow()

virtual void Ocean::Platform::Win::Window::onShow ( const bool visible )

protectedvirtual

Function for a show event.

Parameters

visible True, if the window is being shown, false if the window is being hidden

◆ parentHandle()

HWND Ocean::Platform::Win::Window::parentHandle ( ) const

inline

Returns the handle of a possible parent window.

Returns: Parent window handle, nullptr otherwise

◆ registerWindowClass()

virtual bool Ocean::Platform::Win::Window::registerWindowClass ( const HICON icon = nullptr )

protectedvirtual

Registers a new windows class for the application window.

Parameters

icon	The optional handle of the icon to be used, nullptr to use default icon

Returns: True, if succeeded

◆ repaint()

virtual void Ocean::Platform::Win::Window::repaint ( const bool eraseBackground = false )

virtual

Repaints the window.

Parameters

eraseBackground True, to erase the background

◆ resize()

bool Ocean::Platform::Win::Window::resize	(	const unsigned int	width,
		const unsigned int	height
	)

Resizes the window.

Parameters

width	New window width
height	New window height

Returns: True, if succeeded

◆ setEnableDropAndDrop()

void Ocean::Platform::Win::Window::setEnableDropAndDrop ( const bool state = true )

Enables or disables drag&drop support for files.

Parameters

state True, to enable support for drag&drop of file for this window; False, to disable drag&drop.

See also: onDragAndDrop().

◆ setParent()

bool Ocean::Platform::Win::Window::setParent ( const HWND parent )

Sets the parent window handle.

Returns: True, if succeeded

◆ setText()

void Ocean::Platform::Win::Window::setText ( const std::wstring & text )

Sets or changes the text of this windows.

Parameters

text	The text to be set

◆ show()

virtual void Ocean::Platform::Win::Window::show ( )

virtual

Shows the window.

◆ update()

virtual void Ocean::Platform::Win::Window::update ( )

virtual

Updates the window.

◆ width()

unsigned int Ocean::Platform::Win::Window::width ( ) const

Returns the width of the entire window.

Returns: Width in pixel

◆ windowProc()

static LRESULT CALLBACK Ocean::Platform::Win::Window::windowProc	(	HWND	hwnd,
		UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam
	)

staticprotected

Window message / event procedure.

Parameters

hwnd	Window handle
uMsg	Message id
wParam	High message parameter
lParam	Low message parameter

Field Documentation

◆ applicationInstance_

HINSTANCE Ocean::Platform::Win::Window::applicationInstance_ = nullptr

protected

Application instance.

◆ className_

std::wstring Ocean::Platform::Win::Window::className_

protected

Window class name.

◆ dc_

HDC Ocean::Platform::Win::Window::dc_ = nullptr

protected

Window device context.

◆ handle_

HWND Ocean::Platform::Win::Window::handle_ = nullptr

protected

Window handle.

◆ isChild_

bool Ocean::Platform::Win::Window::isChild_ = false

protected

True, if the window is a child window.

◆ name_

std::wstring Ocean::Platform::Win::Window::name_

protected

Name of the window.

◆ parentHandle_

HWND Ocean::Platform::Win::Window::parentHandle_ = nullptr

protected

Window handle of a possible parent window, making this window to a child window.

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

Window.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ClassMap

◆ Files

Member Enumeration Documentation

◆ MouseButton

Constructor & Destructor Documentation

◆ Window()

◆ ~Window()

Member Function Documentation

◆ applicationInstance()

◆ classMap()

◆ classMapLock()

◆ clientHeight()

◆ clientWidth()

◆ createWindow()

◆ dc()

◆ handle()

◆ height()

◆ hide()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ modifyWindowClass()

◆ modifyWindowStyle()

◆ move()

◆ name()

◆ onActivate()

◆ onDestroy()

◆ onDragAndDrop()

◆ onIdle()

◆ onInitialized()

◆ onKeyDown()

◆ onKeyUp()

◆ onMinimize()

◆ onMouseDoubleClick()

◆ onMouseDown()

◆ onMouseMove()

◆ onMouseUp()

◆ onMouseWheel()

◆ onPaint()

◆ onResize()

◆ onShow()

◆ parentHandle()

◆ registerWindowClass()

◆ repaint()

◆ resize()

◆ setEnableDropAndDrop()

◆ setParent()

◆ setText()

◆ show()

◆ update()

◆ width()

◆ windowProc()

Field Documentation

◆ applicationInstance_

◆ className_

◆ dc_

◆ handle_

◆ isChild_

◆ name_

◆ parentHandle_