Commit c1808baa authored by Matthias Clasen's avatar Matthias Clasen

Doc typo fix. (#68172)

        * gtk/gtksocket.c (gtk_socket_get_id): Doc typo fix. (#68172)

        * gtk/gtktreemodel.c (gtk_tree_path_is_descendant): Fix docs.

        * gtk/gtktreemodel.c (gtk_tree_model_rows_reordered): Document.

        * gtk/gtkwindow.c (gtk_window_remove_accel_group): Fix docs.

        * gtk/gtkrc.c (gtk_rc_get_style_by_paths),
        gtk/gtkwidget.c (gtk_widget_get_toplevel,
        gtk_widget_push_composite_child), gtk/gtkdialog.c
        (gtk_dialog_new_with_buttons, gtk_dialog_run): Keep gtk-doc
        from messing up the indentation of inline examples.

        * gtk/gtkmain.c, gtk/gtkrc.c: Consistently call g_getenv()
        instead of getenv().

        * gtk/gtktreemodel.c, gtk/gtkaccelgroup.c, gtk/gtkclipboard.c,
        gtk/gtkdnd.c, gtk/gtkiconfactory.c, gtk/gtkrc.c,
        gtk/gtkstyle.c, gtk/gtkselection.c: Doc fixes.

        * gtk/gtkaccelmap.c (gtk_accel_map_add_filter,
        gtk_accel_map_foreach_unfiltered, gtk_accel_map_load_scanner):
        Document.

        * gtk/tmpl/gtksocket.sgml: Mention gtk_socket_get_id()
        instead of GTK_WINDOW_XWINDOW().  (#68172)

        * gtk/gtk-sections.txt: Move functions which are documented
        as "private" or "internal" into Private subsections.

        * gtk/tmpl/gtkdnd.sgml, gtk/tmpl/gtkobject.sgml,
        gtk/tmpl/gtkrc.sgml, gtk/tmpl/gtktooltips.sgml,
        gtk/tmpl/gtkwidget.sgml, gtk/tmpl/gtkclipboard.sgml,
        gtk/tmpl/gtkstyle.sgml, gtk/tmpl/gtkselection.sgml,
        gtk/tmpl/gtkfeatures.sgml: Minor markup fixes.

        * gtk/tmpl/gtksignal.sgml: Add link to GLib signal docs.

        * gtk/tmpl/gtkpreview.sgml, gtk/tmpl/gtktext.sgml,
        gtk/tmpl/gtktree.sgml: Remove "deprecated" from short desc.

        * gtk/tmpl/gtkrc.sgml: Correct names of default RC files.
parent 947c91dc
2002-01-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtksocket.c (gtk_socket_get_id): Doc typo fix. (#68172)
* gtk/gtktreemodel.c (gtk_tree_path_is_descendant): Fix docs.
* gtk/gtktreemodel.c (gtk_tree_model_rows_reordered): Document.
* gtk/gtkwindow.c (gtk_window_remove_accel_group): Fix docs.
* gtk/gtkrc.c (gtk_rc_get_style_by_paths),
gtk/gtkwidget.c (gtk_widget_get_toplevel,
gtk_widget_push_composite_child), gtk/gtkdialog.c
(gtk_dialog_new_with_buttons, gtk_dialog_run): Keep gtk-doc
from messing up the indentation of inline examples.
* gtk/gtkmain.c, gtk/gtkrc.c: Consistently call g_getenv()
instead of getenv().
* gtk/gtktreemodel.c, gtk/gtkaccelgroup.c, gtk/gtkclipboard.c,
gtk/gtkdnd.c, gtk/gtkiconfactory.c, gtk/gtkrc.c,
gtk/gtkstyle.c, gtk/gtkselection.c: Doc fixes.
* gtk/gtkaccelmap.c (gtk_accel_map_add_filter,
gtk_accel_map_foreach_unfiltered, gtk_accel_map_load_scanner):
Document.
2002-01-07 Anders Carlsson <andersca@gnu.org>
* gtk/gtkcellrendererpixbuf.c (gtk_cell_renderer_pixbuf_render): Remove
......
2002-01-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtksocket.c (gtk_socket_get_id): Doc typo fix. (#68172)
* gtk/gtktreemodel.c (gtk_tree_path_is_descendant): Fix docs.
* gtk/gtktreemodel.c (gtk_tree_model_rows_reordered): Document.
* gtk/gtkwindow.c (gtk_window_remove_accel_group): Fix docs.
* gtk/gtkrc.c (gtk_rc_get_style_by_paths),
gtk/gtkwidget.c (gtk_widget_get_toplevel,
gtk_widget_push_composite_child), gtk/gtkdialog.c
(gtk_dialog_new_with_buttons, gtk_dialog_run): Keep gtk-doc
from messing up the indentation of inline examples.
* gtk/gtkmain.c, gtk/gtkrc.c: Consistently call g_getenv()
instead of getenv().
* gtk/gtktreemodel.c, gtk/gtkaccelgroup.c, gtk/gtkclipboard.c,
gtk/gtkdnd.c, gtk/gtkiconfactory.c, gtk/gtkrc.c,
gtk/gtkstyle.c, gtk/gtkselection.c: Doc fixes.
* gtk/gtkaccelmap.c (gtk_accel_map_add_filter,
gtk_accel_map_foreach_unfiltered, gtk_accel_map_load_scanner):
Document.
2002-01-07 Anders Carlsson <andersca@gnu.org>
* gtk/gtkcellrendererpixbuf.c (gtk_cell_renderer_pixbuf_render): Remove
......
2002-01-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtksocket.c (gtk_socket_get_id): Doc typo fix. (#68172)
* gtk/gtktreemodel.c (gtk_tree_path_is_descendant): Fix docs.
* gtk/gtktreemodel.c (gtk_tree_model_rows_reordered): Document.
* gtk/gtkwindow.c (gtk_window_remove_accel_group): Fix docs.
* gtk/gtkrc.c (gtk_rc_get_style_by_paths),
gtk/gtkwidget.c (gtk_widget_get_toplevel,
gtk_widget_push_composite_child), gtk/gtkdialog.c
(gtk_dialog_new_with_buttons, gtk_dialog_run): Keep gtk-doc
from messing up the indentation of inline examples.
* gtk/gtkmain.c, gtk/gtkrc.c: Consistently call g_getenv()
instead of getenv().
* gtk/gtktreemodel.c, gtk/gtkaccelgroup.c, gtk/gtkclipboard.c,
gtk/gtkdnd.c, gtk/gtkiconfactory.c, gtk/gtkrc.c,
gtk/gtkstyle.c, gtk/gtkselection.c: Doc fixes.
* gtk/gtkaccelmap.c (gtk_accel_map_add_filter,
gtk_accel_map_foreach_unfiltered, gtk_accel_map_load_scanner):
Document.
2002-01-07 Anders Carlsson <andersca@gnu.org>
* gtk/gtkcellrendererpixbuf.c (gtk_cell_renderer_pixbuf_render): Remove
......
2002-01-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtksocket.c (gtk_socket_get_id): Doc typo fix. (#68172)
* gtk/gtktreemodel.c (gtk_tree_path_is_descendant): Fix docs.
* gtk/gtktreemodel.c (gtk_tree_model_rows_reordered): Document.
* gtk/gtkwindow.c (gtk_window_remove_accel_group): Fix docs.
* gtk/gtkrc.c (gtk_rc_get_style_by_paths),
gtk/gtkwidget.c (gtk_widget_get_toplevel,
gtk_widget_push_composite_child), gtk/gtkdialog.c
(gtk_dialog_new_with_buttons, gtk_dialog_run): Keep gtk-doc
from messing up the indentation of inline examples.
* gtk/gtkmain.c, gtk/gtkrc.c: Consistently call g_getenv()
instead of getenv().
* gtk/gtktreemodel.c, gtk/gtkaccelgroup.c, gtk/gtkclipboard.c,
gtk/gtkdnd.c, gtk/gtkiconfactory.c, gtk/gtkrc.c,
gtk/gtkstyle.c, gtk/gtkselection.c: Doc fixes.
* gtk/gtkaccelmap.c (gtk_accel_map_add_filter,
gtk_accel_map_foreach_unfiltered, gtk_accel_map_load_scanner):
Document.
2002-01-07 Anders Carlsson <andersca@gnu.org>
* gtk/gtkcellrendererpixbuf.c (gtk_cell_renderer_pixbuf_render): Remove
......
2002-01-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtksocket.c (gtk_socket_get_id): Doc typo fix. (#68172)
* gtk/gtktreemodel.c (gtk_tree_path_is_descendant): Fix docs.
* gtk/gtktreemodel.c (gtk_tree_model_rows_reordered): Document.
* gtk/gtkwindow.c (gtk_window_remove_accel_group): Fix docs.
* gtk/gtkrc.c (gtk_rc_get_style_by_paths),
gtk/gtkwidget.c (gtk_widget_get_toplevel,
gtk_widget_push_composite_child), gtk/gtkdialog.c
(gtk_dialog_new_with_buttons, gtk_dialog_run): Keep gtk-doc
from messing up the indentation of inline examples.
* gtk/gtkmain.c, gtk/gtkrc.c: Consistently call g_getenv()
instead of getenv().
* gtk/gtktreemodel.c, gtk/gtkaccelgroup.c, gtk/gtkclipboard.c,
gtk/gtkdnd.c, gtk/gtkiconfactory.c, gtk/gtkrc.c,
gtk/gtkstyle.c, gtk/gtkselection.c: Doc fixes.
* gtk/gtkaccelmap.c (gtk_accel_map_add_filter,
gtk_accel_map_foreach_unfiltered, gtk_accel_map_load_scanner):
Document.
2002-01-07 Anders Carlsson <andersca@gnu.org>
* gtk/gtkcellrendererpixbuf.c (gtk_cell_renderer_pixbuf_render): Remove
......
2002-01-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtksocket.c (gtk_socket_get_id): Doc typo fix. (#68172)
* gtk/gtktreemodel.c (gtk_tree_path_is_descendant): Fix docs.
* gtk/gtktreemodel.c (gtk_tree_model_rows_reordered): Document.
* gtk/gtkwindow.c (gtk_window_remove_accel_group): Fix docs.
* gtk/gtkrc.c (gtk_rc_get_style_by_paths),
gtk/gtkwidget.c (gtk_widget_get_toplevel,
gtk_widget_push_composite_child), gtk/gtkdialog.c
(gtk_dialog_new_with_buttons, gtk_dialog_run): Keep gtk-doc
from messing up the indentation of inline examples.
* gtk/gtkmain.c, gtk/gtkrc.c: Consistently call g_getenv()
instead of getenv().
* gtk/gtktreemodel.c, gtk/gtkaccelgroup.c, gtk/gtkclipboard.c,
gtk/gtkdnd.c, gtk/gtkiconfactory.c, gtk/gtkrc.c,
gtk/gtkstyle.c, gtk/gtkselection.c: Doc fixes.
* gtk/gtkaccelmap.c (gtk_accel_map_add_filter,
gtk_accel_map_foreach_unfiltered, gtk_accel_map_load_scanner):
Document.
2002-01-07 Anders Carlsson <andersca@gnu.org>
* gtk/gtkcellrendererpixbuf.c (gtk_cell_renderer_pixbuf_render): Remove
......
2002-01-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtksocket.c (gtk_socket_get_id): Doc typo fix. (#68172)
* gtk/gtktreemodel.c (gtk_tree_path_is_descendant): Fix docs.
* gtk/gtktreemodel.c (gtk_tree_model_rows_reordered): Document.
* gtk/gtkwindow.c (gtk_window_remove_accel_group): Fix docs.
* gtk/gtkrc.c (gtk_rc_get_style_by_paths),
gtk/gtkwidget.c (gtk_widget_get_toplevel,
gtk_widget_push_composite_child), gtk/gtkdialog.c
(gtk_dialog_new_with_buttons, gtk_dialog_run): Keep gtk-doc
from messing up the indentation of inline examples.
* gtk/gtkmain.c, gtk/gtkrc.c: Consistently call g_getenv()
instead of getenv().
* gtk/gtktreemodel.c, gtk/gtkaccelgroup.c, gtk/gtkclipboard.c,
gtk/gtkdnd.c, gtk/gtkiconfactory.c, gtk/gtkrc.c,
gtk/gtkstyle.c, gtk/gtkselection.c: Doc fixes.
* gtk/gtkaccelmap.c (gtk_accel_map_add_filter,
gtk_accel_map_foreach_unfiltered, gtk_accel_map_load_scanner):
Document.
2002-01-07 Anders Carlsson <andersca@gnu.org>
* gtk/gtkcellrendererpixbuf.c (gtk_cell_renderer_pixbuf_render): Remove
......
2002-01-07 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtksocket.sgml: Mention gtk_socket_get_id()
instead of GTK_WINDOW_XWINDOW(). (#68172)
* gtk/gtk-sections.txt: Move functions which are documented
as "private" or "internal" into Private subsections.
* gtk/tmpl/gtkdnd.sgml, gtk/tmpl/gtkobject.sgml,
gtk/tmpl/gtkrc.sgml, gtk/tmpl/gtktooltips.sgml,
gtk/tmpl/gtkwidget.sgml, gtk/tmpl/gtkclipboard.sgml,
gtk/tmpl/gtkstyle.sgml, gtk/tmpl/gtkselection.sgml,
gtk/tmpl/gtkfeatures.sgml: Minor markup fixes.
* gtk/tmpl/gtksignal.sgml: Add link to GLib signal docs.
* gtk/tmpl/gtkpreview.sgml, gtk/tmpl/gtktext.sgml,
gtk/tmpl/gtktree.sgml: Remove "deprecated" from short desc.
* gtk/tmpl/gtkrc.sgml: Correct names of default RC files.
2002-01-06 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtktypeutils.sgml: Replace GTK_NO_CHECK_CASTS by
......
......@@ -1688,8 +1688,6 @@ GtkObjectFlags
GTK_OBJECT_FLAGS
GTK_OBJECT_FLOATING
GTK_OBJECT_CONNECTED
GTK_OBJECT_SET_FLAGS
GTK_OBJECT_UNSET_FLAGS
GtkArgFlags
gtk_object_new
gtk_object_sink
......@@ -1726,6 +1724,8 @@ GTK_OBJECT_GET_CLASS
<SUBSECTION Private>
gtk_object_get_type
GTK_ARG_READWRITE
GTK_OBJECT_SET_FLAGS
GTK_OBJECT_UNSET_FLAGS
</SECTION>
<SECTION>
......@@ -3990,7 +3990,7 @@ gtk_selection_data_targets_include_text
gtk_selection_remove_all
gtk_selection_data_copy
gtk_selection_data_free
<SUBSECTION Internals>
<SUBSECTION Private>
gtk_selection_clear
gtk_selection_incr_event
gtk_selection_notify
......
......@@ -2,7 +2,7 @@
Clipboards
<!-- ##### SECTION Short_Description ##### -->
Storing data on Clipboards.
Storing data on clipboards.
<!-- ##### SECTION Long_Description ##### -->
<para>
......@@ -34,7 +34,7 @@ Storing data on Clipboards.
with callbacks to convert it into the various data types that you
advertise. When the @clear_func you provided is called, you
simply free the data blob. The latter is more useful when the
contents of clipboard reflect the internal state of a @GObject
contents of clipboard reflect the internal state of a #GObject
(As an example, for the PRIMARY clipboard, when an entry widget
provides the clipboard's contents the contents are simply the
text within the selected region.) If the contents change, the
......@@ -53,7 +53,7 @@ Storing data on Clipboards.
callback that will be called when the contents are received (or
when the request fails.) If you don't want to deal with providing
a separate callback, you can also use gtk_clipboard_wait_for_contents().
What this does is run the Glib main loop recursively waiting for
What this does is run the GLib main loop recursively waiting for
the contents. This can simplify the code flow, but you still have
to be aware that other callbacks in your program can be called
while this recursive mainloop is running.
......@@ -75,7 +75,7 @@ Storing data on Clipboards.
<varlistentry>
<term>#GtkSelection</term>
<listitem><para>@GtkClipboard provides a high-level wrapper around the
<listitem><para>#GtkClipboard provides a high-level wrapper around the
lower level routines that deal with X selections. It is
also possibly to directly manipulate the X selections,
though it is seldom necessary to do so.</para></listitem>
......
......@@ -26,35 +26,21 @@ in the #GtkWidget class.
<!-- ##### ENUM GtkDestDefaults ##### -->
<para>
The #GtkDestfaults enumeration specifies the various
The #GtkDestDefaults enumeration specifies the various
types of action that will be taken on behalf
of the user for a drag destination site.
</para>
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry><symbol>GTK_DEST_DEFAULT_MOTION</symbol></entry>
<entry>
@GTK_DEST_DEFAULT_MOTION:
If set for a widget, GTK+, during a drag over this
widget will check if the drag matches this widget's
list of possible targets and actions.
GTK+ will then call gtk_drag_status() as appropriate.
</entry>
</row>
<row>
<entry><symbol>GTK_DEST_DEFAULT_HIGHLIGHT</symbol></entry>
<entry>
@GTK_DEST_DEFAULT_HIGHLIGHT:
If set for a widget, GTK+ will draw a highlight on
this widget as long as a drag is over this widget
and the widget drag format and action are acceptable.</entry>
</row>
<row>
<entry><symbol>GTK_DEST_DEFAULT_DROP</symbol></entry>
<entry>
and the widget drag format and action are acceptable.
@GTK_DEST_DEFAULT_DROP:
If set for a widget, when a drop occurs, GTK+ will
will check if the drag matches this widget's
list of possible targets and actions. If so,
......@@ -64,50 +50,23 @@ of the user for a drag destination site.
was a move, then if the drag was successful, then
%TRUE will be passed for the @delete parameter
to gtk_drag_finish().
</entry>
</row>
<row>
<entry><symbol>GTK_DEST_DEFAULT_ALL</symbol></entry>
<entry>
@GTK_DEST_DEFAULT_ALL:
If set, specifies that all default actions should
be taken.
</entry>
</row>
</tbody></tgroup></informaltable>
@GTK_DEST_DEFAULT_MOTION:
@GTK_DEST_DEFAULT_HIGHLIGHT:
@GTK_DEST_DEFAULT_DROP:
@GTK_DEST_DEFAULT_ALL:
<!-- ##### ENUM GtkTargetFlags ##### -->
<para>
The #GtkTargetFlags enumeration is used to specify
constraints on an entry in a #GtkTargetTable.
</para>
<variablelist>
<varlistentry><term> %GTK_TARGET_SAME_APP </term>
<listitem>
<para>
@GTK_TARGET_SAME_APP:
If this is set, the target will only be selected
for drags within a single application.
</para>
</listitem>
</varlistentry>
<varlistentry><term> %GTK_TARGET_SAME_WIDGET </term>
<listitem>
<para>
@GTK_TARGET_SAME_WIDGET:
If this is set, the target will only be selected
for drags within a single widget.
</para>
</listitem>
</varlistentry>
</variablelist>
@GTK_TARGET_SAME_APP:
@GTK_TARGET_SAME_WIDGET:
<!-- ##### FUNCTION gtk_drag_dest_set ##### -->
<para>
......@@ -119,7 +78,7 @@ Sets a widget as a potential drop destination.
on behalf of a widget for drops onto that widget. The @targets
and @actions fields only are used if %GTK_DEST_DEFAULT_MOTION
or %GTK_DEST_DEFAULT_DROP are given.
@targets: a pointer to an array of #GtkTargetEntry indicating
@targets: a pointer to an array of #GtkTargetEntry<!>s indicating
the drop types that this widget will accept.
@n_targets: the number of entries in @targets.
@actions: a bitmask of possible actions for a drop onto this
......@@ -194,7 +153,7 @@ that the data of the drag will no longer be required.
<!-- ##### FUNCTION gtk_drag_get_data ##### -->
<para>
Get the data associated with a drag. When the data
Gets the data associated with a drag. When the data
is received or the retrieval fails, GTK+ will emit a
"drag_data_received" signal. Failure of the retrieval
is indicated by the length field of the @selection_data
......
......@@ -60,15 +60,17 @@ represents the micro version of the GTK+ headers you have included.
<!-- ##### VARIABLE gtk_binary_age ##### -->
<para>
This is the binary age passed to libtool. If "libtool" means nothing
to you, don't worry about it. ;-)
This is the binary age passed to <application>libtool</application>. If
<application>libtool</application> means nothing to you, don't worry
about it. ;-)
</para>
<!-- ##### VARIABLE gtk_interface_age ##### -->
<para>
This is the interface age passed to libtool. If "libtool" means nothing
to you, don't worry about it. ;-)
This is the interface age passed to <application>libtool</application>. If
<application>libtool</application> means nothing to you, don't worry
about it. ;-)
</para>
......@@ -87,7 +89,7 @@ micro version of GTK+ than the one they were compiled against.
@required_major: the required major version.
@required_minor: the required major version.
@required_micro: the required major version.
@Returns: NULL if the GTK+ library is compatible with the given version, or
@Returns: %NULL if the GTK+ library is compatible with the given version, or
a string describing the version mismatch.
......@@ -142,8 +144,8 @@ Returns %TRUE if the version of the GTK+ header files is the same
as the passed-in version.
</para>
@major: major version (first number in 1.2.5)
@minor: minor version (second number in 1.2.5)
@micro: micro version (third number in 1.2.5)
@major: major version (e.g. 1 for version 1.2.5)
@minor: minor version (e.g. 2 for version 1.2.5)
@micro: micro version (e.g. 5 for version 1.2.5)
......@@ -80,7 +80,7 @@ In particular, widgets are almost always destroyed in this way.
</para></listitem>
<listitem><para> Because of the floating reference count, you don't need to
worry about reference counting for widgets and toplevel windows, unless you
explicitly call g_object_ref() yourself. </para></listitem>
explicitly call g_object_ref() yourself.</para></listitem>
</itemizedlist>
</para>
......
......@@ -2,7 +2,7 @@
GtkPreview
<!-- ##### SECTION Short_Description ##### -->
deprecated widget to display RGB or grayscale data.
widget to display RGB or grayscale data.
<!-- ##### SECTION Long_Description ##### -->
<para>
......
......@@ -16,28 +16,33 @@ at runtime.
An application can cause GTK+ to parse a specific RC
file by calling gtk_rc_parse(). In addition to this,
certain files will be read at the end of gtk_init().
Unless modified, the files looked for will be <filename>.gtkrc</filename>
in the users home directory, and
<filename>$localstatedir/gtk/gtkrc</filename>
(<literal>$localstatedir</literal> defaults to
<filename>/usr/local/etc</filename>).
Unless modified, the files looked for will be
<filename>&lt;SYSCONFDIR&gt;/gtk-2.0/gtkrc</filename>
and <filename>.gtkrc-2.0</filename> in the users home directory.
(<filename>&lt;SYSCONFDIR&gt;</filename> defaults to
<filename>/usr/local/etc</filename>. It can be changed with the
<option>--prefix</option> or <option>--sysconfdir</option> options when
configuring GTK+.)
</para>
<para>
The set of these <firstterm>default</firstterm> files
can be retrieved with gtk_rc_get_default_files()
and modified with gtk_rc_add_default_file() and
gtk_rc_set_default_files().
Additionally, the <envar>GTK_RC_FILES</envar> environment variable
can be set to a #G_SEARCHPATH_SEPARATOR_S-separated list of files
in order to overwrite the set of default files at runtime.
</para>
<para>
For each default file, in addition to the file itself,
GTK+ will look for a locale-specific file that will
be parsed in addition to the main file. For instance,
if <literal>LANG</literal> is set to <literal>ja_JP.ujis</literal>,
be parsed before the main file. For instance,
if <envar>LANG</envar> is set to <literal>ja_JP.ujis</literal>,
when loading the default file <filename>~/.gtkrc</filename>
then GTK+ looks for <filename>~/.gtkrc.ja_JP.ujis</filename>,
<filename>~/.gtkrc.ja_JP</filename>, and
<filename>~/.gtkrc.ja</filename>, and parses the
first one it finds.
<filename>~/.gtkrc.ja</filename>, and parses all files that
it finds.
</para>
</refsect2>
......@@ -68,12 +73,12 @@ hierarchy. Both the widget and the class paths consists of a
parents of the widget and the widget itself from
outermost to innermost. The difference is that in
the widget path, the name assigned by
<function>gtk_widget_set_name()</function> is used
gtk_widget_set_name() is used
if present, otherwise the class name of the widget, while
for the widget path, the class name is always used.
</para>
<para>
So, if you have a <classname>GtkEntry</classname> named
So, if you have a #GtkEntry named
<literal>"myentry"</literal>, inside of a of a window
named <literal>"mywindow"</literal>, then the
widget path is: <literal>"mwindow.GtkHBox.myentry"</literal>
......@@ -87,18 +92,18 @@ pattern:
<informalexample><programlisting>
class "GtkButton" style "my-style"
</programlisting></informalexample>
will match not just <classname>GtkButton</classname> widgets,
but also <classname>GtkToggleButton</classname> and
<classname>GtkCheckButton</classname> widgets, since
those classes derive from <classname>GtkButton</classname>.
will match not just #GtkButton widgets,
but also #GtkToggleButton and
#GtkCheckButton widgets, since
those classes derive from #GtkButton.
</para>
</refsect2>
<refsect2><title>Toplevel declarations</title>
<para>
An RC file is a text file which is composed of a sequence
of declarations. '#' characters delimit comments and
the portion of a line after a '#' is ignored when parsing
of declarations. <literal>'#'</literal> characters delimit comments and
the portion of a line after a <literal>'#'</literal> is ignored when parsing
an RC file.
</para>
......@@ -110,7 +115,7 @@ The possible toplevel declarations are:
<term><literal>binding <replaceable>name</replaceable>
{ ... }</literal></term>
<listitem>
<para>Declare a binding set</para>
<para>Declares a binding set.</para>
</listitem>
</varlistentry>
<varlistentry>
......@@ -118,14 +123,14 @@ The possible toplevel declarations are:
[ style | binding [ : <replaceable>priority</replaceable> ]]
<replaceable>name</replaceable></literal></term>
<listitem>
<para>Specify a style or binding set for a particular
<para>Specifies a style or binding set for a particular
branch of the inheritance hierarchy.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>include <replaceable>filename</replaceable></literal></term>
<listitem>
<para>Parse another file at this point</para>
<para>Parses another file at this point.</para>
</listitem>
</varlistentry>
<varlistentry>
......@@ -148,7 +153,7 @@ The possible toplevel declarations are:
<term><literal>style <replaceable>name</replaceable> [ =
<replaceable>parent</replaceable> ] { ... }</literal></term>
<listitem>
<para>Declare a style</para>
<para>Declares a style.</para>
</listitem>
</varlistentry>
<varlistentry>
......@@ -156,7 +161,7 @@ The possible toplevel declarations are:
[ style | binding [ : <replaceable>priority</replaceable> ]]
<replaceable>name</replaceable></literal></term>
<listitem>
<para>Specify a style or binding set for a particular
<para>Specifies a style or binding set for a particular
group of widgets by matching on the widget pathname.</para>
</listitem>
</varlistentry>
......@@ -165,7 +170,7 @@ The possible toplevel declarations are:
[ style | binding [ : <replaceable>priority</replaceable> ]]
<replaceable>name</replaceable></literal></term>
<listitem>
<para>Specify a style or binding set for a particular
<para>Specifies a style or binding set for a particular
group of widgets by matching on the class pathname.</para>
</listitem>
</varlistentry>
......@@ -197,7 +202,7 @@ elements are:
<replaceable>color</replaceable></literal></term>
<listitem>
<para>
Set color used for the background of most widgets.
Sets the color used for the background of most widgets.
</para>
</listitem>
</varlistentry>
......@@ -206,7 +211,7 @@ elements are:
<replaceable>color</replaceable></literal></term>
<listitem>
<para>
Set color used for the foreground of most widgets.
Sets the color used for the foreground of most widgets.
</para>
</listitem>
</varlistentry>
......@@ -215,7 +220,7 @@ elements are:
<replaceable>color</replaceable></literal></term>
<listitem>
<para>
Set color used for the background of widgets displaying
Sets the color used for the background of widgets displaying
editable text. This color is used for the background
of, among others, #GtkText, #GtkEntry, #GtkList, and #GtkClist.
</para>
......@@ -226,7 +231,7 @@ elements are:
<replaceable>color</replaceable></literal></term>
<listitem>
<para>
Set color used for foreground of widgets using
Sets the color used for foreground of widgets using
<literal>base</literal> for the background color.
</para>
</listitem>
......@@ -236,7 +241,7 @@ elements are:
<replaceable>pixmap</replaceable></literal></term>
<listitem>
<para>
Set a background pixmap to be used in place of
Sets a background pixmap to be used in place of
the <literal>bg</literal> color (or for #GtkText,
in place of the <literal>base</literal> color. The special
value "&lt;parent&gt;" may be used to indicate that the widget should
......@@ -249,7 +254,7 @@ elements are:
<term><literal>font = <replaceable>font</replaceable></literal></term>
<listitem>
<para>
Set the font for a widget.
Sets the font for a widget.
</para>
</listitem>
</varlistentry>
......@@ -257,7 +262,7 @@ elements are:
<term><literal>fontset = <replaceable>font</replaceable></literal></term>
<listitem>
<para>
Set the fontset for a widget. Overrides any
Sets the fontset for a widget. Overrides any
<literal>font</literal> declarations.
</para>
</listitem>
......@@ -281,7 +286,7 @@ state of the widget. The states are:
<term><literal>NORMAL</literal></term>
<listitem>
<para>
A color used for a widget in its normal state
A color used for a widget in its normal state.
</para>
</listitem>
</varlistentry>
......@@ -314,8 +319,8 @@ state of the widget. The states are:
<listitem>
<para>
A color used to highlight data selected by the user.
for instance, the selected ListItems in a List widget, and the
selection in an Editable widget.
for instance, the selected items in a list widget, and the
selection in an editable widget.
</para>
</listitem>
</varlistentry>
......@@ -324,7 +329,7 @@ state of the widget. The states are:
<listitem>
<para>
A color used for the background of widgets that have
been set insensitive with gtk_widget_set_sensitive()
been set insensitive with gtk_widget_set_sensitive().
</para>
</listitem>
</varlistentry>
......@@ -515,41 +520,11 @@ The #GtkRcFlags enumeration is used as a bitmask
to specify which fields of a #GtkRcStyle have been
set for each state.
</para>
<variablelist>
<varlistentry><term> %GTK_RC_FG </term>
<listitem>
<para>
If present, the foreground color has been set for this state.
</para>
</listitem>
</varlistentry>
<varlistentry><term> %GTK_RC_BG </term>
<listitem>
<para>
If present, the background color has been set for this state.
</para>
</listitem>
</varlistentry>
<varlistentry><term> %GTK_RC_TEXT </term>
<listitem>
<para>
If present, the text color has been set for this state.
</para>
</listitem>
</varlistentry>
<varlistentry><term> %GTK_RC_BASE </term>
<listitem>
<para>
If present, the base color has been set for this state.
</para>
</listitem>
</varlistentry>
</variablelist>
@GTK_RC_FG:
@GTK_RC_BG:
@GTK_RC_TEXT:
@GTK_RC_BASE:
@GTK_RC_FG: If present, the foreground color has been set for this state.
@GTK_RC_BG: If present, the background color has been set for this state.
@GTK_RC_TEXT: If present, the text color has been set for this state.
@GTK_RC_BASE: If present, the base color has been set for this state.
<!-- ##### ENUM GtkRcTokenType ##### -->
<para>
......@@ -628,7 +603,7 @@ specific portions of a RC file.
<!-- ##### FUNCTION gtk_rc_add_widget_name_style ##### -->
<para>
Adds a RcStyle that will be looked up by a match against
Adds a #GtkRcStyle that will be looked up by a match against
the widget's pathname. This is equivalent to a:
<literal>
widget PATTERN style STYLE
......@@ -642,7 +617,7 @@ statement in a RC file.
<!-- ##### FUNCTION gtk_rc_add_widget_class_style ##### -->
<para>
Adds a RcStyle that will be looked up by a match against
Adds a #GtkRcStyle that will be looked up by a match against
the widget's class pathname. This is equivalent to a:
<literal>
widget_class PATTERN style STYLE
......@@ -656,7 +631,7 @@ statement in a RC file.
<!-- ##### FUNCTION gtk_rc_add_class_style ##### -->
<para>
Adds a RcStyle that will be looked up by a matching against
Adds a #GtkRcStyle that will be looked up by a matching against
the class hierarchy of the widget. This is equivalent to a:
<literal>