GNOME.org
 

[gtk+] doc fixes

commit f67ab808fd91a2ce27b8b2a21761c756bae09c60
Author: Matthias Clasen <mclasen redhat com>
Date:   Sun Jan 30 23:34:52 2011 -0500

    doc fixes

 docs/reference/gtk/tmpl/gtkrc.sgml |    4 ++--
 gtk/gtkbindings.c                  |   23 ++++++++++++-----------
 gtk/gtkcssprovider.c               |   12 ++++++++++--
 gtk/gtksettings.c                  |    4 ++--
 gtk/gtkstyle.c                     |   22 ++++++++++++----------
 5 files changed, 38 insertions(+), 27 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/gtkrc.sgml b/docs/reference/gtk/tmpl/gtkrc.sgml
index 41adf2a..7901b3b 100644
--- a/docs/reference/gtk/tmpl/gtkrc.sgml
+++ b/docs/reference/gtk/tmpl/gtkrc.sgml
@@ -10,10 +10,10 @@ GTK+ provides resource file mechanism for configuring
 various aspects of the operation of a GTK+ program
 at runtime.
 </para>
-<para>
+<warning>
 In GTK+ 3.0, resource files have been deprecated and replaced
 by CSS-like style sheets, which are understood by #GtkCssProvider.
-</para>
+</warning>
 
 <refsect2><title>Default files</title>
 <para>
diff --git a/gtk/gtkbindings.c b/gtk/gtkbindings.c
index 69598e9..f85f13b 100644
--- a/gtk/gtkbindings.c
+++ b/gtk/gtkbindings.c
@@ -39,11 +39,11 @@
 
 /**
  * SECTION:gtkbindings
- * @Title: GtkBindings
+ * @Title: Bindings
  * @Short_description: Key bindings for individual widgets
- * @See_also: <link linkend="gtk-keyboard-accelerators">Keyboard Accelerators</link>, #GtkCssProvider
+ * @See_also: Keyboard Accelerators, Mnemonics, #GtkCssProvider
  *
- * GtkBinding provides a mechanism for configuring GTK+ key bindings
+ * #GtkBindingSet provides a mechanism for configuring GTK+ key bindings
  * through CSS files. This eases key binding adjustments for application
  * developers as well as users and provides GTK+ users or administrators
  * with high key  binding configurability which requires no application
@@ -56,7 +56,7 @@
  * statement to apply the binding set to specific widget types. Details
  * on the matching mechanism are described under
  * <link linkend="gtkcssprovider-selectors">Selectors</link>
- * in the #GtkCssProvider documentation. Inside the binding-set definition,
+ * in the #GtkCssProvider documentation. Inside the binding set definition,
  * key combinations are bound to one or more specific signal emissions on
  * the target widget. Key combinations are strings consisting of an optional
  * #GdkModifierType name and <link linkend="gdk-Keyboard-Handling">key names</link>
@@ -71,7 +71,7 @@
  * of a #GtkEntry widget to the #GtkEntry::move-cursor signal (so movement
  * occurs in 3-character steps), the following binding can be used:
  * <informalexample><programlisting>
- * @binding-set "MoveCursor3"
+ * @binding-set MoveCursor3
  * {
  *   bind "&lt;Control&gt;Right" { "move-cursor" (visual-positions, 3, 0) };
  *   bind "&lt;Control&gt;Left" { "move-cursor" (visual-positions, -3, 0) };
@@ -94,7 +94,7 @@
  * works as expected. The same mechanism can not be used to "unbind"
  * existing bindings, however.
  * <informalexample><programlisting>
- * @binding-set "MoveCursor3"
+ * @binding-set MoveCursor3
  * {
  *   bind "&lt;Control&gt;Right" {  };
  *   bind "&lt;Control&gt;Left" {  };
@@ -115,7 +115,7 @@
  * implement word movement. To keep GTK+ from activating its default
  * bindings, the "unbind" keyword can be used like this:
  * <informalexample><programlisting>
- * @binding-set "MoveCursor3"
+ * @binding-set MoveCursor3
  * {
  *   unbind "&lt;Control&gt;Right";
  *   unbind "&lt;Control&gt;Left";
@@ -134,6 +134,7 @@
  * </para>
  * </refsect2>
  */
+
 /* --- defines --- */
 #define BINDING_MOD_MASK() (gtk_accelerator_get_default_mod_mask () | GDK_RELEASE_MASK)
 
@@ -1352,18 +1353,18 @@ create_signal_scanner (void)
  * Parses a signal description from @signal_desc and incorporates
  * it into @binding_set.
  *
- * signal descriptions may either bind a key combination to
+ * Signal descriptions may either bind a key combination to
  * one or more signals:
  * <informalexample><programlisting>
- *   bind <replaceable>key</replaceable> {
- *     <replaceable>signalname</replaceable> (<replaceable>param</replaceable>, ...)
+ *   bind "key" {
+ *     "signalname" (param, ...)
  *     ...
  *   }
  * </programlisting></informalexample>
  *
  * Or they may also unbind a key combination:
  * <informalexample><programlisting>
- *   unbind <replaceable>key</replaceable>
+ *   unbind "key"
  * </programlisting></informalexample>
  *
  * Key combinations must be in a format that can be parsed by
diff --git a/gtk/gtkcssprovider.c b/gtk/gtkcssprovider.c
index b43d52f..2c1b8ad 100644
--- a/gtk/gtkcssprovider.c
+++ b/gtk/gtkcssprovider.c
@@ -293,7 +293,15 @@
  * <para>
  * In order to extend key bindings affecting different widgets, GTK+
  * supports the &commat;binding-set rule to parse a set of bind/unbind
- * directives, see #GtkBindingSet for the syntax supported
+ * directives, see #GtkBindingSet for the supported syntax. Note that
+ * the binding sets defined in this way must be associated with rule sets
+ * by setting the gtk-key-bindings style property.
+ * </para>
+ * <para>
+ * Customized key bindings are typically defined in a separate
+ * <filename>gtk-keys.css</filename> CSS file and GTK+ loads this file
+ * according to the current key theme, which is defined by the
+ * #GtkSettings:gtk-key-theme-name setting.
  * </para>
  * <example>
  * <title>Using the &commat;binding rule</title>
@@ -306,7 +314,7 @@
  * &commat;binding-set binding-set2 {
  *   bind "&lt;alt&gt;Right" { "move-cursor" (visual-positions, 3, 0) };
  *   bind "&lt;alt&gt;KP_space" { "delete-from-cursor" (whitespace, 1)
- *                                "insert-at-cursor" (" ") };
+ *                          "insert-at-cursor" (" ") };
  * };
  *
  * GtkEntry {
diff --git a/gtk/gtksettings.c b/gtk/gtksettings.c
index 839509a..44fe5c6 100644
--- a/gtk/gtksettings.c
+++ b/gtk/gtksettings.c
@@ -395,7 +395,7 @@ gtk_settings_class_init (GtkSettingsClass *class)
   result = settings_install_property_parser (class,
                                              g_param_spec_string ("gtk-theme-name",
                                                                    P_("Theme Name"),
-                                                                   P_("Name of theme RC file to load"),
+                                                                   P_("Name of theme to load"),
                                                                   "Raleigh",
                                                                   GTK_PARAM_READWRITE),
                                              NULL);
@@ -422,7 +422,7 @@ gtk_settings_class_init (GtkSettingsClass *class)
   result = settings_install_property_parser (class,
                                              g_param_spec_string ("gtk-key-theme-name",
                                                                   P_("Key Theme Name"),
-                                                                  P_("Name of key theme RC file to load"),
+                                                                  P_("Name of key theme to load"),
                                                                   DEFAULT_KEY_THEME,
                                                                   GTK_PARAM_READWRITE),
                                              NULL);
diff --git a/gtk/gtkstyle.c b/gtk/gtkstyle.c
index ea28217..81105d8 100644
--- a/gtk/gtkstyle.c
+++ b/gtk/gtkstyle.c
@@ -49,20 +49,22 @@
  * @Title: GtkStyle
  *
  * A #GtkStyle object encapsulates the information that provides the look and
- * feel for a widget. Each #GtkWidget has an associated #GTkStyle object that
- * is used when rendering that widget. Also, a #GtkStyle holds information for
- * the five possible widget states though not every widget supports all five
- * states; see #GtkStateType.
- *
- * Usually the #GtkStyle for a widget is the same as the default style that is
- * set by GTK+ and modified the theme engine.
- *
- * Usually applications should not need to use or modify the #GtkStyle of their
- * widgets.
+ * feel for a widget.
  *
  * <warning>
  * In GTK+ 3.0, GtkStyle has been deprecated and replaced by #GtkStyleContext.
  * </warning>
+ *
+ * Each #GtkWidget has an associated #GtkStyle object that is used when
+ * rendering that widget. Also, a #GtkStyle holds information for the five
+ * possible widget states though not every widget supports all five
+ * states; see #GtkStateType.
+ *
+ * Usually the #GtkStyle for a widget is the same as the default style that
+ * is set by GTK+ and modified the theme engine.
+ *
+ * Usually applications should not need to use or modify the #GtkStyle of
+ * their widgets.
  */
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]