Add info about single includes when compiling GTK+ apps

gtk.h, gdk.h, gdk-pixbuf.h. are the recommended includes.
But there are some exceptions: gdkkeysyms.h, gdkx.h and
gtkunixprint.h

https://bugzilla.gnome.org/show_bug.cgi?id=604117
This commit is contained in:
Javier Jardón 2009-12-09 23:54:17 +01:00 committed by Tristan Van Berkom
parent 52e84a9ecc
commit 4f0f6243c9

View File

@ -69,12 +69,17 @@ toplevel headers <filename>gtk.h</filename>, <filename>gdk.h</filename>,
If you want to make sure that your program follows this recommended
practise, you can define the preprocessor symbols GTK_DISABLE_SINGLE_INCLUDES
and GDK_PIXBUF_DISABLE_SINGLE_INCLUDES to make GTK+ generate an error
when individual headers are directly included.
when individual headers are directly included.
There are some exceptions: <filename>gdkkeysyms.h</filename> is not included in
<filename>gdk.h</filename> because the file is quite large; see
<link linkend="gdk-Keyboard-Handling">Key Values documentation</link>.
<filename>gdkx.h</filename> must be included independently because It's
platform-specific; see
<link linkend="gdk-X-Window-System-Interaction">X Window System Interaction</link>
documentation.
The same for <filename>gtkunixprint.h</filename> if you use the non-portable
<link linkend="GtkPrintUnixDialog">GtkPrintUnixDialog</link> API.
</para>
</refsect1>
</refentry>