Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 916d33628a558f568f42a3b32e800b17 > files > 16

libvtemm-docs-0.23.1-2.fc15.i686.rpm

<!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>libvtemm: Gnome::Vte::Pty::Size 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="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</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="tabs">
    <ul>
      <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"><b>Gnome</b>::<b>Vte</b>::<b>Pty</b>::<a class="el" href="classGnome_1_1Vte_1_1Pty_1_1Size.html">Size</a>
  </div>
</div>
<div class="contents">
<h1>Gnome::Vte::Pty::Size Class Reference</h1><!-- doxytag: class="Gnome::Vte::Pty::Size" -->
<p><a class="el" href="classGnome_1_1Vte_1_1Pty_1_1Size.html" title="Size - simple class holding size of a pseudo-terminal.">Size</a> - simple class holding size of a pseudo-terminal. <a href="#_details">More...</a></p>

<p><code>#include &lt;libvtemm/ptysize.h&gt;</code></p>

<p><a href="classGnome_1_1Vte_1_1Pty_1_1Size-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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Vte_1_1Pty_1_1Size.html#aea1ec190c87c29d03af3ea14138fc818">Size</a> (int columns, int rows, bool ok=true)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The only way to fill <a class="el" href="classGnome_1_1Vte_1_1Pty_1_1Size.html" title="Size - simple class holding size of a pseudo-terminal.">Gnome::Vte::Pty::Size</a> class. <a href="#aea1ec190c87c29d03af3ea14138fc818"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Vte_1_1Pty_1_1Size.html#a3255a8efe21c5da324300ed7d58f853a">get_columns</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets number of columns. <a href="#a3255a8efe21c5da324300ed7d58f853a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Vte_1_1Pty_1_1Size.html#af926f25a484d7e597faa04d3936f2877">get_rows</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets number of rows. <a href="#af926f25a484d7e597faa04d3936f2877"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Vte_1_1Pty_1_1Size.html#a84e7c02cc491712e7431fe25065c07b6">is_ok</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if there was an error during getting size. <a href="#a84e7c02cc491712e7431fe25065c07b6"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classGnome_1_1Vte_1_1Pty_1_1Size.html" title="Size - simple class holding size of a pseudo-terminal.">Size</a> - simple class holding size of a pseudo-terminal. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aea1ec190c87c29d03af3ea14138fc818"></a><!-- doxytag: member="Gnome::Vte::Pty::Size::Size" ref="aea1ec190c87c29d03af3ea14138fc818" args="(int columns, int rows, bool ok=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Gnome::Vte::Pty::Size::Size </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"> <em>columns</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"> <em>rows</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"> <em>ok</em> = <code>true</code></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The only way to fill <a class="el" href="classGnome_1_1Vte_1_1Pty_1_1Size.html" title="Size - simple class holding size of a pseudo-terminal.">Gnome::Vte::Pty::Size</a> class. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>columns</em>&#160;</td><td>Pseudo-terminals number of columns. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>rows</em>&#160;</td><td>Pseudo-terminals number of rows. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ok</em>&#160;</td><td><code>false</code>, if an error occured while getting size of pseudo-terminal. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3255a8efe21c5da324300ed7d58f853a"></a><!-- doxytag: member="Gnome::Vte::Pty::Size::get_columns" ref="a3255a8efe21c5da324300ed7d58f853a" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Gnome::Vte::Pty::Size::get_columns </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets number of columns. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Number of columns. </dd></dl>

</div>
</div>
<a class="anchor" id="af926f25a484d7e597faa04d3936f2877"></a><!-- doxytag: member="Gnome::Vte::Pty::Size::get_rows" ref="af926f25a484d7e597faa04d3936f2877" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Gnome::Vte::Pty::Size::get_rows </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets number of rows. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Number of rows. </dd></dl>

</div>
</div>
<a class="anchor" id="a84e7c02cc491712e7431fe25065c07b6"></a><!-- doxytag: member="Gnome::Vte::Pty::Size::is_ok" ref="a84e7c02cc491712e7431fe25065c07b6" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gnome::Vte::Pty::Size::is_ok </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Checks if there was an error during getting size. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>false</code> if something went wrong, otherwise <code>true</code>. </dd></dl>

</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 14 Jan 2010 for libvtemm by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>