CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iWin32Assistant Struct Reference

This interface describes actions specific to the Windows platform. More...

#include <win32.h>

Inheritance diagram for iWin32Assistant:

iBase List of all members.

Public Methods

virtual HINSTANCE GetInstance () const=0
 Returns the HINSTANCE of the program.

virtual bool GetIsActive () const=0
 Returns true if the program is 'active', false otherwise.

virtual int GetCmdShow () const=0
 Gets the nCmdShow of the WinMain().

virtual bool SetCursor (int cursor)=0
 Set the mouse shape.

virtual void DisableConsole ()=0
 Disable the console window (if present).

virtual void AlertV (HWND window, int type, const char *title, const char *okMsg, const char *msg, va_list args)=0
 Display a nice message box.

virtual HWND GetApplicationWindow ()=0
 Returns the handle to the main application window.

virtual void UseOwnMessageLoop (bool ownmsgloop)=0
 Sets wether CS should get Messages on it's own.

virtual bool HasOwnMessageLoop ()=0
 Gets whether CS should get Messages on it's own.


Detailed Description

This interface describes actions specific to the Windows platform.

Remarks:
As the name suggests, this interface provides functionality specific to the Win32 platform. It can be retrieved from the object registry via CS_QUERY_REGISTRY(), as an instance of this object will be registered with the tag `iWin32Assistant'. To ensure that code using this functionality compiles properly on all other platforms, the use of the interface and inclusion of the header file should be surrounded by appropriate `if defined(OS_WIN32) ... endif' statements.

Definition at line 49 of file win32.h.


Member Function Documentation

virtual void iWin32Assistant::AlertV HWND    window,
int    type,
const char *    title,
const char *    okMsg,
const char *    msg,
va_list    args
[pure virtual]
 

Display a nice message box.

virtual void iWin32Assistant::DisableConsole   [pure virtual]
 

Disable the console window (if present).

virtual HWND iWin32Assistant::GetApplicationWindow   [pure virtual]
 

Returns the handle to the main application window.

virtual int iWin32Assistant::GetCmdShow   [pure virtual]
 

Gets the nCmdShow of the WinMain().

virtual HINSTANCE iWin32Assistant::GetInstance   [pure virtual]
 

Returns the HINSTANCE of the program.

virtual bool iWin32Assistant::GetIsActive   [pure virtual]
 

Returns true if the program is 'active', false otherwise.

virtual bool iWin32Assistant::HasOwnMessageLoop   [pure virtual]
 

Gets whether CS should get Messages on it's own.

virtual bool iWin32Assistant::SetCursor int    cursor [pure virtual]
 

Set the mouse shape.

virtual void iWin32Assistant::UseOwnMessageLoop bool    ownmsgloop [pure virtual]
 

Sets wether CS should get Messages on it's own.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18