<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iWin32Assistant Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iWin32Assistant Struct Reference</h1><!-- doxytag: class="iWin32Assistant" --><!-- doxytag: inherits="iBase" -->This interface describes actions specific to the Windows platform.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="win32_8h-source.html">csutil/win32/win32.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iWin32Assistant:</div>
<div class="dynsection">
<p><center><img src="structiWin32Assistant__inherit__graph.png" border="0" usemap="#iWin32Assistant__inherit__map" alt="Inheritance graph"></center>
<map name="iWin32Assistant__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="37,7,93,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiWin32Assistant-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiWin32Assistant.html#d9e0df6860e451ca4603451f06c22e28">AlertV</a> (HWND window, int type, const char *title, const char *okMsg, const char *msg, va_list args)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Display a nice message box. <a href="#d9e0df6860e451ca4603451f06c22e28"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual HWND </td><td class="memItemRight" valign="bottom"><a class="el" href="structiWin32Assistant.html#3758913fdb866c99534a8e2c99f8198b">CreateCSWindow</a> (<a class="el" href="structiGraphics2D.html">iGraphics2D</a> *canvas, DWORD exStyle, DWORD style, int x, int y, int w, int h)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new window with the default CrystalSpace window class. <a href="#3758913fdb866c99534a8e2c99f8198b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiWin32Assistant.html#aa2b8582d8646ba72840c421094e129d">DisableConsole</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable the console window (if present). <a href="#aa2b8582d8646ba72840c421094e129d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiWin32Assistant.html#2d818d3dab7b6a25614365bf40609b64">GetCmdShow</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the nCmdShow of the WinMain(). <a href="#2d818d3dab7b6a25614365bf40609b64"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual HINSTANCE </td><td class="memItemRight" valign="bottom"><a class="el" href="structiWin32Assistant.html#d3f0facf39fe1f85a60dbc319fb14050">GetInstance</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the HINSTANCE of the program. <a href="#d3f0facf39fe1f85a60dbc319fb14050"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiWin32Assistant.html#d08239ff3b5949a2cb6376f3cbf0e327">GetIsActive</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the program is 'active', false otherwise. <a href="#d08239ff3b5949a2cb6376f3cbf0e327"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiWin32Assistant.html#50c6b6b0a33668451fb53924051a3637">HasOwnMessageLoop</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets whether <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> should get Messages on it's own. <a href="#50c6b6b0a33668451fb53924051a3637"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiWin32Assistant.html#763027a10691f3e567ef25c882c235ef">SetCursor</a> (int cursor)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the mouse shape. <a href="#763027a10691f3e567ef25c882c235ef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiWin32Assistant.html#0c9abca22c89367345b585fceb8df22c">SetHCursor</a> (HCURSOR cursor)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the mouse shape. <a href="#0c9abca22c89367345b585fceb8df22c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiWin32Assistant.html#f068ad77bed294617c837d3dda4aafb7">UseOwnMessageLoop</a> (bool ownmsgloop)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets wether <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> should get Messages on it's own. <a href="#f068ad77bed294617c837d3dda4aafb7"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This interface describes actions specific to the Windows platform.
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>As the name suggests, this interface provides functionality specific to the Win32 platform. It can be retrieved from the object registry via <a class="el" href="iutil_2objreg_8h.html#2a09063f1dabdde133a6269016f6a3da">CS_QUERY_REGISTRY()</a>, 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 header file should be surrounded by appropriate '#if defined(CS_PLATFORM_WIN32) ... #endif' statements. </dd></dl>
<p>Definition at line <a class="el" href="win32_8h-source.html#l00044">44</a> of file <a class="el" href="win32_8h-source.html">win32.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d9e0df6860e451ca4603451f06c22e28"></a><!-- doxytag: member="iWin32Assistant::AlertV" ref="d9e0df6860e451ca4603451f06c22e28" args="(HWND window, int type, const char *title, const char *okMsg, const char *msg, va_list args)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iWin32Assistant::AlertV </td>
<td>(</td>
<td class="paramtype">HWND </td>
<td class="paramname"> <em>window</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>title</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>okMsg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"> <em>args</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Display a nice message box.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>window</em> </td><td>Parent window of the message box. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Type of the message box, one of CS_ALERT_*. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>title</em> </td><td>Title used for the message box. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>okMsg</em> </td><td>Label of the "OK" button. 0 means default. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Message. Can contain <a class="el" href="group__util.html#gb1da56117bc82aa18efd07d4de43cb17" title="Portable implementation of snprintf().">cs_snprintf()</a>-like format specifiers. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>Message formatting arguments </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__gfx2d.html#g1ba306f8b720788dc0f5e08c384aa3dd" title="Display an error.">CS_ALERT_ERROR</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="3758913fdb866c99534a8e2c99f8198b"></a><!-- doxytag: member="iWin32Assistant::CreateCSWindow" ref="3758913fdb866c99534a8e2c99f8198b" args="(iGraphics2D *canvas, DWORD exStyle, DWORD style, int x, int y, int w, int h)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual HWND iWin32Assistant::CreateCSWindow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiGraphics2D.html">iGraphics2D</a> * </td>
<td class="paramname"> <em>canvas</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">DWORD </td>
<td class="paramname"> <em>exStyle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">DWORD </td>
<td class="paramname"> <em>style</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>h</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a new window with the default CrystalSpace window class.
<p>
<em>canvas</em> the canvas creating the window. This window can subsequently be subclassed if more functionality is needed.
</div>
</div><p>
<a class="anchor" name="aa2b8582d8646ba72840c421094e129d"></a><!-- doxytag: member="iWin32Assistant::DisableConsole" ref="aa2b8582d8646ba72840c421094e129d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iWin32Assistant::DisableConsole </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Disable the console window (if present).
<p>
</div>
</div><p>
<a class="anchor" name="2d818d3dab7b6a25614365bf40609b64"></a><!-- doxytag: member="iWin32Assistant::GetCmdShow" ref="2d818d3dab7b6a25614365bf40609b64" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iWin32Assistant::GetCmdShow </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the nCmdShow of the WinMain().
<p>
</div>
</div><p>
<a class="anchor" name="d3f0facf39fe1f85a60dbc319fb14050"></a><!-- doxytag: member="iWin32Assistant::GetInstance" ref="d3f0facf39fe1f85a60dbc319fb14050" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual HINSTANCE iWin32Assistant::GetInstance </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the HINSTANCE of the program.
<p>
</div>
</div><p>
<a class="anchor" name="d08239ff3b5949a2cb6376f3cbf0e327"></a><!-- doxytag: member="iWin32Assistant::GetIsActive" ref="d08239ff3b5949a2cb6376f3cbf0e327" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iWin32Assistant::GetIsActive </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the program is 'active', false otherwise.
<p>
</div>
</div><p>
<a class="anchor" name="50c6b6b0a33668451fb53924051a3637"></a><!-- doxytag: member="iWin32Assistant::HasOwnMessageLoop" ref="50c6b6b0a33668451fb53924051a3637" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iWin32Assistant::HasOwnMessageLoop </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets whether <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> should get Messages on it's own.
<p>
</div>
</div><p>
<a class="anchor" name="763027a10691f3e567ef25c882c235ef"></a><!-- doxytag: member="iWin32Assistant::SetCursor" ref="763027a10691f3e567ef25c882c235ef" args="(int cursor)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iWin32Assistant::SetCursor </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>cursor</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the mouse shape.
<p>
</div>
</div><p>
<a class="anchor" name="0c9abca22c89367345b585fceb8df22c"></a><!-- doxytag: member="iWin32Assistant::SetHCursor" ref="0c9abca22c89367345b585fceb8df22c" args="(HCURSOR cursor)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iWin32Assistant::SetHCursor </td>
<td>(</td>
<td class="paramtype">HCURSOR </td>
<td class="paramname"> <em>cursor</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the mouse shape.
<p>
</div>
</div><p>
<a class="anchor" name="f068ad77bed294617c837d3dda4aafb7"></a><!-- doxytag: member="iWin32Assistant::UseOwnMessageLoop" ref="f068ad77bed294617c837d3dda4aafb7" args="(bool ownmsgloop)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iWin32Assistant::UseOwnMessageLoop </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ownmsgloop</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets wether <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> should get Messages on it's own.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>csutil/win32/<a class="el" href="win32_8h-source.html">win32.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3957
