sdl::video::Window Class Reference

Represents an SDL window. More...

#include <Window.h>

Collaboration diagram for sdl::video::Window:

List of all members.

Public Member Functions
	Window (const string &caption, const Icon &icon)
	~Window ()
string	caption ()
Window &	caption (const string &caption)
Icon &	icon ()
Window &	icon (const Icon &icon)
bool	minimize ()
bool	grabInput ()
bool	releaseInput ()
bool	inputGrabbed ()
bool	fullScreen (const Surface &surface)

---

Detailed Description

Represents an SDL window.

Definition at line 43 of file Window.h.

---

Constructor & Destructor Documentation

sdl::video::Window::Window	(	const string &	caption,
		const Icon &	icon
	)		[inline]

Constructs a Window with a caption and an icon.

Definition at line 48 of file Window.h.

sdl::video::Window::~Window

(

)

[inline]

Destroys the Window.

Definition at line 54 of file Window.h.

---

Member Function Documentation

string sdl::video::Window::caption

(

)

[inline]

Returns the Window's caption.

Returns:

The Window's caption.

Definition at line 61 of file Window.h.

Window& sdl::video::Window::caption

(

const string &

caption

)

[inline]

Sets the Window's caption.

Parameters:

caption

The Window's new caption.

Returns:

A reference to this Window.

Definition at line 70 of file Window.h.

bool sdl::video::Window::fullScreen

(

const Surface &

surface

)

[inline]

Toggles fullscreen mode.

Parameters:

surface

The Surface for which to toggle fullscreen mode.

Returns:

True if successful, false otherwise.

Definition at line 131 of file Window.h.

bool sdl::video::Window::grabInput

(

)

[inline]

Grabs the mouse and keyboard input.

Returns:

True if successful, false otherwise.

Definition at line 108 of file Window.h.

Window& sdl::video::Window::icon

(

const Icon &

icon

)

[inline]

Sets the Window's icon.

Parameters:

icon	The Window's new icon.

Returns:

A reference to this Window.

Definition at line 90 of file Window.h.

Icon& sdl::video::Window::icon

(

)

[inline]

Returns the window's icon.

Returns:

The Window's icon.

Definition at line 81 of file Window.h.

bool sdl::video::Window::inputGrabbed

(

)

[inline]

Determines if the input if grabbed.

Returns:

True if grabbed, false otherwise.

Definition at line 122 of file Window.h.

bool sdl::video::Window::minimize

(

)

[inline]

Attempts to minimize the window.

Returns:

True if successful, false otherwise.

Definition at line 101 of file Window.h.

bool sdl::video::Window::releaseInput

(

)

[inline]

Releases the mouse and keyboard.

Returns:

True if successful, false otherwise.

Definition at line 115 of file Window.h.

---

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

• video/Window.h