<!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: libvtemm Reference Manual</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 class="current"><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>libvtemm Reference Manual</h1><h3>0.23.1 </h3><h2><a class="anchor" id="description">
Description</a></h2>
<p>vte is a library implementing Gtk+ widget emulating terminal. The libvtemm C++ binding provides a C++ interface on top of the vte C library.</p>
<h2><a class="anchor" id="overview">
Overview</a></h2>
<p>The libvtemm API provides a subset of vte functionality. It wraps only <code>VteTerminal</code>, leaving <code>VteReaper</code>, which is deprecated, and <code>VteTerminalAccessible</code>, which author does not see any purpose for programmists using this widget.</p>
<h2><a class="anchor" id="use">
Use</a></h2>
<p>To use libvtemm in your C++ application, include the central header file <code><libvtemm.h></code> or, for terminal widget only, <code><libvtemm/terminal.h></code>. The libvtemm package ships a <code>pkg-config</code> file with the correct include path and link command-line for the compiler.</p>
<p>The source code of the <a class="el" href="simple_2main_8cc-example.html">Simple Terminal</a> and <a class="el" href="gettexter_2main_8cc-example.html">GetTexter</a> example programs demonstrate the basic usage of the libvtemm API.</p>
<h2><a class="anchor" id="contact">
Contact</a></h2>
<p>The best way to ask questions about libvtemm is to use one of below:</p>
<h3><a class="anchor" id="mailinglist">
Mailing list</a></h3>
<p>Send a mail to <a href="mailto:gtkmm-list@gnome.org">gtkmm-list@gnome.org</a>.</p>
<h3><a class="anchor" id="irc">
IRC</a></h3>
<p>Join c++ channel on irc.gnome.org and ask away.</p>
<h2><a class="anchor" id="sourcecode">
Source code</a></h2>
<p>Library is developed and placed on GNOME git repository and release tarballs are put on GNOME FTP site.</p>
<h3><a class="anchor" id="browse">
Browsing the source code</a></h3>
<p>See <code><a href="http://git.gnome.org/browse/libvtemm/">http://git.gnome.org/browse/libvtemm/</a></code>.</p>
<h3><a class="anchor" id="bleedingedge">
Getting bleeding edge source code</a></h3>
<p><code>git clone git://git.gnome.org/libvtemm libvtemm</code></p>
<h3><a class="anchor" id="tarballs">
Getting release tarballs</a></h3>
<p>See <code><a href="http://download.gnome.org/sources/libvtemm/">http://download.gnome.org/sources/libvtemm/</a></code>.</p>
<h2><a class="anchor" id="license">
License</a></h2>
<p>libvtemm is licensed under GNU Lesser Public License version 3 or (at your option) any later.</p>
<h2><a class="anchor" id="authors">
Author</a></h2>
<p>This library was written and is maintained by Krzesimir Nowak. </p>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 14 Jan 2010 for libvtemm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
