doc/third_party/Pluma/html/classpluma_1_1Host.htm

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3     <head>
   4         <title>Pluma - Plug-in Management Framework</title>
   5         <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
   6         <link href="doxygen.css" rel="stylesheet" type="text/css" />
   7         <link href="tabs.css" rel="stylesheet" type="text/css" />
   8     </head>
   9     <body>
  10         <div id="logo">
  11             <img src="./logo.png" title="Pluma home" alt="Pluma logo" />
  12         </div>
  13 <!-- Generated by Doxygen 1.8.6 -->
  14   <div id="navrow1" class="tabs">
  15     <ul class="tablist">
  16       <li><a href="index.htm"><span>Main&#160;Page</span></a></li>
  17       <li class="current"><a href="annotated.htm"><span>Classes</span></a></li>
  18       <li><a href="files.htm"><span>Files</span></a></li>
  19     </ul>
  20   </div>
  21   <div id="navrow2" class="tabs2">
  22     <ul class="tablist">
  23       <li><a href="annotated.htm"><span>Class&#160;List</span></a></li>
  24       <li><a href="classes.htm"><span>Class&#160;Index</span></a></li>
  25       <li><a href="hierarchy.htm"><span>Class&#160;Hierarchy</span></a></li>
  26       <li><a href="functions.htm"><span>Class&#160;Members</span></a></li>
  27     </ul>
  28   </div>
  29 <div id="nav-path" class="navpath">
  30   <ul>
  31 <li class="navelem"><b>pluma</b></li><li class="navelem"><a class="el" href="classpluma_1_1Host.htm">Host</a></li>  </ul>
  32 </div>
  33 </div><!-- top -->
  34 <div class="header">
  35   <div class="summary">
  36 <a href="#nested-classes">Classes</a> &#124;
  37 <a href="#pub-methods">Public Member Functions</a> &#124;
  38 <a href="#friends">Friends</a> &#124;
  39 <a href="classpluma_1_1Host-members.htm">List of all members</a>  </div>
  40   <div class="headertitle">
  41 <div class="title">pluma::Host Class Reference</div>  </div>
  42 </div><!--header-->
  43 <div class="contents">
  44
  45 <p>Manages providers.
  46  <a href="classpluma_1_1Host.htm#details">More...</a></p>
  47
  48 <p><code>#include &lt;<a class="el" href="Host_8hpp_source.htm">Host.hpp</a>&gt;</code></p>
  49 <table class="memberdecls">
  50 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  51 Public Member Functions</h2></td></tr>
  52 <tr class="memitem:ab673ba94ff56a12cdf2a7a25ebb8cc36"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpluma_1_1Host.htm#ab673ba94ff56a12cdf2a7a25ebb8cc36">add</a> (<a class="el" href="classpluma_1_1Provider.htm">Provider</a> *provider)</td></tr>
  53 <tr class="memdesc:ab673ba94ff56a12cdf2a7a25ebb8cc36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add provider.  <a href="#ab673ba94ff56a12cdf2a7a25ebb8cc36">More...</a><br/></td></tr>
  54 <tr class="separator:ab673ba94ff56a12cdf2a7a25ebb8cc36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55 </table><table class="memberdecls">
  56 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  57 Friends</h2></td></tr>
  58 <tr class="memitem:ad0ccd35859b04e162412b22bf5200374"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0ccd35859b04e162412b22bf5200374"></a>
  59 class&#160;</td><td class="memItemRight" valign="bottom"><b>PluginManager</b></td></tr>
  60 <tr class="separator:ad0ccd35859b04e162412b22bf5200374"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:a70ab087352a74128b9608cf9e7d24c71"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70ab087352a74128b9608cf9e7d24c71"></a>
  62 class&#160;</td><td class="memItemRight" valign="bottom"><b>Provider</b></td></tr>
  63 <tr class="separator:a70ab087352a74128b9608cf9e7d24c71"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 </table>
  65 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  66 <div class="textblock"><p>Manages providers. </p>
  67
  68 <p>Definition at line <a class="el" href="Host_8hpp_source.htm#l00044">44</a> of file <a class="el" href="Host_8hpp_source.htm">Host.hpp</a>.</p>
  69 </div><h2 class="groupheader">Member Function Documentation</h2>
  70 <a class="anchor" id="ab673ba94ff56a12cdf2a7a25ebb8cc36"></a>
  71 <div class="memitem">
  72 <div class="memproto">
  73       <table class="memname">
  74         <tr>
  75           <td class="memname">bool pluma::Host::add </td>
  76           <td>(</td>
  77           <td class="paramtype"><a class="el" href="classpluma_1_1Provider.htm">Provider</a> *&#160;</td>
  78           <td class="paramname"><em>provider</em></td><td>)</td>
  79           <td></td>
  80         </tr>
  81       </table>
  82 </div><div class="memdoc">
  83
  84 <p>Add provider. </p>
  85 <p><a class="el" href="classpluma_1_1Provider.htm" title="Interface to provide applications with objects from plugins. ">Provider</a> type and version are checked. Only known and valid provider types are accepted.</p>
  86 <dl class="params"><dt>Parameters</dt><dd>
  87   <table class="params">
  88     <tr><td class="paramname">provider</td><td><a class="el" href="classpluma_1_1Provider.htm" title="Interface to provide applications with objects from plugins. ">Provider</a> to be added.</td></tr>
  89   </table>
  90   </dd>
  91 </dl>
  92 <dl class="section return"><dt>Returns</dt><dd>True if the provider is accepted. </dd></dl>
  93
  94 <p>Definition at line <a class="el" href="Host_8cpp_source.htm#l00042">42</a> of file <a class="el" href="Host_8cpp_source.htm">Host.cpp</a>.</p>
  95
  96 </div>
  97 </div>
  98 <hr/>The documentation for this class was generated from the following files:<ul>
  99 <li><a class="el" href="Host_8hpp_source.htm">Host.hpp</a></li>
 100 <li><a class="el" href="Host_8cpp_source.htm">Host.cpp</a></li>
 101 </ul>
 102 </div><!-- contents -->
 103
 104         <p id="footer">
 105             &nbsp;::&nbsp; Copyright &copy; 2011 Gil Costa, all rights reserved &nbsp;::&nbsp;
 106             Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.7.4</a> &nbsp;::&nbsp;
 107         </p>
 108     </body>
 109 </html>