libs/locale/doc/html/classboost_1_1locale_1_1hold__ptr.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>Boost.Locale: boost::locale::hold_ptr&lt; T &gt; Class Template Reference</title>
   7
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="jquery.js"></script>
  12 <script type="text/javascript" src="resize.js"></script>
  13 <script type="text/javascript" src="navtree.js"></script>
  14 <script type="text/javascript">
  15   $(document).ready(initResizable);
  16 </script>
  17
  18
  19 </head>
  20 <body>
  21 <div id="top"><!-- do not remove this div! -->
  22
  23
  24 <div id="titlearea">
  25 <table cellspacing="0" cellpadding="0">
  26  <tbody>
  27  <tr style="height: 56px;">
  28
  29   <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
  30
  31
  32   <td style="padding-left: 0.5em;">
  33    <div id="projectname">Boost.Locale
  34
  35    </div>
  36
  37   </td>
  38
  39
  40
  41  </tr>
  42  </tbody>
  43 </table>
  44 </div>
  45
  46 <!-- Generated by Doxygen 1.7.6.1 -->
  47   <div id="navrow1" class="tabs">
  48     <ul class="tablist">
  49       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  50       <li><a href="modules.html"><span>Modules</span></a></li>
  51       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  52       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  53       <li><a href="files.html"><span>Files</span></a></li>
  54       <li><a href="examples.html"><span>Examples</span></a></li>
  55     </ul>
  56   </div>
  57   <div id="navrow2" class="tabs2">
  58     <ul class="tablist">
  59       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  60       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  61       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  62     </ul>
  63   </div>
  64 </div>
  65 <div id="side-nav" class="ui-resizable side-nav-resizable">
  66   <div id="nav-tree">
  67     <div id="nav-tree-contents">
  68     </div>
  69   </div>
  70   <div id="splitbar" style="-moz-user-select:none;"
  71        class="ui-resizable-handle">
  72   </div>
  73 </div>
  74 <script type="text/javascript">
  75   initNavTree('classboost_1_1locale_1_1hold__ptr.html','');
  76 </script>
  77 <div id="doc-content">
  78 <div class="header">
  79   <div class="summary">
  80 <a href="#pub-methods">Public Member Functions</a>  </div>
  81   <div class="headertitle">
  82 <div class="title">boost::locale::hold_ptr&lt; T &gt; Class Template Reference</div>  </div>
  83 </div><!--header-->
  84 <div class="contents">
  85 <!-- doxytag: class="boost::locale::hold_ptr" -->
  86 <p>a smart pointer similar to std::auto_ptr but it is non-copyable and the underlying object has the same constness as the pointer itself (unlike an ordinary pointer).
  87  <a href="classboost_1_1locale_1_1hold__ptr.html#details">More...</a></p>
  88
  89 <p><code>#include &lt;<a class="el" href="hold__ptr_8hpp_source.html">boost/locale/hold_ptr.hpp</a>&gt;</code></p>
  90
  91 <p><a href="classboost_1_1locale_1_1hold__ptr-members.html">List of all members.</a></p>
  92 <table class="memberdecls">
  93 <tr><td colspan="2"><h2><a name="pub-methods"></a>
  94 Public Member Functions</h2></td></tr>
  95 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a681ee3d579435f9f2f171b830c402072">hold_ptr</a> ()</td></tr>
  96 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a0007514dc0410ccb16adf01c56874f52">hold_ptr</a> (T *v)</td></tr>
  97 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#aace934e7a8b3f1880d1a06fa85795a48">~hold_ptr</a> ()</td></tr>
  98 <tr><td class="memItemLeft" align="right" valign="top">T const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a907a9385c1a15dab07aade7466620bf6">get</a> () const </td></tr>
  99 <tr><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a30dbc88eb9fde35198774f3ace282712">get</a> ()</td></tr>
 100 <tr><td class="memItemLeft" align="right" valign="top">T const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a2c8a19e35ff3c57100b24371854f31b7">operator*</a> () const </td></tr>
 101 <tr><td class="memItemLeft" align="right" valign="top">T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#af99f3719b755b787b022253aa6f8d1c0">operator*</a> ()</td></tr>
 102 <tr><td class="memItemLeft" align="right" valign="top">T const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a7ae6b54ed5471dd9560904c7ff8a7971">operator-&gt;</a> () const </td></tr>
 103 <tr><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a474f2619452b63408e1e761f414328f4">operator-&gt;</a> ()</td></tr>
 104 <tr><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a2d7b2957c037589b65b2cdd4f61ebe03">release</a> ()</td></tr>
 105 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#acb84b86bb220d663ffe13e5be9cfd72e">reset</a> (T *p=0)</td></tr>
 106 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e2640b5df80f86aeb68a6ee78dfd6f9"></a><!-- doxytag: member="boost::locale::hold_ptr::swap" ref="a3e2640b5df80f86aeb68a6ee78dfd6f9" args="(hold_ptr &amp;other)" -->
 107 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a3e2640b5df80f86aeb68a6ee78dfd6f9">swap</a> (<a class="el" href="classboost_1_1locale_1_1hold__ptr.html">hold_ptr</a> &amp;other)</td></tr>
 108 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Swap two pointers. <br/></td></tr>
 109 </table>
 110 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
 111 <div class="textblock"><h3>template&lt;typename T&gt;<br/>
 112 class boost::locale::hold_ptr&lt; T &gt;</h3>
 113
 114 <p>a smart pointer similar to std::auto_ptr but it is non-copyable and the underlying object has the same constness as the pointer itself (unlike an ordinary pointer). </p>
 115 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
 116 <a class="anchor" id="a681ee3d579435f9f2f171b830c402072"></a><!-- doxytag: member="boost::locale::hold_ptr::hold_ptr" ref="a681ee3d579435f9f2f171b830c402072" args="()" -->
 117 <div class="memitem">
 118 <div class="memproto">
 119 <div class="memtemplate">
 120 template&lt;typename T&gt; </div>
 121       <table class="memname">
 122         <tr>
 123           <td class="memname"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::<a class="el" href="classboost_1_1locale_1_1hold__ptr.html">hold_ptr</a> </td>
 124           <td>(</td>
 125           <td class="paramname"></td><td>)</td>
 126           <td><code> [inline]</code></td>
 127         </tr>
 128       </table>
 129 </div>
 130 <div class="memdoc">
 131 <p>Create new empty pointer </p>
 132
 133 </div>
 134 </div>
 135 <a class="anchor" id="a0007514dc0410ccb16adf01c56874f52"></a><!-- doxytag: member="boost::locale::hold_ptr::hold_ptr" ref="a0007514dc0410ccb16adf01c56874f52" args="(T *v)" -->
 136 <div class="memitem">
 137 <div class="memproto">
 138 <div class="memtemplate">
 139 template&lt;typename T&gt; </div>
 140       <table class="memname">
 141         <tr>
 142           <td class="memname"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::<a class="el" href="classboost_1_1locale_1_1hold__ptr.html">hold_ptr</a> </td>
 143           <td>(</td>
 144           <td class="paramtype">T *&#160;</td>
 145           <td class="paramname"><em>v</em></td><td>)</td>
 146           <td><code> [inline, explicit]</code></td>
 147         </tr>
 148       </table>
 149 </div>
 150 <div class="memdoc">
 151 <p>Create a pointer that holds <em>v</em>, ownership is transferred to smart pointer </p>
 152
 153 </div>
 154 </div>
 155 <a class="anchor" id="aace934e7a8b3f1880d1a06fa85795a48"></a><!-- doxytag: member="boost::locale::hold_ptr::~hold_ptr" ref="aace934e7a8b3f1880d1a06fa85795a48" args="()" -->
 156 <div class="memitem">
 157 <div class="memproto">
 158 <div class="memtemplate">
 159 template&lt;typename T&gt; </div>
 160       <table class="memname">
 161         <tr>
 162           <td class="memname"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::~<a class="el" href="classboost_1_1locale_1_1hold__ptr.html">hold_ptr</a> </td>
 163           <td>(</td>
 164           <td class="paramname"></td><td>)</td>
 165           <td><code> [inline]</code></td>
 166         </tr>
 167       </table>
 168 </div>
 169 <div class="memdoc">
 170 <p>Destroy smart pointer and the object it owns. </p>
 171
 172 </div>
 173 </div>
 174 <hr/><h2>Member Function Documentation</h2>
 175 <a class="anchor" id="a907a9385c1a15dab07aade7466620bf6"></a><!-- doxytag: member="boost::locale::hold_ptr::get" ref="a907a9385c1a15dab07aade7466620bf6" args="() const " -->
 176 <div class="memitem">
 177 <div class="memproto">
 178 <div class="memtemplate">
 179 template&lt;typename T&gt; </div>
 180       <table class="memname">
 181         <tr>
 182           <td class="memname">T const* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::<a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a907a9385c1a15dab07aade7466620bf6">get</a> </td>
 183           <td>(</td>
 184           <td class="paramname"></td><td>)</td>
 185           <td> const<code> [inline]</code></td>
 186         </tr>
 187       </table>
 188 </div>
 189 <div class="memdoc">
 190 <p>Get a const pointer to the object </p>
 191
 192 </div>
 193 </div>
 194 <a class="anchor" id="a30dbc88eb9fde35198774f3ace282712"></a><!-- doxytag: member="boost::locale::hold_ptr::get" ref="a30dbc88eb9fde35198774f3ace282712" args="()" -->
 195 <div class="memitem">
 196 <div class="memproto">
 197 <div class="memtemplate">
 198 template&lt;typename T&gt; </div>
 199       <table class="memname">
 200         <tr>
 201           <td class="memname">T* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::<a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a907a9385c1a15dab07aade7466620bf6">get</a> </td>
 202           <td>(</td>
 203           <td class="paramname"></td><td>)</td>
 204           <td><code> [inline]</code></td>
 205         </tr>
 206       </table>
 207 </div>
 208 <div class="memdoc">
 209 <p>Get a mutable pointer to the object </p>
 210
 211 </div>
 212 </div>
 213 <a class="anchor" id="a2c8a19e35ff3c57100b24371854f31b7"></a><!-- doxytag: member="boost::locale::hold_ptr::operator*" ref="a2c8a19e35ff3c57100b24371854f31b7" args="() const " -->
 214 <div class="memitem">
 215 <div class="memproto">
 216 <div class="memtemplate">
 217 template&lt;typename T&gt; </div>
 218       <table class="memname">
 219         <tr>
 220           <td class="memname">T const&amp; <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::operator* </td>
 221           <td>(</td>
 222           <td class="paramname"></td><td>)</td>
 223           <td> const<code> [inline]</code></td>
 224         </tr>
 225       </table>
 226 </div>
 227 <div class="memdoc">
 228 <p>Get a const reference to the object </p>
 229
 230 </div>
 231 </div>
 232 <a class="anchor" id="af99f3719b755b787b022253aa6f8d1c0"></a><!-- doxytag: member="boost::locale::hold_ptr::operator*" ref="af99f3719b755b787b022253aa6f8d1c0" args="()" -->
 233 <div class="memitem">
 234 <div class="memproto">
 235 <div class="memtemplate">
 236 template&lt;typename T&gt; </div>
 237       <table class="memname">
 238         <tr>
 239           <td class="memname">T&amp; <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::operator* </td>
 240           <td>(</td>
 241           <td class="paramname"></td><td>)</td>
 242           <td><code> [inline]</code></td>
 243         </tr>
 244       </table>
 245 </div>
 246 <div class="memdoc">
 247 <p>Get a mutable reference to the object </p>
 248
 249 </div>
 250 </div>
 251 <a class="anchor" id="a7ae6b54ed5471dd9560904c7ff8a7971"></a><!-- doxytag: member="boost::locale::hold_ptr::operator&#45;&gt;" ref="a7ae6b54ed5471dd9560904c7ff8a7971" args="() const " -->
 252 <div class="memitem">
 253 <div class="memproto">
 254 <div class="memtemplate">
 255 template&lt;typename T&gt; </div>
 256       <table class="memname">
 257         <tr>
 258           <td class="memname">T const* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::operator-&gt; </td>
 259           <td>(</td>
 260           <td class="paramname"></td><td>)</td>
 261           <td> const<code> [inline]</code></td>
 262         </tr>
 263       </table>
 264 </div>
 265 <div class="memdoc">
 266 <p>Get a const pointer to the object </p>
 267
 268 </div>
 269 </div>
 270 <a class="anchor" id="a474f2619452b63408e1e761f414328f4"></a><!-- doxytag: member="boost::locale::hold_ptr::operator&#45;&gt;" ref="a474f2619452b63408e1e761f414328f4" args="()" -->
 271 <div class="memitem">
 272 <div class="memproto">
 273 <div class="memtemplate">
 274 template&lt;typename T&gt; </div>
 275       <table class="memname">
 276         <tr>
 277           <td class="memname">T* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::operator-&gt; </td>
 278           <td>(</td>
 279           <td class="paramname"></td><td>)</td>
 280           <td><code> [inline]</code></td>
 281         </tr>
 282       </table>
 283 </div>
 284 <div class="memdoc">
 285 <p>Get a mutable pointer to the object </p>
 286
 287 </div>
 288 </div>
 289 <a class="anchor" id="a2d7b2957c037589b65b2cdd4f61ebe03"></a><!-- doxytag: member="boost::locale::hold_ptr::release" ref="a2d7b2957c037589b65b2cdd4f61ebe03" args="()" -->
 290 <div class="memitem">
 291 <div class="memproto">
 292 <div class="memtemplate">
 293 template&lt;typename T&gt; </div>
 294       <table class="memname">
 295         <tr>
 296           <td class="memname">T* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::<a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a2d7b2957c037589b65b2cdd4f61ebe03">release</a> </td>
 297           <td>(</td>
 298           <td class="paramname"></td><td>)</td>
 299           <td><code> [inline]</code></td>
 300         </tr>
 301       </table>
 302 </div>
 303 <div class="memdoc">
 304 <p>Transfer an ownership on the pointer to user </p>
 305
 306 </div>
 307 </div>
 308 <a class="anchor" id="acb84b86bb220d663ffe13e5be9cfd72e"></a><!-- doxytag: member="boost::locale::hold_ptr::reset" ref="acb84b86bb220d663ffe13e5be9cfd72e" args="(T *p=0)" -->
 309 <div class="memitem">
 310 <div class="memproto">
 311 <div class="memtemplate">
 312 template&lt;typename T&gt; </div>
 313       <table class="memname">
 314         <tr>
 315           <td class="memname">void <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::<a class="el" href="classboost_1_1locale_1_1hold__ptr.html#acb84b86bb220d663ffe13e5be9cfd72e">reset</a> </td>
 316           <td>(</td>
 317           <td class="paramtype">T *&#160;</td>
 318           <td class="paramname"><em>p</em> = <code>0</code></td><td>)</td>
 319           <td><code> [inline]</code></td>
 320         </tr>
 321       </table>
 322 </div>
 323 <div class="memdoc">
 324 <p>Set new value to pointer, previous object is destroyed, ownership on new object is transferred </p>
 325
 326 </div>
 327 </div>
 328 <hr/>The documentation for this class was generated from the following file:<ul>
 329 <li>boost/locale/<a class="el" href="hold__ptr_8hpp_source.html">hold_ptr.hpp</a></li>
 330 </ul>
 331 </div><!-- contents -->
 332 </div>
 333   <div id="nav-path" class="navpath">
 334     <ul>
 335       <li class="navelem"><b>boost</b>      </li>
 336       <li class="navelem"><a class="el" href="namespaceboost_1_1locale.html">locale</a>      </li>
 337       <li class="navelem"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html">hold_ptr</a>      </li>
 338
 339     <li class="footer">
 340 &copy; Copyright 2009-2012 Artyom Beilis,  Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0.
 341     </li>
 342    </ul>
 343  </div>
 344
 345
 346 </body>
 347 </html>