74 lines
2.2 KiB
XML
74 lines
2.2 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
|
|
[
|
|
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
|
|
<!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
|
|
%gtkdocentities;
|
|
]>
|
|
<book id="index">
|
|
<bookinfo>
|
|
<title>&package_name; Reference Manual</title>
|
|
<releaseinfo>
|
|
<para>This document is the API reference for &package_name; &package_version;</para>
|
|
<para>
|
|
<ulink type="http" url="&package_url;">Libfeedback</ulink> is a library to trigger
|
|
feedback (such as haptic feedback) via events sent by your application.
|
|
</para>
|
|
<para>
|
|
If you find any issues in this API reference, please report it using
|
|
<ulink type="http" url="&package_bugreport;">the bugtracker</ulink>.
|
|
</para>
|
|
</releaseinfo>
|
|
|
|
<copyright>
|
|
<year>2020</year>
|
|
<holder>Purism SPC</holder>
|
|
</copyright>
|
|
</bookinfo>
|
|
|
|
<chapter id="intro">
|
|
<title>Introduction</title>
|
|
|
|
<para>
|
|
The purpose of libfeedback is to trigger audible, haptic and visual feedback based on
|
|
events. Events are identified by strings.
|
|
</para>
|
|
|
|
<xi:include href="build-howto.xml"/>
|
|
</chapter>
|
|
|
|
<chapter id="core-api">
|
|
<title>Core API</title>
|
|
<xi:include href="xml/libfeedback.xml"/>
|
|
<xi:include href="xml/lfb-event.xml"/>
|
|
</chapter>
|
|
|
|
<chapter id="low-level-api">
|
|
<title>Low level api</title>
|
|
<xi:include href="xml/lfb-gdbus.xml"/>
|
|
<xi:include href="xml/lfb-names.xml"/>
|
|
</chapter>
|
|
|
|
<chapter id="dbus-interface">
|
|
<title>DBus Interface</title>
|
|
<xi:include href="../data/libfeedback-org.sigxcpu.Feedback.xml"/>
|
|
</chapter>
|
|
|
|
<chapter id="object-tree">
|
|
<title>Object Hierarchy</title>
|
|
<xi:include href="xml/tree_index.sgml"/>
|
|
</chapter>
|
|
|
|
<index id="api-index-full">
|
|
<title>API Index</title>
|
|
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
|
|
<index id="annotations-glossary">
|
|
<title>Annotations glossary</title>
|
|
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
|
|
</book>
|