classboost_1_1locale_1_1hold__ptr.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
  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. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>Boost.Locale: boost::locale::hold_ptr&lt; T &gt; Class Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  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. $(window).load(resizeHeight);
  17. </script>
  18. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19. </head>
  20. <body>
  21. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22. <div id="titlearea">
  23. <table cellspacing="0" cellpadding="0">
  24. <tbody>
  25. <tr style="height: 56px;">
  26. <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
  27. <td style="padding-left: 0.5em;">
  28. <div id="projectname">Boost.Locale
  29. </div>
  30. </td>
  31. </tr>
  32. </tbody>
  33. </table>
  34. </div>
  35. <!-- end header part -->
  36. <!-- Generated by Doxygen 1.8.6 -->
  37. <div id="navrow1" class="tabs">
  38. <ul class="tablist">
  39. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  43. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  44. <li><a href="files.html"><span>Files</span></a></li>
  45. <li><a href="examples.html"><span>Examples</span></a></li>
  46. </ul>
  47. </div>
  48. <div id="navrow2" class="tabs2">
  49. <ul class="tablist">
  50. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  51. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  52. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  53. </ul>
  54. </div>
  55. </div><!-- top -->
  56. <div id="side-nav" class="ui-resizable side-nav-resizable">
  57. <div id="nav-tree">
  58. <div id="nav-tree-contents">
  59. <div id="nav-sync" class="sync"></div>
  60. </div>
  61. </div>
  62. <div id="splitbar" style="-moz-user-select:none;"
  63. class="ui-resizable-handle">
  64. </div>
  65. </div>
  66. <script type="text/javascript">
  67. $(document).ready(function(){initNavTree('classboost_1_1locale_1_1hold__ptr.html','');});
  68. </script>
  69. <div id="doc-content">
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="classboost_1_1locale_1_1hold__ptr-members.html">List of all members</a> </div>
  74. <div class="headertitle">
  75. <div class="title">boost::locale::hold_ptr&lt; T &gt; Class Template Reference</div> </div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <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).
  79. <a href="classboost_1_1locale_1_1hold__ptr.html#details">More...</a></p>
  80. <p><code>#include &lt;<a class="el" href="hold__ptr_8hpp_source.html">boost/locale/hold_ptr.hpp</a>&gt;</code></p>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  83. Public Member Functions</h2></td></tr>
  84. <tr class="memitem:a681ee3d579435f9f2f171b830c402072"><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>
  85. <tr class="separator:a681ee3d579435f9f2f171b830c402072"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a0007514dc0410ccb16adf01c56874f52"><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>
  87. <tr class="separator:a0007514dc0410ccb16adf01c56874f52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:aace934e7a8b3f1880d1a06fa85795a48"><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>
  89. <tr class="separator:aace934e7a8b3f1880d1a06fa85795a48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a907a9385c1a15dab07aade7466620bf6"><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>
  91. <tr class="separator:a907a9385c1a15dab07aade7466620bf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a30dbc88eb9fde35198774f3ace282712"><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>
  93. <tr class="separator:a30dbc88eb9fde35198774f3ace282712"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a2c8a19e35ff3c57100b24371854f31b7"><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>
  95. <tr class="separator:a2c8a19e35ff3c57100b24371854f31b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:af99f3719b755b787b022253aa6f8d1c0"><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>
  97. <tr class="separator:af99f3719b755b787b022253aa6f8d1c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a7ae6b54ed5471dd9560904c7ff8a7971"><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>
  99. <tr class="separator:a7ae6b54ed5471dd9560904c7ff8a7971"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a474f2619452b63408e1e761f414328f4"><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>
  101. <tr class="separator:a474f2619452b63408e1e761f414328f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a2d7b2957c037589b65b2cdd4f61ebe03"><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>
  103. <tr class="separator:a2d7b2957c037589b65b2cdd4f61ebe03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:acb84b86bb220d663ffe13e5be9cfd72e"><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>
  105. <tr class="separator:acb84b86bb220d663ffe13e5be9cfd72e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a3e2640b5df80f86aeb68a6ee78dfd6f9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e2640b5df80f86aeb68a6ee78dfd6f9"></a>
  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 class="memdesc:a3e2640b5df80f86aeb68a6ee78dfd6f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Swap two pointers. <br/></td></tr>
  109. <tr class="separator:a3e2640b5df80f86aeb68a6ee78dfd6f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table>
  111. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  112. <div class="textblock"><h3>template&lt;typename T&gt;<br/>
  113. class boost::locale::hold_ptr&lt; T &gt;</h3>
  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><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  116. <a class="anchor" id="a681ee3d579435f9f2f171b830c402072"></a>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <div class="memtemplate">
  120. template&lt;typename T&gt; </div>
  121. <table class="mlabels">
  122. <tr>
  123. <td class="mlabels-left">
  124. <table class="memname">
  125. <tr>
  126. <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>
  127. <td>(</td>
  128. <td class="paramname"></td><td>)</td>
  129. <td></td>
  130. </tr>
  131. </table>
  132. </td>
  133. <td class="mlabels-right">
  134. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. <p>Create new empty pointer </p>
  139. </div>
  140. </div>
  141. <a class="anchor" id="a0007514dc0410ccb16adf01c56874f52"></a>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <div class="memtemplate">
  145. template&lt;typename T&gt; </div>
  146. <table class="mlabels">
  147. <tr>
  148. <td class="mlabels-left">
  149. <table class="memname">
  150. <tr>
  151. <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>
  152. <td>(</td>
  153. <td class="paramtype">T *&#160;</td>
  154. <td class="paramname"><em>v</em></td><td>)</td>
  155. <td></td>
  156. </tr>
  157. </table>
  158. </td>
  159. <td class="mlabels-right">
  160. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Create a pointer that holds <em>v</em>, ownership is transferred to smart pointer </p>
  165. </div>
  166. </div>
  167. <a class="anchor" id="aace934e7a8b3f1880d1a06fa85795a48"></a>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <div class="memtemplate">
  171. template&lt;typename T&gt; </div>
  172. <table class="mlabels">
  173. <tr>
  174. <td class="mlabels-left">
  175. <table class="memname">
  176. <tr>
  177. <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>
  178. <td>(</td>
  179. <td class="paramname"></td><td>)</td>
  180. <td></td>
  181. </tr>
  182. </table>
  183. </td>
  184. <td class="mlabels-right">
  185. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <p>Destroy smart pointer and the object it owns. </p>
  190. </div>
  191. </div>
  192. <h2 class="groupheader">Member Function Documentation</h2>
  193. <a class="anchor" id="a907a9385c1a15dab07aade7466620bf6"></a>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <div class="memtemplate">
  197. template&lt;typename T&gt; </div>
  198. <table class="mlabels">
  199. <tr>
  200. <td class="mlabels-left">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">T const* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::get </td>
  204. <td>(</td>
  205. <td class="paramname"></td><td>)</td>
  206. <td> const</td>
  207. </tr>
  208. </table>
  209. </td>
  210. <td class="mlabels-right">
  211. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. <p>Get a const pointer to the object </p>
  216. </div>
  217. </div>
  218. <a class="anchor" id="a30dbc88eb9fde35198774f3ace282712"></a>
  219. <div class="memitem">
  220. <div class="memproto">
  221. <div class="memtemplate">
  222. template&lt;typename T&gt; </div>
  223. <table class="mlabels">
  224. <tr>
  225. <td class="mlabels-left">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">T* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::get </td>
  229. <td>(</td>
  230. <td class="paramname"></td><td>)</td>
  231. <td></td>
  232. </tr>
  233. </table>
  234. </td>
  235. <td class="mlabels-right">
  236. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. <p>Get a mutable pointer to the object </p>
  241. </div>
  242. </div>
  243. <a class="anchor" id="a2c8a19e35ff3c57100b24371854f31b7"></a>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <div class="memtemplate">
  247. template&lt;typename T&gt; </div>
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <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>
  254. <td>(</td>
  255. <td class="paramname"></td><td>)</td>
  256. <td> const</td>
  257. </tr>
  258. </table>
  259. </td>
  260. <td class="mlabels-right">
  261. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. <p>Get a const reference to the object </p>
  266. </div>
  267. </div>
  268. <a class="anchor" id="af99f3719b755b787b022253aa6f8d1c0"></a>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <div class="memtemplate">
  272. template&lt;typename T&gt; </div>
  273. <table class="mlabels">
  274. <tr>
  275. <td class="mlabels-left">
  276. <table class="memname">
  277. <tr>
  278. <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>
  279. <td>(</td>
  280. <td class="paramname"></td><td>)</td>
  281. <td></td>
  282. </tr>
  283. </table>
  284. </td>
  285. <td class="mlabels-right">
  286. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  287. </tr>
  288. </table>
  289. </div><div class="memdoc">
  290. <p>Get a mutable reference to the object </p>
  291. </div>
  292. </div>
  293. <a class="anchor" id="a7ae6b54ed5471dd9560904c7ff8a7971"></a>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <div class="memtemplate">
  297. template&lt;typename T&gt; </div>
  298. <table class="mlabels">
  299. <tr>
  300. <td class="mlabels-left">
  301. <table class="memname">
  302. <tr>
  303. <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>
  304. <td>(</td>
  305. <td class="paramname"></td><td>)</td>
  306. <td> const</td>
  307. </tr>
  308. </table>
  309. </td>
  310. <td class="mlabels-right">
  311. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. <p>Get a const pointer to the object </p>
  316. </div>
  317. </div>
  318. <a class="anchor" id="a474f2619452b63408e1e761f414328f4"></a>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <div class="memtemplate">
  322. template&lt;typename T&gt; </div>
  323. <table class="mlabels">
  324. <tr>
  325. <td class="mlabels-left">
  326. <table class="memname">
  327. <tr>
  328. <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>
  329. <td>(</td>
  330. <td class="paramname"></td><td>)</td>
  331. <td></td>
  332. </tr>
  333. </table>
  334. </td>
  335. <td class="mlabels-right">
  336. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  337. </tr>
  338. </table>
  339. </div><div class="memdoc">
  340. <p>Get a mutable pointer to the object </p>
  341. </div>
  342. </div>
  343. <a class="anchor" id="a2d7b2957c037589b65b2cdd4f61ebe03"></a>
  344. <div class="memitem">
  345. <div class="memproto">
  346. <div class="memtemplate">
  347. template&lt;typename T&gt; </div>
  348. <table class="mlabels">
  349. <tr>
  350. <td class="mlabels-left">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">T* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::release </td>
  354. <td>(</td>
  355. <td class="paramname"></td><td>)</td>
  356. <td></td>
  357. </tr>
  358. </table>
  359. </td>
  360. <td class="mlabels-right">
  361. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  362. </tr>
  363. </table>
  364. </div><div class="memdoc">
  365. <p>Transfer an ownership on the pointer to user </p>
  366. </div>
  367. </div>
  368. <a class="anchor" id="acb84b86bb220d663ffe13e5be9cfd72e"></a>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <div class="memtemplate">
  372. template&lt;typename T&gt; </div>
  373. <table class="mlabels">
  374. <tr>
  375. <td class="mlabels-left">
  376. <table class="memname">
  377. <tr>
  378. <td class="memname">void <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::reset </td>
  379. <td>(</td>
  380. <td class="paramtype">T *&#160;</td>
  381. <td class="paramname"><em>p</em> = <code>0</code></td><td>)</td>
  382. <td></td>
  383. </tr>
  384. </table>
  385. </td>
  386. <td class="mlabels-right">
  387. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  388. </tr>
  389. </table>
  390. </div><div class="memdoc">
  391. <p>Set new value to pointer, previous object is destroyed, ownership on new object is transferred </p>
  392. </div>
  393. </div>
  394. <hr/>The documentation for this class was generated from the following file:<ul>
  395. <li>boost/locale/<a class="el" href="hold__ptr_8hpp_source.html">hold_ptr.hpp</a></li>
  396. </ul>
  397. </div><!-- contents -->
  398. </div><!-- doc-content -->
  399. <li class="footer">
  400. &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.
  401. </li>
  402. </ul>
  403. </div>
  404. </body>
  405. </html>