AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

Add docs for new ports.

Browse Source
This commit is contained in:
Matthias Clasen 2006-03-15 06:46:00 +00:00
parent 33b9a8d19b
commit 365a0d377e
5 changed files with 154 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/ChangeLog
View File

@ -1,3 +1,11 @@
2006-03-15 Matthias Clasen <mclasen@redhat.com>
* gtk/osx.sgml:
* gtk/directfb.sgml: Add skeleton sections for new ports.
* gtk/gtk-docs.sgml:
* gtk/Makefile.am: Integrate them.
2006-03-10 Michael Natterer <mitch@imendio.com>
* gtk/gtk-sections.txt: add gtk_entry_get,set_inner_border()

2
docs/reference/gtk/Makefile.am
View File

@ -97,6 +97,7 @@ content_files = \
changes-1.2.sgml \
changes-2.0.sgml \
compiling.sgml \
directfb.sgml \
framebuffer.sgml \
glossary.xml \
migrating-checklist.sgml \
@ -108,6 +109,7 @@ content_files = \
migrating-GtkColorButton.sgml \
migrating-GtkAssistant.sgml \
objects_grouped.sgml \
osx.sgml \
question_index.sgml \
resources.sgml \
text_widget.sgml \

103
docs/reference/gtk/directfb.sgml Normal file
View File

@ -0,0 +1,103 @@
<refentry id="gtk-directfb">
<refmeta>
<refentrytitle>Using GTK+ on DirectFB</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Using GTK+ on DirectFB</refname>
<refpurpose>
DirectFB-specific aspects of using GTK+
</refpurpose>
</refnamediv>
<refsect1>
<title>Using GTK+ on DirectFB</title>
<para>
The DirectFB port of GTK+ is an implementation of GDK (and therefore GTK+)
on top of the <ulink url="http://www.directfb.org">DirectFB</ulink>
libraries.
</para>
<para>
Like the obsolete linux-fb port of GTK+, it runs on the Linux framebuffer,
but the DirectFB libraries provide additional features like hardware graphics
acceleration, input device handling and abstraction and an integrated windowing
system.
</para>
<refsect2><title>Build requirements</title>
<para>
Beyond the usual GTK+ build requirements, the DirectFB backend (obviously) needs
the DirectFB libraries (at least 0.9.21) and Cairo compiled with DirectFB support.
</para>
<!--
FIXME: it seems most of the options listed in _gdk_windowing_args
are ignored, and they need to be described by somebody who knows
what they are supposed to do...
<refsect2><title>DirectFB-specific commandline options</title>
<para>
The DirectFB GDB backend can be influenced with some additional
command line arguments.
</para>
<formalpara>
<title><systemitem>--dfb-help</systemitem></title>
<para>
Display help for DirectFB-specific commandline options.
</para>
</formalpara>
<formalpara>
<title><systemitem>--dfb=<replaceable>value</replaceable></systemitem></title>
<para>
Possible values: sdl, system.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-aa-fonts=<replaceable>number</replaceable></systemitem></title>
<para>
If <replaceable>number</replaceable> is 1, disable antialising for fonts.
</para>
</formalpara>
<formalpara>
<title><systemitem>--argb-font=<replaceable>number</replaceable></systemitem></title>
<para>
If <replaceable>number</replaceable> is 1, enable ARGB fonts.
</para>
</formalpara>
<formalpara>
<title><systemitem>--transparent-unfocused=<replaceable>number</replaceable></systemitem></title>
<para>
If <replaceable>number</replaceable> is 1, make unfocused windows transparent.
</para>
</formalpara>
<formalpara>
<title><systemitem>--glyph-surface-cache=<replaceable>number</replaceable></systemitem></title>
<para>
Set the size of the glyph surface cache. The default value is 8.
</para>
</formalpara>
<formalpara>
<title><systemitem>--enable-color-keyring=<replaceable>number</replaceable></systemitem></title>
<para>
If <replaceable>number</replaceable> is 1, turn on the color keyring.
</para>
</formalpara>
-->
</refsect1>
</refentry>

8
docs/reference/gtk/gtk-docs.sgml
View File

@ -188,6 +188,8 @@
<!ENTITY gtk-Windows SYSTEM "windows.sgml">
<!ENTITY gtk-Framebuffer SYSTEM "framebuffer.sgml">
<!ENTITY gtk-X11 SYSTEM "x11.sgml">
<!ENTITY gtk-OSX SYSTEM "osx.sgml">
<!ENTITY gtk-DirectFB SYSTEM "directfb.sgml">
<!ENTITY gtk-Questions SYSTEM "xml/question_index.sgml">
<!ENTITY gtk-Changes-1-2 SYSTEM "changes-1.2.sgml">
<!ENTITY gtk-Changes-2-0 SYSTEM "changes-2.0.sgml">
@ -300,9 +302,11 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
&gtk-Building;
&gtk-Compiling;
&gtk-Running;
&gtk-Windows;
&gtk-Framebuffer;
&gtk-X11;
&gtk-Windows;
&gtk-OSX;
&gtk-DirectFB;
&gtk-Framebuffer;
&gtk-Resources;
&gtk-Questions;
</part>

35
docs/reference/gtk/osx.sgml Normal file
View File

@ -0,0 +1,35 @@
<refentry id="gtk-osx">
<refmeta>
<refentrytitle>Using GTK+ on Mac OS X</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Using GTK+ on Mac OS X</refname>
<refpurpose>
OS X-specific aspects of using GTK+
</refpurpose>
</refnamediv>
<refsect1>
<title>Using GTK+ on Mac OS X</title>
<para>
The Mac OS X port of GTK+ is an implementation of GDK (and therefore GTK+)
on top of the Quarz API.
</para>
<para>
Currently, the Mac OS X port does not use any additional commandline options
or environment variables.
</para>
<para>
For up-to-date information about the current status of this port, see the
<ulink url="http://developer.imendio.com/wiki/Gtk_Mac_OS_X">project page</ulink>.
</para>
</refsect1>
</refentry>