ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

SdlWindow Class Reference

#include <sdl-window.h>

Inheritance diagram for SdlWindow:

List of all members.

Public Member Functions

 SdlWindow ()
virtual ~SdlWindow ()
virtual void setupIcon ()
 Setup the window icon.
void setWindowCaption (const Common::String &caption)
 Change the caption of the window.
void toggleMouseGrab ()
 Toggle mouse grab state.
bool hasMouseFocus () const
 Check whether the application has mouse focus.
bool warpMouseInWindow (int x, int y)
 Warp the mouse to the specified position in window coordinates.
void iconifyWindow ()
 Iconifies the window.
bool getSDLWMInformation (SDL_SysWMinfo *info) const
 Query platform specific SDL window manager information.
bool mouseIsGrabbed () const

Private Attributes

bool _inputGrabState

Detailed Description

Definition at line 30 of file sdl-window.h.


Constructor & Destructor Documentation

SdlWindow::SdlWindow (  ) 

Definition at line 35 of file sdl-window.cpp.

SdlWindow::~SdlWindow (  )  [virtual]

Definition at line 43 of file sdl-window.cpp.


Member Function Documentation

bool SdlWindow::getSDLWMInformation ( SDL_SysWMinfo *  info  )  const

Query platform specific SDL window manager information.

Since this is an SDL internal structure clients are responsible for accessing it in a version safe manner.

Definition at line 184 of file sdl-window.cpp.

bool SdlWindow::hasMouseFocus (  )  const

Check whether the application has mouse focus.

Definition at line 146 of file sdl-window.cpp.

void SdlWindow::iconifyWindow (  ) 

Iconifies the window.

Definition at line 174 of file sdl-window.cpp.

bool SdlWindow::mouseIsGrabbed (  )  const [inline]

Definition at line 79 of file sdl-window.h.

void SdlWindow::setupIcon (  )  [virtual]

Setup the window icon.

Reimplemented in SdlIconlessWindow.

Definition at line 49 of file sdl-window.cpp.

void SdlWindow::setWindowCaption ( const Common::String caption  ) 

Change the caption of the window.

Parameters:
caption New window caption in UTF-8 encoding.

Definition at line 118 of file sdl-window.cpp.

void SdlWindow::toggleMouseGrab (  ) 

Toggle mouse grab state.

This decides whether the cursor can leave the window or not.

Definition at line 129 of file sdl-window.cpp.

bool SdlWindow::warpMouseInWindow ( int  x,
int  y 
)

Warp the mouse to the specified position in window coordinates.

The mouse will only be warped if the window is focused in the window manager.

Returns:
true if the system cursor was warped.

Definition at line 158 of file sdl-window.cpp.


Member Data Documentation

Definition at line 89 of file sdl-window.h.


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


Generated on Sat Mar 16 2019 05:04:42 for ResidualVM by doxygen 1.7.1
curved edge   curved edge