Public Member Functions | Public Attributes

IWindow Class Reference

#include <IWindow.h>

Inheritance diagram for IWindow:
Window

List of all members.

Public Member Functions

virtual ~IWindow ()
virtual bool init (int x, int y, int width, int height, const wchar *title, STATE state=stateWindowed, STYLE style=styleNormal, IWindow *parent=0, float alpha=1.f)=0
virtual void uninit (void)=0
virtual int fileDialog (wchar *out, uint outSize, const wchar *title, DIALOGFLAGS flags, const wchar *filter)=0
virtual void * getWindow (void)=0
 get pointer to the window.
virtual void * getDisplay (void)=0
 get pointer to the display (UNIX systems).
virtual IWindowgetParent (void)=0
 Get the parent window.
virtual void setSize (int x, int y, int width, int height)=0
 Set window size and position.
virtual void setSize (WindowSize)=0
 Set window size and position.
virtual WindowSize getSize (void)=0
 Get the window position and size.
virtual void setState (STATE)=0
 Set window state.
virtual STATE getState (void)=0
 Get the window state.
virtual void setStyle (STYLE)=0
 Set window style.
virtual STYLE getStyle (void)=0
 Get the window style.
virtual void setTitle (const wchar *title)=0
 Set window title.
virtual const wchargetTitle (void)=0
 Get the window title.
virtual const MouseMapgetMouseMap (void)=0
virtual const KeyboardMapgetKeyboardMap (void)=0
virtual bool activateInput (DEVICE type)=0
 Activate an input device.
virtual void deactivateInput (DEVICE type)=0
 Deactivate an input device.
virtual uint getDevices (DeviceInfo *array, uint size)=0
 Fill an array with information of all devices.
virtual pDevice activateDevice (DEVICE type, int ID=0)=0
 Activate input device.
virtual void deactivateDevice (pDevice device)=0
 Deactivate device.
virtual pCursor createCursor (const wchar *file)=0
 Create cursor from file.
virtual void freeCursor (pCursor &)=0
 Delete cursor.
virtual void setCursor (pCursor cur)=0
 Change cursor.
virtual pCursor getCursor (void)=0
 Get the current cursor.
virtual void showCursor (bool)=0
 Show or hide the cursor.
virtual void setCursorPosition (int x, int y)=0
 Set the current cursor position.
virtual void setCursorPosition (CursorPosition)=0
 Set the current cursor position.
virtual CursorPosition getCursorPosition (void)=0
 Get the current cursor position.
virtual void addListener (pEventRenderListener)=0
 Add event listener.
virtual void addListener (pEventWindowListener)=0
 Add event listener.
virtual void addListener (pEventDeviceListener)=0
 Add event listener.
virtual void removeListener (pEventRenderListener)=0
 Remove event listener.
virtual void removeListener (pEventWindowListener)=0
 Remove event listener.
virtual void removeListener (pEventDeviceListener)=0
 Remove event listener.
virtual pScreen createScreen (const wchar *imageFile, float alpha=1.f)=0
 Show a simple screen with an image.
virtual void freeScreen (pScreen &screen)=0
 Free/destroy the created screen.
virtual void loop (void)=0
virtual void close (void)=0
 Send close message. The window will be closed.

Public Attributes

bool IsOpen

Detailed Description

The window class. This class represents a window in the current operating system.

Definition at line 11 of file IWindow.h.


Constructor & Destructor Documentation

virtual IWindow::~IWindow (  )  [inline, virtual]

Definition at line 14 of file IWindow.h.


Member Function Documentation

virtual pDevice IWindow::activateDevice ( DEVICE  type,
int  ID = 0 
) [pure virtual]

Activate input device.

virtual bool IWindow::activateInput ( DEVICE  type  )  [pure virtual]

Activate an input device.

virtual void IWindow::addListener ( pEventWindowListener   )  [pure virtual]

Add event listener.

virtual void IWindow::addListener ( pEventDeviceListener   )  [pure virtual]

Add event listener.

virtual void IWindow::addListener ( pEventRenderListener   )  [pure virtual]

Add event listener.

virtual void IWindow::close ( void   )  [pure virtual]

Send close message. The window will be closed.

Implemented in Window.

virtual pCursor IWindow::createCursor ( const wchar file  )  [pure virtual]

Create cursor from file.

Implemented in Window.

virtual pScreen IWindow::createScreen ( const wchar imageFile,
float  alpha = 1.f 
) [pure virtual]

Show a simple screen with an image.

Implemented in Window.

virtual void IWindow::deactivateDevice ( pDevice  device  )  [pure virtual]

Deactivate device.

virtual void IWindow::deactivateInput ( DEVICE  type  )  [pure virtual]

Deactivate an input device.

virtual int IWindow::fileDialog ( wchar out,
uint  outSize,
const wchar title,
DIALOGFLAGS  flags,
const wchar filter 
) [pure virtual]

Open a save or open file dialog window. This function will wait until the dialog is closed by the user.

virtual void IWindow::freeCursor ( pCursor  )  [pure virtual]

Delete cursor.

virtual void IWindow::freeScreen ( pScreen screen  )  [pure virtual]

Free/destroy the created screen.

virtual pCursor IWindow::getCursor ( void   )  [pure virtual]

Get the current cursor.

Implemented in Window.

virtual CursorPosition IWindow::getCursorPosition ( void   )  [pure virtual]

Get the current cursor position.

Implemented in Window.

virtual uint IWindow::getDevices ( DeviceInfo array,
uint  size 
) [pure virtual]

Fill an array with information of all devices.

virtual void* IWindow::getDisplay ( void   )  [pure virtual]

get pointer to the display (UNIX systems).

Implemented in Window.

virtual const KeyboardMap& IWindow::getKeyboardMap ( void   )  [pure virtual]

Implemented in Window.

virtual const MouseMap& IWindow::getMouseMap ( void   )  [pure virtual]

Implemented in Window.

virtual IWindow* IWindow::getParent ( void   )  [pure virtual]

Get the parent window.

Implemented in Window.

virtual WindowSize IWindow::getSize ( void   )  [pure virtual]

Get the window position and size.

Implemented in Window.

virtual STATE IWindow::getState ( void   )  [pure virtual]

Get the window state.

Implemented in Window.

virtual STYLE IWindow::getStyle ( void   )  [pure virtual]

Get the window style.

Implemented in Window.

virtual const wchar* IWindow::getTitle ( void   )  [pure virtual]

Get the window title.

Implemented in Window.

virtual void* IWindow::getWindow ( void   )  [pure virtual]

get pointer to the window.

Implemented in Window.

virtual bool IWindow::init ( int  x,
int  y,
int  width,
int  height,
const wchar title,
STATE  state = stateWindowed,
STYLE  style = styleNormal,
IWindow parent = 0,
float  alpha = 1.f 
) [pure virtual]

Initialize the window / child window. Initializes and creates a window for the current OS. The window can than be used by other windows or to represent the user interface.

virtual void IWindow::loop ( void   )  [pure virtual]

Main Loop of the window. After calling this method the window starts retrieving window messages and drawing requests.

Implemented in Window.

virtual void IWindow::removeListener ( pEventWindowListener   )  [pure virtual]

Remove event listener.

virtual void IWindow::removeListener ( pEventDeviceListener   )  [pure virtual]

Remove event listener.

virtual void IWindow::removeListener ( pEventRenderListener   )  [pure virtual]

Remove event listener.

virtual void IWindow::setCursor ( pCursor  cur  )  [pure virtual]

Change cursor.

virtual void IWindow::setCursorPosition ( CursorPosition   )  [pure virtual]

Set the current cursor position.

virtual void IWindow::setCursorPosition ( int  x,
int  y 
) [pure virtual]

Set the current cursor position.

Implemented in Window.

virtual void IWindow::setSize ( int  x,
int  y,
int  width,
int  height 
) [pure virtual]

Set window size and position.

Implemented in Window.

virtual void IWindow::setSize ( WindowSize   )  [pure virtual]

Set window size and position.

virtual void IWindow::setState ( STATE   )  [pure virtual]

Set window state.

virtual void IWindow::setStyle ( STYLE   )  [pure virtual]

Set window style.

virtual void IWindow::setTitle ( const wchar title  )  [pure virtual]

Set window title.

Implemented in Window.

virtual void IWindow::showCursor ( bool   )  [pure virtual]

Show or hide the cursor.

Implemented in Window.

virtual void IWindow::uninit ( void   )  [pure virtual]

Uninitialize the window. The window will be removed from the OS window manager and can not be used by other windows or for the user interface.

Implemented in Window.


Member Data Documentation

This variable is true as long as the window is opened.

Definition at line 123 of file IWindow.h.


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