<!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: csFlags Class 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>csFlags Class Reference</h1><!-- doxytag: class="csFlags" -->Set of flags which can be accessed through masks.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="flags_8h-source.html">csutil/flags.h</a>></code>
<p>
<p>
<a href="classcsFlags-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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFlags.html#8ce50949391eb2a9825c32de553de4fa">Check</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> mask) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if any of the given flags are set. <a href="#8ce50949391eb2a9825c32de553de4fa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFlags.html#191da800d8ec2e932d40ac50154e3003">CheckAll</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> mask) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if all the given flags are set. <a href="#191da800d8ec2e932d40ac50154e3003"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFlags.html#138bed5abe734ee85b193a91c34ec38f">csFlags</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> value=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. All flags are set to false by default. <a href="#138bed5abe734ee85b193a91c34ec38f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFlags.html#7ccc61aa04d2040abe554fb6c3cac015">Get</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get flags. <a href="#7ccc61aa04d2040abe554fb6c3cac015"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFlags.html#590b1405572b64f028c6aded45bd7523">Reset</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> mask)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset all given flags. <a href="#590b1405572b64f028c6aded45bd7523"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFlags.html#51df753f582d3e75ae276e1d2fd5396a">Set</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> mask, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set all flags with the given mask. <a href="#51df753f582d3e75ae276e1d2fd5396a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFlags.html#2d4cf71234f2134858ab17cb3825fa3d">Set</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> mask)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set all given flags. <a href="#2d4cf71234f2134858ab17cb3825fa3d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFlags.html#e6631190a03eafaa2b9dbaf56f5d1577">SetAll</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize all flags to the given mask. <a href="#e6631190a03eafaa2b9dbaf56f5d1577"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFlags.html#56a4e9255159d84e0704ffde33fe441e">SetBool</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> mask, bool value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set all flags with the given value. <a href="#56a4e9255159d84e0704ffde33fe441e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Set of flags which can be accessed through masks.
<p>Definition at line <a class="el" href="flags_8h-source.html#l00031">31</a> of file <a class="el" href="flags_8h-source.html">flags.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="138bed5abe734ee85b193a91c34ec38f"></a><!-- doxytag: member="csFlags::csFlags" ref="138bed5abe734ee85b193a91c34ec38f" args="(uint32 value=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csFlags::csFlags </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>value</em> = <code>0</code> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. All flags are set to false by default.
<p>
<p>Definition at line <a class="el" href="flags_8h-source.html#l00039">39</a> of file <a class="el" href="flags_8h-source.html">flags.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8ce50949391eb2a9825c32de553de4fa"></a><!-- doxytag: member="csFlags::Check" ref="8ce50949391eb2a9825c32de553de4fa" args="(uint32 mask) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csFlags::Check </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>mask</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if any of the given flags are set.
<p>
<p>Definition at line <a class="el" href="flags_8h-source.html#l00094">94</a> of file <a class="el" href="flags_8h-source.html">flags.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="191da800d8ec2e932d40ac50154e3003"></a><!-- doxytag: member="csFlags::CheckAll" ref="191da800d8ec2e932d40ac50154e3003" args="(uint32 mask) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csFlags::CheckAll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>mask</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if all the given flags are set.
<p>
<p>Definition at line <a class="el" href="flags_8h-source.html#l00098">98</a> of file <a class="el" href="flags_8h-source.html">flags.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="7ccc61aa04d2040abe554fb6c3cac015"></a><!-- doxytag: member="csFlags::Get" ref="7ccc61aa04d2040abe554fb6c3cac015" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> csFlags::Get </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get flags.
<p>
<p>Definition at line <a class="el" href="flags_8h-source.html#l00090">90</a> of file <a class="el" href="flags_8h-source.html">flags.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="590b1405572b64f028c6aded45bd7523"></a><!-- doxytag: member="csFlags::Reset" ref="590b1405572b64f028c6aded45bd7523" args="(uint32 mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csFlags::Reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>mask</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset all given flags.
<p>
This will clear all flags which you specify in the mask. i.e. if a mask bit is 1 then the corresponding flag will be cleared. All other flags are untouched.
<p>Definition at line <a class="el" href="flags_8h-source.html#l00065">65</a> of file <a class="el" href="flags_8h-source.html">flags.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="51df753f582d3e75ae276e1d2fd5396a"></a><!-- doxytag: member="csFlags::Set" ref="51df753f582d3e75ae276e1d2fd5396a" args="(uint32 mask, uint32 value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csFlags::Set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>mask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set all flags with the given mask.
<p>
With this function you can set and clear a series of flags but only the flags you specify in the mask will be affected.
<p>Definition at line <a class="el" href="flags_8h-source.html#l00073">73</a> of file <a class="el" href="flags_8h-source.html">flags.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="2d4cf71234f2134858ab17cb3825fa3d"></a><!-- doxytag: member="csFlags::Set" ref="2d4cf71234f2134858ab17cb3825fa3d" args="(uint32 mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csFlags::Set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>mask</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set all given flags.
<p>
This function will set all flags which are '1' in the mask. All other flags are untouched. This contrasts with <a class="el" href="classcsFlags.html#e6631190a03eafaa2b9dbaf56f5d1577" title="Initialize all flags to the given mask.">SetAll()</a> which will set all flags that are '1' in the input and clear the flags that are '0'.
<p>Definition at line <a class="el" href="flags_8h-source.html#l00056">56</a> of file <a class="el" href="flags_8h-source.html">flags.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="e6631190a03eafaa2b9dbaf56f5d1577"></a><!-- doxytag: member="csFlags::SetAll" ref="e6631190a03eafaa2b9dbaf56f5d1577" args="(uint32 value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csFlags::SetAll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize all flags to the given mask.
<p>
You can use this function to set and clear all flags at once. If you only want to set flags (and not clear others) then use 'Set(mask)'.
<p>Definition at line <a class="el" href="flags_8h-source.html#l00047">47</a> of file <a class="el" href="flags_8h-source.html">flags.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="56a4e9255159d84e0704ffde33fe441e"></a><!-- doxytag: member="csFlags::SetBool" ref="56a4e9255159d84e0704ffde33fe441e" args="(uint32 mask, bool value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csFlags::SetBool </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>mask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set all flags with the given value.
<p>
This function will set all flags given in the mask with either '1' or '0' depending on the boolean input value.
<p>Definition at line <a class="el" href="flags_8h-source.html#l00081">81</a> of file <a class="el" href="flags_8h-source.html">flags.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="flags_8h-source.html">flags.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
>
509
