Commit ecc13fb5 authored by Havoc Pennington's avatar Havoc Pennington Committed by Havoc Pennington

remove CellRendererTextPixbuf

2001-09-08  Havoc Pennington  <hp@pobox.com>

	* gtk/gtk-docs.sgml: remove CellRendererTextPixbuf

	* gtk/resources.sgml: add section on mailing lists, bugzilla, etc.

	* gtk/tmpl/gtkaccelgroup.sgml: add long description

	* gtk/gtk-sections.txt: reorder accel group section; probably need
	to delete most of it

	* gtk/tmpl/gtkmain.sgml: Clean it up a little bit

	* gtk/gtk-docs.sgml: rearrange the list of "core/misc" sections so
	that useful things are near the top and stupid junk is near the
	bottom.

	* gtk/tmpl/gtkfeatures.sgml: fix/finish this section

	* gtk/gtk-docs.sgml: create a separate section for
	overview/tutorial material and special notes, and put the
	reference docs for the "misc non-widget" stuff into its own
	section.

	* gtk/compiling.sgml: write this section

	* gtk/gtk-docs.sgml: The intro section weirdly had two paragraphs
	that said the same thing. Delete one of them.
parent 8c884b53
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtkmain.c: move some docs inline
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtk.h: tsk tsk, jrb broke the build
......
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtkmain.c: move some docs inline
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtk.h: tsk tsk, jrb broke the build
......
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtkmain.c: move some docs inline
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtk.h: tsk tsk, jrb broke the build
......
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtkmain.c: move some docs inline
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtk.h: tsk tsk, jrb broke the build
......
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtkmain.c: move some docs inline
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtk.h: tsk tsk, jrb broke the build
......
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtkmain.c: move some docs inline
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtk.h: tsk tsk, jrb broke the build
......
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtkmain.c: move some docs inline
2001-09-07 Havoc Pennington <hp@pobox.com>
* gtk/gtk.h: tsk tsk, jrb broke the build
......
2001-09-08 Havoc Pennington <hp@pobox.com>
* gtk/gtk-docs.sgml: remove CellRendererTextPixbuf
* gtk/resources.sgml: add section on mailing lists, bugzilla, etc.
* gtk/tmpl/gtkaccelgroup.sgml: add long description
* gtk/gtk-sections.txt: reorder accel group section; probably need
to delete most of it
* gtk/tmpl/gtkmain.sgml: Clean it up a little bit
* gtk/gtk-docs.sgml: rearrange the list of "core/misc" sections so
that useful things are near the top and stupid junk is near the
bottom.
* gtk/tmpl/gtkfeatures.sgml: fix/finish this section
* gtk/gtk-docs.sgml: create a separate section for
overview/tutorial material and special notes, and put the
reference docs for the "misc non-widget" stuff into its own
section.
* gtk/compiling.sgml: write this section
* gtk/gtk-docs.sgml: The intro section weirdly had two paragraphs
that said the same thing. Delete one of them.
Tue Sep 4 01:33:51 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtk-docs.sgml: Remove references to a couple
......
......@@ -13,10 +13,40 @@ How to compile your GTK+ application
</refnamediv>
<refsect1>
<title>Compiling GTK+ Applications</title>
<title>Compiling GTK+ Applications on UNIX</title>
<para>
To compile a GTK+ application, you need to tell the compiler where to
find the GTK+ header files and libraries. This is done with the
<literal>pkg-config</literal> utility.
</para>
<para>
The following interactive shell session demonstrates how
<literal>pkg-config</literal> is used:
<programlisting>
$ pkg-config --cflags gtk+-2.0
-I/usr/include/gtk-2.0 -I/usr/lib/gtk-2.0/include -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -I/usr/include/pango-1.0 -I/usr/X11R6/include -I/usr/include/freetype2 -I/usr/include/atk-1.0
$ pkg-config --libs gtk+-2.0
-L/usr/lib -L/usr/X11R6/lib -lgtk-x11-1.3 -lgdk-x11-1.3 -lXi -lgdk_pixbuf-1.3 -lm -lpangox -lpangoxft -lXft -lXrender -lXext -lX11 -lfreetype -lpango -latk -lgobject-1.3 -lgmodule-1.3 -ldl -lglib-1.3
</programlisting>
</para>
<para>
The simplest way to compile a program is to use the "backticks"
feature of the shell. If you enclose a command in backticks
(<emphasis>not single quotes</emphasis>), then its output will be
substituted into the command line before execution. So to compile
a GTK+ Hello, World, you would type the following:
<programlisting>
$ cc `pkg-config --cflags --libs gtk+-2.0` hello.c -o hello
</programlisting>
</para>
<para>
To compile a GTK+ program for the framebuffer, use the
"gtk+-linux-fb-2.0" package name instead of "gtk+-2.0":
<programlisting>
$ cc `pkg-config --cflags --libs gtk+-linux-fb-2.0` hello.c -o hello
</programlisting>
</para>
</refsect1>
......
......@@ -102,7 +102,6 @@
<!entity gtk-GtkCellRenderer SYSTEM "sgml/gtkcellrenderer.sgml">
<!entity gtk-GtkCellRendererPixbuf SYSTEM "sgml/gtkcellrendererpixbuf.sgml">
<!entity gtk-GtkCellRendererText SYSTEM "sgml/gtkcellrenderertext.sgml">
<!entity gtk-GtkCellRendererTextPixbuf SYSTEM "sgml/gtkcellrenderertextpixbuf.sgml">
<!entity gtk-GtkCellRendererToggle SYSTEM "sgml/gtkcellrenderertoggle.sgml">
<!entity gtk-GtkListStore SYSTEM "sgml/gtkliststore.sgml">
<!entity GtkVButtonBox SYSTEM "sgml/gtkvbbox.sgml">
......@@ -138,6 +137,7 @@
<!entity gtk-TextWidget SYSTEM "text_widget.sgml">
<!entity gtk-TreeWidget SYSTEM "tree_widget.sgml">
<!entity gtk-Compiling SYSTEM "compiling.sgml">
<!entity gtk-Resources SYSTEM "resources.sgml">
<!entity gtk-Windows SYSTEM "windows.sgml">
<!entity gtk-Framebuffer SYSTEM "framebuffer.sgml">
]>
......@@ -147,18 +147,10 @@
</bookinfo>
<chapter id="gtk">
<title>GTK+ </title>
<title>GTK+ Overview</title>
<para>
GTK+ is a multi-platform open source GUI Toolkit. Everything about
GTK+ from the object-oriented design to the Free Software LGPL
licensing allows you to code your project with the most freedom
possible. You can develop open software, free software, or even
commercial non-free software without having to spend a dime for
licenses or royalties.
</para>
<para>
GTK+ is a set of libraries to create graphical user interfaces. It
works on many Unix-like platforms, Windows, and on framebuffer
GTK+ is a library for creating graphical user interfaces. It
works on many UNIX-like platforms, Windows, and on framebuffer
devices. GTK+ is released under the GNU Library General Public License
(GNU LGPL), which allows for flexible licensing of client
applications. GTK+ has a C-based object-oriented architecture that
......@@ -167,52 +159,101 @@ been written, including C++, Objective-C, Guile/Scheme, Perl, Python,
TOM, Ada95, Free Pascal, and Eiffel.
</para>
<para>
GTK+ consists of the following component libraries:
GTK+ depends on the following libraries:
<variablelist>
<varlistentry>
<term>GLib</term>
<listitem><para>
Provides many useful data types, macros, type conversions,
string utilities and a lexical scanner. Includes Win32 support.
A general-purpose utility library, not specific to graphical user interfaces.
GLib provides many useful data types, macros, type conversions,
string utilities, file utilities, a main loop abstraction, and so on.
</para></listitem>
</varlistentry>
<varlistentry>
<term>Pango</term>
<listitem><para>
Pango is a library for internationalized text handling. It centers
around the #PangoLayout object, representing a paragraph of text.
Pango provides the engine for #GtkTextView, #GtkLabel, #GtkEntry, and
other widgets that display text.
</para></listitem>
</varlistentry>
<varlistentry>
<term>ATK</term>
<listitem><para>
ATK is the Accessibility Toolkit. It provides a set of generic
interfaces allowing accessibility technologies to interact with a
graphical user interface. For example, a screen reader uses ATK to
discover the text in an interface and read it to blind users. GTK+
widgets have built-in support for accessibility using the ATK
framework.
</para></listitem>
</varlistentry>
<varlistentry>
<term>GdkPixbuf</term>
<listitem><para>
This is a small library which allows you to create #GdkPixbuf
("pixel buffer") objects from image data or image files.
Use a #GdkPixbuf in combination with #GtkImage to display images.
</para></listitem>
</varlistentry>
<varlistentry>
<term>GDK</term>
<listitem><para>
A wrapper for low-level windowing functions.
GDK is the abstraction layer that allows GTK+ to support multiple
windowing systems. GDK provides drawing and window system facilities
on X11, Windows, and the Linux framebuffer device.
</para></listitem>
</varlistentry>
<varlistentry>
<term>GTK+</term>
<listitem><para>
An advanced widget set.
The GTK+ library itself contains <firstterm>widgets</firstterm>,
that is, GUI components such as #GtkButton or #GtkTextView.
</para></listitem>
</varlistentry>
</variablelist>
</para>
&gtk-Compiling;
&gtk-Resources;
&gtk-Windows;
&gtk-Framebuffer;
</chapter>
<chapter id="gtkbase" role="no-toc">
<title>GTK+ Core Reference</title>
&gtk-General;
&gtk-Feature-Test-Macros;
&gtk-Graphics-Contexts;
&gtk-Styles;
<!-- &gtk-Themes; -->
&gtk-Resource-Files;
&gtk-Keyboard-Accelerators;
&gtk-Selections;
&gtk-Clipboards;
&gtk-Drag-and-Drop;
&gtk-Signals;
&gtk-Stock-Items;
&gtk-Themeable-Stock-Images;
&gtk-Types;
&gtk-Resource-Files;
&gtk-Bindings;
&gtk-Standard-Enumerations;
&gtk-Graphics-Contexts;
&gtk-Styles;
&gtk-Selections;
&gtk-Feature-Test-Macros;
&gtk-Signals;
&gtk-Types;
<!-- &gtk-Themes; -->
</chapter>
......@@ -281,7 +322,6 @@ An advanced widget set.
&gtk-GtkCellRenderer;
&gtk-GtkCellRendererPixbuf;
&gtk-GtkCellRendererText;
&gtk-GtkCellRendererTextPixbuf;
&gtk-GtkCellRendererToggle;
&gtk-GtkListStore;
</sect1>
......
......@@ -2736,20 +2736,6 @@ GTK_CELL_RENDERER_TEXT_CLASS
GTK_IS_CELL_RENDERER_TEXT_CLASS
</SECTION>
<SECTION>
<FILE>gtkcellrenderertextpixbuf</FILE>
<TITLE>GtkCellRendererTextPixbuf</TITLE>
GtkCellRendererTextPixbuf
gtk_cell_renderer_text_pixbuf_new
<SUBSECTION Standard>
GTK_CELL_RENDERER_TEXT_PIXBUF
GTK_IS_CELL_RENDERER_TEXT_PIXBUF
GTK_TYPE_CELL_RENDERER_TEXT_PIXBUF
gtk_cell_renderer_text_pixbuf_get_type
GTK_CELL_RENDERER_TEXT_PIXBUF_CLASS
GTK_IS_CELL_RENDERER_TEXT_PIXBUF_CLASS
</SECTION>
<SECTION>
<FILE>gtkcellrenderertoggle</FILE>
<TITLE>GtkCellRendererToggle</TITLE>
......@@ -3393,17 +3379,21 @@ GTK_RC_STYLE_GET_CLASS
<FILE>gtkaccelgroup</FILE>
<TITLE>Keyboard Accelerators</TITLE>
GtkAccelGroup
GtkAccelEntry
gtk_accel_group_new
gtk_accel_group_get_default
gtk_accel_group_ref
gtk_accel_group_unref
gtk_accel_group_activate
gtk_accel_groups_activate
gtk_accel_group_attach
gtk_accel_group_detach
gtk_accel_group_lock
gtk_accel_group_unlock
gtk_accelerator_valid
gtk_accelerator_parse
gtk_accelerator_name
gtk_accelerator_set_default_mod_mask
gtk_accelerator_get_default_mod_mask
gtk_accel_group_attach
gtk_accel_group_detach
gtk_accel_group_get_entry
gtk_accel_group_lock_entry
gtk_accel_group_unlock_entry
......@@ -3415,11 +3405,6 @@ gtk_accel_group_create_add
gtk_accel_group_create_remove
gtk_accel_groups_from_object
gtk_accel_group_entries_from_object
gtk_accelerator_valid
gtk_accelerator_parse
gtk_accelerator_name
gtk_accelerator_set_default_mod_mask
gtk_accelerator_get_default_mod_mask
</SECTION>
<SECTION>
......
<refentry id="gtk-resources" revision="5 Sept 2001">
<refmeta>
<refentrytitle>Mailing lists and bug reports</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>Mailing lists and bug reports</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Mailing lists and bug reports</refname>
<refpurpose>
Getting help with GTK+
</refpurpose>
</refnamediv>
<refsect1>
<title>Filing a bug report or feature request</title>
<para>
If you encounter a bug, misfeature, or missing feature in GTK+, please
file a bug report on http://bugzilla.gnome.org. We'd also appreciate
reports of incomplete or misleading information in the GTK+
documentation; file those against the "docs" component of the "gtk+"
product in Bugzilla.
</para>
<para>
Don't hesitate to file a bug report, even if you think we may know
about it already, or aren't sure of the details. Just give us as much
information as you have, and if it's already fixed or has already been
discussed, we'll add a note to that effect in the report.
</para>
<para>
The bug tracker should definitely be used for feature requests, it's
not only for bugs. We track all GTK+ development in bugzilla, so it's
the way to be sure the GTK+ developers won't forget about an issue.
</para>
</refsect1>
<refsect1>
<title>Submitting Patches</title>
<para>
If you develop a bugfix or enhancement for GTK+, please file that in
Bugzilla as well. Bugzilla allows you to attach files; please attach a
patch generated by the "diff" utility, using the "-u" option to make
the patch more readable. All patches must be offered under the terms
of the GNU LGPL license, so be sure you are authorized to give us the
patch under those terms.
</para>
<para>
If you want to discuss your patch before or after developing it, mail
gtk-devel-list@gnome.org. But be sure to file the Bugzilla report as
well; if the patch is only on the list and not in Bugzilla, it's
likely to slip through the cracks.
</para>
</refsect1>
<refsect1>
<title>Mailing lists</title>
<para>
There are several mailing lists dedicated to GTK+ and related
libraries. Discussion of GLib, Pango, and ATK in addition to GTK+
proper is welcome on these lists. You can subscribe or view the
archives of these lists on http://mail.gnome.org.
</para>
<para>
<variablelist>
<varlistentry>
<term>gtk-list@gnome.org</term>
<listitem><para>
gtk-list covers general GTK+ topics; questions about using GTK+ in programs,
GTK+ from a user standpoint, announcements of GTK+-related projects
such as themes or GTK+ modules would all be on-topic. The bulk of the
traffic consists of GTK+ programming questions.
</para></listitem>
</varlistentry>
<varlistentry>
<term>gtk-app-devel-list@gnome.org</term> <listitem><para>
gtk-app-devel-list covers writing applications in GTK+. It's narrower
in scope than gtk-list, but the two lists overlap quite a
bit. gtk-app-devel-list is a good place to ask questions about GTK+
programming. </para></listitem>
</varlistentry>
<varlistentry>
<term>gtk-devel-list@gnome.org</term>
<listitem><para>
gtk-devel-list is for discussion of work on GTK+ itself, it is NOT for
asking questions about how to use GTK+ in applications. gtk-devel-list
is appropriate for discussion of patches, bugs, proposed features,
and so on.
</para></listitem>
</varlistentry>
<varlistentry>
<term>gtk-i18n-list@gnome.org</term>
<listitem><para>
gtk-i18n-list is for discussion of internationalization in GTK+;
Pango is the main focus of the list. Questions about the details of
using Pango, and discussion of proposed Pango patches or features, are
all on topic.
</para></listitem>
</varlistentry>
<varlistentry>
<term>gtk-doc-list@gnome.org</term>
<listitem><para>
gtk-doc-list is for discussion of the gtk-doc documentation system
(used to document GTK+), and for work on the GTK+ documentation.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>
......@@ -393,6 +393,18 @@ Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
@b:
@Returns:
<!-- ##### STRUCT GtkAccelEntry ##### -->
<para>
This is a private struct used by GTK+ internally, don't worry about it.
</para>
@accel_group:
@accelerator_key:
@accelerator_mods:
@accel_flags:
@object:
@signal_id:
<!-- ##### ARG GtkAccelLabel:accel-widget ##### -->
<para>
The widget whose accelerators are to be shown by the #GtkAccelLabel.
......@@ -440,6 +452,13 @@ Define a function pointer. Deprecated.
@arg:
@arg_id:
<!-- ##### STRUCT GtkCellRendererTextPixbuf ##### -->
<para>
</para>
@parent:
<!-- ##### ARG GtkColorSelection:previous-alpha ##### -->
<para>
......@@ -1277,6 +1296,13 @@ Sets the default size of child buttons.
@accel_group:
@Returns:
<!-- ##### FUNCTION gtk_cell_renderer_text_pixbuf_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_clist_construct ##### -->
<para>
Initializes a previously allocated #GtkCList widget for use. This should not
......@@ -2193,6 +2219,15 @@ a gtk_object_unref().
@tree_model:
@iter:
<!-- ##### FUNCTION gtk_tree_view_column_set_width ##### -->
<para>
</para>
@tree_column:
@width:
@size:
<!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
<para>
Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
......@@ -2363,6 +2398,14 @@ fundamental type.
@window:
@Returns:
<!-- ##### FUNCTION gtk_window_get_resizeable ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gtk_window_set_decorations_hint ##### -->
<para>
......@@ -2379,3 +2422,12 @@ fundamental type.
@window:
@functions:
<!-- ##### FUNCTION gtk_window_set_resizeable ##### -->
<para>
</para>
@window:
@setting:
@resizeable:
......@@ -3,35 +3,39 @@ Keyboard Accelerators
<!-- ##### SECTION Short_Description ##### -->
global keyboard accelerators (for an entire #GtkWindow)
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkAccelGroup represents a group of keyboard accelerators, attached
to a toplevel #GtkWindow (with gtk_window_add_accel_group()). Usually
you won't need to create a #GtkAccelGroup directly; instead, when
using #GtkItemFactory, GTK+ automatically sets up the accelerators for
your menus.
</para>
<para>
Note that <firstterm>accelerators</firstterm> are different from
<firstterm>mnemonics</firstterm>. Accelerators are shortcuts for
activating a menu item; they appear alongside the menu item they're a
shortcut for, for example "Ctrl+Q" might appear alongside the "Quit"
menu item. Mnemonics are shortcuts for GUI elements such as text
entries or buttons; they appear as underlined characters. See
gtk_label_new_with_mnemonic(). Menu items can have both accelerators
and mnemonics, of course.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
gtk_label_new_with_mnemonic(), gtk_window_add_accel_group()
</para>
<!-- ##### STRUCT GtkAccelGroup ##### -->
<para>
On opaque data type representing a group of accelerators.
</para>
<!-- ##### STRUCT GtkAccelEntry ##### -->
<para>
</para>
@accel_group:
@accelerator_key:
@accelerator_mods:
@accel_flags:
@object:
@signal_id:
<!-- ##### FUNCTION gtk_accel_group_new ##### -->
<para>
......@@ -87,38 +91,84 @@ Keyboard Accelerators
@Returns:
<!-- ##### FUNCTION gtk_accel_group_attach ##### -->
<!-- ##### FUNCTION gtk_accel_group_lock ##### -->
<para>
</para>
@accel_group:
@object:
<!-- ##### FUNCTION gtk_accel_group_detach ##### -->
<!-- ##### FUNCTION gtk_accel_group_unlock ##### -->
<para>
</para>
@accel_group:
@object:
<!-- ##### FUNCTION gtk_accel_group_lock ##### -->
<!-- ##### FUNCTION gtk_accelerator_valid ##### -->
<para>
</para>
@keyval:
@modifiers:
@Returns:
<!-- ##### FUNCTION gtk_accelerator_parse ##### -->
<para>
</para>
@accelerator:
@accelerator_key:
@accelerator_mods:
<!-- ##### FUNCTION gtk_accelerator_name ##### -->
<para>