blob: 4174f106bb285315ee45e775e1859304e3508d1a [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Skia: SkAutoUnref Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.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>
<div class="contents">
<h1>SkAutoUnref Class Reference</h1><!-- doxytag: class="SkAutoUnref" -->
<p><code>#include &lt;<a class="el" href="_sk_ref_cnt_8h_source.html">SkRefCnt.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for SkAutoUnref:</div>
<div class="dynsection">
<div class="center"><img src="class_sk_auto_unref__coll__graph.png" border="0" usemap="#_sk_auto_unref_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_sk_auto_unref-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_auto_unref.html#a63e3213303aa5326a8df230c673a4989">SkAutoUnref</a> (<a class="el" href="class_sk_ref_cnt.html">SkRefCnt</a> *obj)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_auto_unref.html#ae08c669dafbdc7b6c7a7bcd31389a9e5">~SkAutoUnref</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sk_ref_cnt.html">SkRefCnt</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_auto_unref.html#a5fac52d6cb23d52bb1f5acc5abba8265">get</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_auto_unref.html#a5d78bc6658cfb444162da61a45a1d626">ref</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_auto_unref.html#a2c49fc106be8f0462ed65ef80ba94077">unref</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sk_ref_cnt.html">SkRefCnt</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_auto_unref.html#a9a4b14b3315d2305c68a8bfe689487d5">detach</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_sk_auto_unref.html">SkAutoUnref</a> is a stack-helper class that will automatically call <a class="el" href="class_sk_auto_unref.html#a2c49fc106be8f0462ed65ef80ba94077">unref()</a> on the object it points to when the <a class="el" href="class_sk_auto_unref.html">SkAutoUnref</a> object goes out of scope. If obj is null, do nothing. </p>
<p>Definition at line <a class="el" href="_sk_ref_cnt_8h_source.html#l00094">94</a> of file <a class="el" href="_sk_ref_cnt_8h_source.html">SkRefCnt.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a63e3213303aa5326a8df230c673a4989"></a><!-- doxytag: member="SkAutoUnref::SkAutoUnref" ref="a63e3213303aa5326a8df230c673a4989" args="(SkRefCnt *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SkAutoUnref::SkAutoUnref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_ref_cnt.html">SkRefCnt</a> *&nbsp;</td>
<td class="paramname"> <em>obj</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_sk_ref_cnt_8h_source.html#l00096">96</a> of file <a class="el" href="_sk_ref_cnt_8h_source.html">SkRefCnt.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae08c669dafbdc7b6c7a7bcd31389a9e5"></a><!-- doxytag: member="SkAutoUnref::~SkAutoUnref" ref="ae08c669dafbdc7b6c7a7bcd31389a9e5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SkAutoUnref::~SkAutoUnref </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9a4b14b3315d2305c68a8bfe689487d5"></a><!-- doxytag: member="SkAutoUnref::detach" ref="a9a4b14b3315d2305c68a8bfe689487d5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_sk_ref_cnt.html">SkRefCnt</a>* SkAutoUnref::detach </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the hosted object is null, do nothing and return NULL, else call <a class="el" href="class_sk_auto_unref.html#a2c49fc106be8f0462ed65ef80ba94077">unref()</a> on it, set its reference to null, and return the object </p>
</div>
</div>
<a class="anchor" id="a5fac52d6cb23d52bb1f5acc5abba8265"></a><!-- doxytag: member="SkAutoUnref::get" ref="a5fac52d6cb23d52bb1f5acc5abba8265" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_sk_ref_cnt.html">SkRefCnt</a>* SkAutoUnref::get </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_sk_ref_cnt_8h_source.html#l00099">99</a> of file <a class="el" href="_sk_ref_cnt_8h_source.html">SkRefCnt.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5d78bc6658cfb444162da61a45a1d626"></a><!-- doxytag: member="SkAutoUnref::ref" ref="a5d78bc6658cfb444162da61a45a1d626" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SkAutoUnref::ref </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the hosted object is null, do nothing and return false, else call <a class="el" href="class_sk_auto_unref.html#a5d78bc6658cfb444162da61a45a1d626">ref()</a> on it and return true </p>
</div>
</div>
<a class="anchor" id="a2c49fc106be8f0462ed65ef80ba94077"></a><!-- doxytag: member="SkAutoUnref::unref" ref="a2c49fc106be8f0462ed65ef80ba94077" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SkAutoUnref::unref </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the hosted object is null, do nothing and return false, else call <a class="el" href="class_sk_auto_unref.html#a2c49fc106be8f0462ed65ef80ba94077">unref()</a> on it, set its reference to null, and return true </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/core/<a class="el" href="_sk_ref_cnt_8h_source.html">SkRefCnt.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Oct 20 11:03:41 2009 for Skia by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>