Sophie

Sophie

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

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: csWtoC 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>csWtoC Struct Reference<br>
<small>
[<a class="el" href="group__util.html">Utilities</a>]</small>
</h1><!-- doxytag: class="csWtoC" -->Helper class to convert wchar_t* to char* (UTF-8 encoded) strings for use as function parameters.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="util_8h-source.html">csutil/util.h</a>&gt;</code>
<p>

<p>
<a href="structcsWtoC-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsWtoC.html#b0133db4781c438c020b65dae5f1ecf9">csWtoC</a> (const <a class="el" href="group__util.html#g43124e776b499fd41c598b2f6d210242">wchar_t</a> *ws)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#b0133db4781c438c020b65dae5f1ecf9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsWtoC.html#a31ecb2bea789b3a4b7e71064087c35c">operator const char *</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieve the converted string.  <a href="#a31ecb2bea789b3a4b7e71064087c35c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsWtoC.html#f880661c27c3d47630f985f200e1b38e">~csWtoC</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deletes the internally stored string.  <a href="#f880661c27c3d47630f985f200e1b38e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Helper class to convert wchar_t* to char* (UTF-8 encoded) strings for use as function parameters. 
<p>
Use of this helper class is more convenient than a <a class="el" href="group__util.html#gc3a6e34ea28a22fdeda8802c872ce2d0" title="Allocate a new char [] and copy the string into the newly allocated storage.">csStrNew()</a> / delete[] pair, but essentially does the same (with the convenience of automatic cleanup). <div class="fragment"><pre class="fragment">   <span class="keywordtype">wchar_t</span>* wstr = L<span class="stringliteral">"Hello World"</span>;
    ... 
   <a class="code" href="structiNativeWindow.html" title="This interface represents a native window.">iNativeWindow</a>* natwin =  ... ;
     natwin-&gt;<a class="code" href="structiNativeWindow.html#dca3a8eab6088628f51d68e6487f8092" title="Set the title for this window.">SetTitle</a> (<a class="code" href="structcsWtoC.html" title="Helper class to convert wchar_t* to char* (UTF-8 encoded) strings for use as function...">csWtoC</a> (wstr));
</pre></div> 
<p>Definition at line <a class="el" href="util_8h-source.html#l00122">122</a> of file <a class="el" href="util_8h-source.html">util.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b0133db4781c438c020b65dae5f1ecf9"></a><!-- doxytag: member="csWtoC::csWtoC" ref="b0133db4781c438c020b65dae5f1ecf9" args="(const wchar_t *ws)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csWtoC::csWtoC           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__util.html#g43124e776b499fd41c598b2f6d210242">wchar_t</a> *&nbsp;</td>
          <td class="paramname"> <em>ws</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor. 
<p>
Stores an UTF-8 converted version of <code>ws</code> internally. 
<p>Definition at line <a class="el" href="util_8h-source.html#l00131">131</a> of file <a class="el" href="util_8h-source.html">util.h</a>.</p>

<p>References <a class="el" href="group__util.html#gc3a6e34ea28a22fdeda8802c872ce2d0">csStrNew()</a>.</p>

</div>
</div><p>
<a class="anchor" name="f880661c27c3d47630f985f200e1b38e"></a><!-- doxytag: member="csWtoC::~csWtoC" ref="f880661c27c3d47630f985f200e1b38e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csWtoC::~csWtoC           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Deletes the internally stored string. 
<p>

<p>Definition at line <a class="el" href="util_8h-source.html#l00136">136</a> of file <a class="el" href="util_8h-source.html">util.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a31ecb2bea789b3a4b7e71064087c35c"></a><!-- doxytag: member="csWtoC::operator const char *" ref="a31ecb2bea789b3a4b7e71064087c35c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csWtoC::operator const char *           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Retrieve the converted string. 
<p>

<p>Definition at line <a class="el" href="util_8h-source.html#l00141">141</a> of file <a class="el" href="util_8h-source.html">util.h</a>.</p>

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