Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > eeacaa4eb55fa544d622989e42fc27b1 > files > 273

libyate-devel-2.0.0-2mdv2009.1.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Yate: JIDFeatureList Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <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>
  <div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1JIDFeatureList.html">JIDFeatureList</a>
  </div>
</div>
<div class="contents">
<h1>JIDFeatureList Class Reference</h1><!-- doxytag: class="TelEngine::JIDFeatureList" -->JID feature list.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="xmpputils_8h-source.html">xmpputils.h</a>&gt;</code>
<p>

<p>
<a href="classTelEngine_1_1JIDFeatureList-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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureList.html#031e4cb1637654aee4094d5a58ca299b">add</a> (XMPPNamespace::Type feature, bool required=false)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureList.html#74981db6ec1ed6d9a00109ab0a1db142">add</a> (<a class="el" href="classTelEngine_1_1JIDFeature.html">JIDFeature</a> *feature)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureList.html#044a40e790029607f67ab723e9e58225">remove</a> (XMPPNamespace::Type feature)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1JIDFeature.html">JIDFeature</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureList.html#ab02df4e4dc2d47d4dc52793dbe25db8">get</a> (XMPPNamespace::Type feature)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureList.html#f6acab92d4003141f3c61cff71818989">addTo</a> (<a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *element)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureList.html#c8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
JID feature list. 
<p>
This class holds a list of JID features <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="74981db6ec1ed6d9a00109ab0a1db142"></a><!-- doxytag: member="TelEngine::JIDFeatureList::add" ref="74981db6ec1ed6d9a00109ab0a1db142" args="(JIDFeature *feature)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool add           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JIDFeature.html">JIDFeature</a> *&nbsp;</td>
          <td class="paramname"> <em>feature</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a feature to the list. Destroy the received parameter if already in the list <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>feature</em>&nbsp;</td><td>The feature to add </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the given feature already exists </dd></dl>

<p>References <a class="el" href="yateclass_8h-source.html#l00650">TelEngine::destruct()</a>.</p>

</div>
</div><p>
<a class="anchor" name="031e4cb1637654aee4094d5a58ca299b"></a><!-- doxytag: member="TelEngine::JIDFeatureList::add" ref="031e4cb1637654aee4094d5a58ca299b" args="(XMPPNamespace::Type feature, bool required=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool add           </td>
          <td>(</td>
          <td class="paramtype">XMPPNamespace::Type&nbsp;</td>
          <td class="paramname"> <em>feature</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>required</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a feature to the list <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>feature</em>&nbsp;</td><td>The feature to add </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>required</em>&nbsp;</td><td>True if this feature is required </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the given feature already exists </dd></dl>

</div>
</div><p>
<a class="anchor" name="f6acab92d4003141f3c61cff71818989"></a><!-- doxytag: member="TelEngine::JIDFeatureList::addTo" ref="f6acab92d4003141f3c61cff71818989" args="(XMLElement *element)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a>* addTo           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *&nbsp;</td>
          <td class="paramname"> <em>element</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add 'feature' children to the given element <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>element</em>&nbsp;</td><td>The target <a class="el" href="classTelEngine_1_1XMLElement.html" title="An XML element.">XMLElement</a> </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The given element </dd></dl>

</div>
</div><p>
<a class="anchor" name="c8bb3912a3ce86b15842e79d0b421204"></a><!-- doxytag: member="TelEngine::JIDFeatureList::clear" ref="c8bb3912a3ce86b15842e79d0b421204" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void clear           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Clear the feature list 
</div>
</div><p>
<a class="anchor" name="ab02df4e4dc2d47d4dc52793dbe25db8"></a><!-- doxytag: member="TelEngine::JIDFeatureList::get" ref="ab02df4e4dc2d47d4dc52793dbe25db8" args="(XMPPNamespace::Type feature)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1JIDFeature.html">JIDFeature</a>* get           </td>
          <td>(</td>
          <td class="paramtype">XMPPNamespace::Type&nbsp;</td>
          <td class="paramname"> <em>feature</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a feature from the list <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>feature</em>&nbsp;</td><td>The feature to get </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the feature or 0 if it doesn't exists </dd></dl>

</div>
</div><p>
<a class="anchor" name="044a40e790029607f67ab723e9e58225"></a><!-- doxytag: member="TelEngine::JIDFeatureList::remove" ref="044a40e790029607f67ab723e9e58225" args="(XMPPNamespace::Type feature)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void remove           </td>
          <td>(</td>
          <td class="paramtype">XMPPNamespace::Type&nbsp;</td>
          <td class="paramname"> <em>feature</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove a feature from the list <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>feature</em>&nbsp;</td><td>The feature to remove </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="xmpputils_8h-source.html">xmpputils.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 2008 for Yate by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>