<?xml version="1.0"?>
<!DOCTYPE refentry 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;
]>
<part id="intro">
<title>Introduction</title>
<para>
gspell provides a flexible API to add spell checking to a GTK+ application.
See the <ulink url="https://wiki.gnome.org/Projects/gspell">gspell website</ulink>.
</para>
<refsect1>
<title>pkg-config name</title>
<para>
The pkg-config name of the gspell library is: <code>gspell-@GSPELL_API_VERSION@</code>
</para>
<para>
To compile a program that uses gspell, you can for example use the
following command:
</para>
<para>
<code>$ gcc hello.c `pkg-config --cflags --libs gspell-@GSPELL_API_VERSION@` -o hello</code>
</para>
</refsect1>
<refsect1>
<title>How to enable inline spell checking in a GtkTextView</title>
<para>
See the <link linkend="gspell-text-view-basic-setup"><function>gspell_text_view_basic_setup()</function></link>
convenience function to quickly enable inline spell checking in a
<link linkend="GtkTextView"><type>GtkTextView</type></link> widget.
</para>
</refsect1>
<refsect1>
<title>How to enable inline spell checking in a GtkEntry</title>
<para>
See the <link linkend="gspell-entry-basic-setup"><function>gspell_entry_basic_setup()</function></link>
convenience function to quickly enable inline spell checking in a
<link linkend="GtkEntry"><type>GtkEntry</type></link> widget.
</para>
</refsect1>
</part>