Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 2809

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: iCEGUI 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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>iCEGUI Struct Reference</h1><!-- doxytag: class="iCEGUI" --><!-- doxytag: inherits="iBase" -->Interface for the <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> CEGUI wrapper.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="icegui_8h-source.html">ivaria/icegui.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iCEGUI:</div>
<div class="dynsection">
<p><center><img src="structiCEGUI__inherit__graph.png" border="0" usemap="#iCEGUI__inherit__map" alt="Inheritance graph"></center>
<map name="iCEGUI__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="12,7,68,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiCEGUI-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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#f8f5a9b4c7a988d97a3d09a47ba5a151">DisableKeyboardCapture</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Keep CEGUI from capturing keyboard events.  <a href="#f8f5a9b4c7a988d97a3d09a47ba5a151"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#19afc4a23d972e530a908be01654e6af">DisableMouseCapture</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Keep CEGUI from capturing mouse events.  <a href="#19afc4a23d972e530a908be01654e6af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#d00b1867008e4d4c76cc984902665316">EnableKeyboardCapture</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow CEGUI to capture keyboard events.  <a href="#d00b1867008e4d4c76cc984902665316"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#89d983a88119c8dd8be6361884e45179">EnableMouseCapture</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow CEGUI to capture mouse events.  <a href="#89d983a88119c8dd8be6361884e45179"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
CEGUI::FontManager *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#971528362753153cd6a8d8d973d4a757">GetFontManagerPtr</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to the CEGUI::FontManager singleton.  <a href="#971528362753153cd6a8d8d973d4a757"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
CEGUI::GlobalEventSet *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#48351a50d36da41f1f4292e014bae6c3">GetGlobalEventSetPtr</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to the CEGUI::GlobalEventSet singleton.  <a href="#48351a50d36da41f1f4292e014bae6c3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
CEGUI::ImagesetManager *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#4ab0750ff0df8592fd566a001a8d3832">GetImagesetManagerPtr</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to the CEGUI::ImagesetManager singleton.  <a href="#4ab0750ff0df8592fd566a001a8d3832"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual CEGUI::Logger *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#ad60ef6a42cda8186ab9d0c99004baf0">GetLoggerPtr</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to the CEGUI::Logger singleton.  <a href="#ad60ef6a42cda8186ab9d0c99004baf0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
CEGUI::MouseCursor *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#bd738fc44c8d478e186b562f628a3a53">GetMouseCursorPtr</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to the CEGUI::MouseCursor singleton.  <a href="#bd738fc44c8d478e186b562f628a3a53"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
CEGUI::SchemeManager *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#e06ccacd86e4ef8255114fd06e2761b0">GetSchemeManagerPtr</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to the CEGUI::SchemeManager singleton.  <a href="#e06ccacd86e4ef8255114fd06e2761b0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual CEGUI::System *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#5201fbfe67e75b0c69a0954a93ad699f">GetSystemPtr</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to the CEGUI::System singleton.  <a href="#5201fbfe67e75b0c69a0954a93ad699f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
CEGUI::WindowFactoryManager *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#5da29b23abdda6488c843aa2e26161dd">GetWindowFactoryManagerPtr</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to the CEGUI::WindowFactoryManager singleton.  <a href="#5da29b23abdda6488c843aa2e26161dd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
CEGUI::WindowManager *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#dcfc1d6ec4a5481eb0ba9f6190f92804">GetWindowManagerPtr</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to the CEGUI::WindowManager singleton.  <a href="#dcfc1d6ec4a5481eb0ba9f6190f92804"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#45fa2bf1e2d1128b69c4285ede1fc29b">Initialize</a> (<a class="el" href="structiScript.html">iScript</a> *script=0)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the plugin.  <a href="#45fa2bf1e2d1128b69c4285ede1fc29b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCEGUI.html#2aa630e9e88cf0e1e3b384001c4eaaba">Render</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Render the GUI.  <a href="#2aa630e9e88cf0e1e3b384001c4eaaba"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Interface for the <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> CEGUI wrapper. 
<p>Definition at line <a class="el" href="icegui_8h-source.html#l00037">37</a> of file <a class="el" href="icegui_8h-source.html">icegui.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f8f5a9b4c7a988d97a3d09a47ba5a151"></a><!-- doxytag: member="iCEGUI::DisableKeyboardCapture" ref="f8f5a9b4c7a988d97a3d09a47ba5a151" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iCEGUI::DisableKeyboardCapture           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Keep CEGUI from capturing keyboard events. 
<p>

</div>
</div><p>
<a class="anchor" name="19afc4a23d972e530a908be01654e6af"></a><!-- doxytag: member="iCEGUI::DisableMouseCapture" ref="19afc4a23d972e530a908be01654e6af" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iCEGUI::DisableMouseCapture           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Keep CEGUI from capturing mouse events. 
<p>

</div>
</div><p>
<a class="anchor" name="d00b1867008e4d4c76cc984902665316"></a><!-- doxytag: member="iCEGUI::EnableKeyboardCapture" ref="d00b1867008e4d4c76cc984902665316" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iCEGUI::EnableKeyboardCapture           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Allow CEGUI to capture keyboard events. 
<p>

</div>
</div><p>
<a class="anchor" name="89d983a88119c8dd8be6361884e45179"></a><!-- doxytag: member="iCEGUI::EnableMouseCapture" ref="89d983a88119c8dd8be6361884e45179" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iCEGUI::EnableMouseCapture           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Allow CEGUI to capture mouse events. 
<p>

</div>
</div><p>
<a class="anchor" name="971528362753153cd6a8d8d973d4a757"></a><!-- doxytag: member="iCEGUI::GetFontManagerPtr" ref="971528362753153cd6a8d8d973d4a757" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual CEGUI::FontManager* iCEGUI::GetFontManagerPtr           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a pointer to the CEGUI::FontManager singleton. 
<p>

</div>
</div><p>
<a class="anchor" name="48351a50d36da41f1f4292e014bae6c3"></a><!-- doxytag: member="iCEGUI::GetGlobalEventSetPtr" ref="48351a50d36da41f1f4292e014bae6c3" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual CEGUI::GlobalEventSet* iCEGUI::GetGlobalEventSetPtr           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a pointer to the CEGUI::GlobalEventSet singleton. 
<p>

</div>
</div><p>
<a class="anchor" name="4ab0750ff0df8592fd566a001a8d3832"></a><!-- doxytag: member="iCEGUI::GetImagesetManagerPtr" ref="4ab0750ff0df8592fd566a001a8d3832" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual CEGUI::ImagesetManager* iCEGUI::GetImagesetManagerPtr           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a pointer to the CEGUI::ImagesetManager singleton. 
<p>

</div>
</div><p>
<a class="anchor" name="ad60ef6a42cda8186ab9d0c99004baf0"></a><!-- doxytag: member="iCEGUI::GetLoggerPtr" ref="ad60ef6a42cda8186ab9d0c99004baf0" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual CEGUI::Logger* iCEGUI::GetLoggerPtr           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a pointer to the CEGUI::Logger singleton. 
<p>

</div>
</div><p>
<a class="anchor" name="bd738fc44c8d478e186b562f628a3a53"></a><!-- doxytag: member="iCEGUI::GetMouseCursorPtr" ref="bd738fc44c8d478e186b562f628a3a53" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual CEGUI::MouseCursor* iCEGUI::GetMouseCursorPtr           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a pointer to the CEGUI::MouseCursor singleton. 
<p>

</div>
</div><p>
<a class="anchor" name="e06ccacd86e4ef8255114fd06e2761b0"></a><!-- doxytag: member="iCEGUI::GetSchemeManagerPtr" ref="e06ccacd86e4ef8255114fd06e2761b0" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual CEGUI::SchemeManager* iCEGUI::GetSchemeManagerPtr           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a pointer to the CEGUI::SchemeManager singleton. 
<p>

</div>
</div><p>
<a class="anchor" name="5201fbfe67e75b0c69a0954a93ad699f"></a><!-- doxytag: member="iCEGUI::GetSystemPtr" ref="5201fbfe67e75b0c69a0954a93ad699f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual CEGUI::System* iCEGUI::GetSystemPtr           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a pointer to the CEGUI::System singleton. 
<p>

</div>
</div><p>
<a class="anchor" name="5da29b23abdda6488c843aa2e26161dd"></a><!-- doxytag: member="iCEGUI::GetWindowFactoryManagerPtr" ref="5da29b23abdda6488c843aa2e26161dd" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual CEGUI::WindowFactoryManager* iCEGUI::GetWindowFactoryManagerPtr           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a pointer to the CEGUI::WindowFactoryManager singleton. 
<p>

</div>
</div><p>
<a class="anchor" name="dcfc1d6ec4a5481eb0ba9f6190f92804"></a><!-- doxytag: member="iCEGUI::GetWindowManagerPtr" ref="dcfc1d6ec4a5481eb0ba9f6190f92804" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual CEGUI::WindowManager* iCEGUI::GetWindowManagerPtr           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a pointer to the CEGUI::WindowManager singleton. 
<p>

</div>
</div><p>
<a class="anchor" name="45fa2bf1e2d1128b69c4285ede1fc29b"></a><!-- doxytag: member="iCEGUI::Initialize" ref="45fa2bf1e2d1128b69c4285ede1fc29b" args="(iScript *script=0)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iCEGUI::Initialize           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiScript.html">iScript</a> *&nbsp;</td>
          <td class="paramname"> <em>script</em> = <code>0</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize the plugin. 
<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>script</em>&nbsp;</td><td><a class="el" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a> plugin to use as a scripting module. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="2aa630e9e88cf0e1e3b384001c4eaaba"></a><!-- doxytag: member="iCEGUI::Render" ref="2aa630e9e88cf0e1e3b384001c4eaaba" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iCEGUI::Render           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Render the GUI. 
<p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="icegui_8h-source.html">icegui.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>