<!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>QOAuth: Main Page</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.3 -->
<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="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>QOAuth Documentation</h1><h3 class="version">1.0.1 </h3><h2><a class="anchor" id="sec_what">
What is the purpose of QOAuth?</a></h2>
<p>The main motivation to create this library was to provide an interface to OAuth protocol for (Qt-based) C++ applications in an easy way. This is very early version of the library, and it lacks some functionality, but in the same time it is capable of sending OAuth authorization requests as well as preparing requests for accessing User's Protected Resources.</p>
<h2><a class="anchor" id="sec_lic">
License and Authors</a></h2>
<p>The project is licensed under <a href="http://www.gnu.org/licenses/lgpl-2.1.html">GNU LGPL license</a> version 2.1 or later. The work is done by Dominik Kapusta (d at ayoy dot net).</p>
<h2><a class="anchor" id="sec_inst">
How to install?</a></h2>
<h3><a class="anchor" id="ssec_deps">
Dependencies</a></h3>
<p>There are a few things necessary to get OAuth library working:</p>
<ol>
<li>
Qt libraries, version 4.4 or higher, </li>
<li>
QCA (Qt Cryptographic Architecture), available from <a href="http://delta.affinix.com/qca">Delta XMPP Project</a>, version 2.0.0 or higher, </li>
<li>
OpenSSL plugin to QCA (qca-ossl), available from QCA page, and requiring OpenSSL. </li>
</ol>
<p><b>Note:</b> KDE4 users meet all the requirements out of the box.</p>
<h3><a class="anchor" id="ssec_inst">
Installation</a></h3>
<p>The source code repository is hosted on <a href="http://github.com/ayoy/qoauth">GitHub</a> and the code can be checked out from there easily using git: </p>
<div class="fragment"><pre class="fragment">
$ git clone git://github.com/ayoy/qoauth.git </pre></div><p>To compile the code, follow the simple procedure:</p>
<div class="fragment"><pre class="fragment">
$ qmake
$ make
$ sudo make install </pre></div><h3><a class="anchor" id="ssec_use">
Usage</a></h3>
<p>Configuring your project to work with <a class="el" href="namespace_q_o_auth.html" title="This namespace encapsulates all classes and definitions provided by libqoauth.">QOAuth</a> library is extremely simple. Firstly, append a line to your project file: </p>
<div class="fragment"><pre class="fragment">
CONFIG += oauth </pre></div><p>Then include the following header in your code: </p>
<div class="fragment"><pre class="fragment">
#include <QtOAuth> </pre></div><p><b>Note:</b> This follows the Qt scheme, i.e. <code>QT += xml ==> include <QtXml></code>, etc.</p>
<h2><a class="anchor" id="sec_bugs">
Bugs and issues</a></h2>
<p>Please file all the bug reports to the <a class="el" href="namespace_q_o_auth.html" title="This namespace encapsulates all classes and definitions provided by libqoauth.">QOAuth</a> bug tracking system at <a href="http://ayoy.lighthouseapp.com/projects/32547-qoauth/tickets?q=all">lighthouseapp.com</a>. If you wish to contribute, you're extremely welcome to fork a <a href="http://github.com/ayoy/qoauth">GitHub</a> repository and add your input there. </p>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Sep 2 20:58:20 2010 for QOAuth by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
i586
>
media
>
contrib-updates
>
by-pkgid
>
a65e18d6cd6ada0b594b5264b3e30c20
>
files
>
28
