Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > bf5ad49bf8714f68fa4d0bb1597cb497 > files > 59

cairomm-doc-1.9.8-2.fc15.2.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
        <title>cairomm: Cairo::SurfacePattern Class Reference</title>
        <link href="cairomm.css" rel="stylesheet" type="text/css">
    </head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</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="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><a class="el" href="namespaceCairo.html">Cairo</a>      </li>
      <li><a class="el" href="classCairo_1_1SurfacePattern.html">Cairo::SurfacePattern</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<h1>Cairo::SurfacePattern Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Cairo::SurfacePattern" --><!-- doxytag: inherits="Cairo::Pattern" -->
<p>Inherits <a class="el" href="classCairo_1_1Pattern.html">Cairo::Pattern</a>.</p>

<p><a href="classCairo_1_1SurfacePattern-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SurfacePattern.html#a9461babece82be067b48e6491c7ab1ad">SurfacePattern</a> (cairo_pattern_t*<a class="el" href="classCairo_1_1Pattern.html#a430a261a68ae70ca1bd818c781178abc">cobject</a>, bool has_reference=false)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a C++ wrapper for the C instance.  <a href="#a9461babece82be067b48e6491c7ab1ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt; const <a class="el" href="classCairo_1_1Surface.html">Surface</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SurfacePattern.html#aad4763fd999ca2dc1094b07e5f357646">get_surface</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the surface associated with this pattern.  <a href="#aad4763fd999ca2dc1094b07e5f357646"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt; <a class="el" href="classCairo_1_1Surface.html">Surface</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SurfacePattern.html#ac830d137dad794e71d7bf83df22f06ae">get_surface</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the surface associated with this pattern.  <a href="#ac830d137dad794e71d7bf83df22f06ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SurfacePattern.html#aa1796fde1cf9f134387057d03df83a61">~SurfacePattern</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SurfacePattern.html#a8b238004a061f34425ee61a2ba494632">set_extend</a> (<a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5">Extend</a> extend)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5">Extend</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SurfacePattern.html#a45055101fc89432f9ce1438878a6d0c8">get_extend</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SurfacePattern.html#a4d1517f554ffb2821e939aed01899022">set_filter</a> (<a class="el" href="namespaceCairo.html#a92b32ad7db301e18386477566c1caa6a">Filter</a> filter)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCairo.html#a92b32ad7db301e18386477566c1caa6a">Filter</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SurfacePattern.html#acbaef3a3961c04c275b6e44fea323b42">get_filter</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt; <a class="el" href="classCairo_1_1SurfacePattern.html">SurfacePattern</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SurfacePattern.html#aeb0cd6f03f993c6c9e64b32cc805fd77">create</a> (const <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt; <a class="el" href="classCairo_1_1Surface.html">Surface</a> &gt;&amp; surface)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SurfacePattern.html#a69b713eb59cec9ef25f586d6f14c2dda">SurfacePattern</a> (const <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt; <a class="el" href="classCairo_1_1Surface.html">Surface</a> &gt;&amp; surface)</td></tr>
</table>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a69b713eb59cec9ef25f586d6f14c2dda"></a><!-- doxytag: member="Cairo::SurfacePattern::SurfacePattern" ref="a69b713eb59cec9ef25f586d6f14c2dda" args="(const RefPtr&lt; Surface &gt; &amp;surface)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Cairo::SurfacePattern::SurfacePattern </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt; <a class="el" href="classCairo_1_1Surface.html">Surface</a> &gt;&amp;&#160;</td>
          <td class="paramname"> <em>surface</em></td>
          <td>&#160;)&#160;</td>
          <td><code> [explicit, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a9461babece82be067b48e6491c7ab1ad"></a><!-- doxytag: member="Cairo::SurfacePattern::SurfacePattern" ref="a9461babece82be067b48e6491c7ab1ad" args="(cairo_pattern_t *cobject, bool has_reference=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Cairo::SurfacePattern::SurfacePattern </td>
          <td>(</td>
          <td class="paramtype">cairo_pattern_t *&#160;</td>
          <td class="paramname"> <em>cobject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"> <em>has_reference</em> = <code>false</code></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a C++ wrapper for the C instance. </p>
<p>This C++ instance should then be given to a <a class="el" href="classCairo_1_1RefPtr.html" title="RefPtr&lt;&gt; is a reference-counting shared smartpointer.">RefPtr</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>cobject</em>&#160;</td><td>The C instance. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>has_reference</em>&#160;</td><td>Whether we already have a reference. Otherwise, the constructor will take an extra reference. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aa1796fde1cf9f134387057d03df83a61"></a><!-- doxytag: member="Cairo::SurfacePattern::~SurfacePattern" ref="aa1796fde1cf9f134387057d03df83a61" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Cairo::SurfacePattern::~SurfacePattern </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aeb0cd6f03f993c6c9e64b32cc805fd77"></a><!-- doxytag: member="Cairo::SurfacePattern::create" ref="aeb0cd6f03f993c6c9e64b32cc805fd77" args="(const RefPtr&lt; Surface &gt; &amp;surface)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt;<a class="el" href="classCairo_1_1SurfacePattern.html">SurfacePattern</a>&gt; Cairo::SurfacePattern::create </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt; <a class="el" href="classCairo_1_1Surface.html">Surface</a> &gt;&amp;&#160;</td>
          <td class="paramname"> <em>surface</em></td>
          <td>&#160;)&#160;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a45055101fc89432f9ce1438878a6d0c8"></a><!-- doxytag: member="Cairo::SurfacePattern::get_extend" ref="a45055101fc89432f9ce1438878a6d0c8" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5">Extend</a> Cairo::SurfacePattern::get_extend </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="acbaef3a3961c04c275b6e44fea323b42"></a><!-- doxytag: member="Cairo::SurfacePattern::get_filter" ref="acbaef3a3961c04c275b6e44fea323b42" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceCairo.html#a92b32ad7db301e18386477566c1caa6a">Filter</a> Cairo::SurfacePattern::get_filter </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ac830d137dad794e71d7bf83df22f06ae"></a><!-- doxytag: member="Cairo::SurfacePattern::get_surface" ref="ac830d137dad794e71d7bf83df22f06ae" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt;<a class="el" href="classCairo_1_1Surface.html">Surface</a>&gt; Cairo::SurfacePattern::get_surface </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the surface associated with this pattern. </p>
<dl class="since"><dt><b>Since:</b></dt><dd>1.4 </dd></dl>

</div>
</div>
<a class="anchor" id="aad4763fd999ca2dc1094b07e5f357646"></a><!-- doxytag: member="Cairo::SurfacePattern::get_surface" ref="aad4763fd999ca2dc1094b07e5f357646" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt;const <a class="el" href="classCairo_1_1Surface.html">Surface</a>&gt; Cairo::SurfacePattern::get_surface </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the surface associated with this pattern. </p>
<dl class="since"><dt><b>Since:</b></dt><dd>1.4 </dd></dl>

</div>
</div>
<a class="anchor" id="a8b238004a061f34425ee61a2ba494632"></a><!-- doxytag: member="Cairo::SurfacePattern::set_extend" ref="a8b238004a061f34425ee61a2ba494632" args="(Extend extend)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cairo::SurfacePattern::set_extend </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5">Extend</a>&#160;</td>
          <td class="paramname"> <em>extend</em></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a4d1517f554ffb2821e939aed01899022"></a><!-- doxytag: member="Cairo::SurfacePattern::set_filter" ref="a4d1517f554ffb2821e939aed01899022" args="(Filter filter)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cairo::SurfacePattern::set_filter </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceCairo.html#a92b32ad7db301e18386477566c1caa6a">Filter</a>&#160;</td>
          <td class="paramname"> <em>filter</em></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>cairomm/pattern.h</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Dec 30 2010 22:31:50 for cairomm by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>