Commit e848df06 authored by Matthias Clasen's avatar Matthias Clasen

Small additions and corrections

svn path=/trunk/; revision=18449
parent 981127c7
2007-07-11 Matthias Clasen <mclasen@redhat.com>
* gtk/tmpl/gtkbox.sgml:
* gtk/tmpl/gtksignal.sgml:
* gtk/tmpl/gtkaboutdialog.sgml:
* gtk/tmpl/gtkbindings.sgml:
* gtk/tmpl/gtklabel.sgml:
* gtk/tmpl/gtkstatusbar.sgml: Small additions and corrections.
2007-07-11 Matthias Clasen <mclasen@redhat.com>
* gtk/gtk-sections.txt: Additions
......
......@@ -413,12 +413,10 @@ link is activated.
</para>
@about: the #GtkAboutDialog in which the link was activated
@link_:
@link_: the URL or email address to which the activated link points
@data: user data that was passed when the function was registered
with gtk_about_dialog_set_email_hook() or
gtk_about_dialog_set_url_hook()
<!-- # Unused Parameters # -->
@link: the URL or email address to whiche the activated link points
<!-- ##### FUNCTION gtk_about_dialog_set_email_hook ##### -->
......
......@@ -6,10 +6,10 @@ Key bindings for individual widgets
<!-- ##### SECTION Long_Description ##### -->
<para>
GtkBinding provides a mechanism for configuring Gtk+ key bindings through RC 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 or toolkit side changes.
GtkBinding provides a mechanism for configuring GTK+ key bindings through
RC 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 or toolkit side changes.
</para>
<refsect2>
......@@ -17,20 +17,23 @@ requires no application or toolkit side changes.
<title>Installing a key binding</title>
<para>
A resource file binding consists of a 'binding' definition and a match statement to
apply the binding to specific widget types. Details on the matching mechanism are
described under <link linkend="gtkrc-pathnames-and-patterns">Pathnames and patterns</link>.
Inside the binding definition, key combinations are bound to 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> such as those defined in
<filename>&lt;gdk/gdkkeysyms.h&gt;</filename> or returned from gdk_keyval_name(), they have
to be parsable by gtk_accelerator_parse().
Specifications of signal emissions consist of a string identifying the signal name, and
a list of signal specific arguments in parenthesis.
For example for binding Control and the left or right cursor keys of a #GtkEntry widget to the
#GtkEntry::move-cursor signal, so movement occurs in 3 letter steps,
the following binding can be used:
A resource file binding consists of a 'binding' definition and a match
statement to apply the binding to specific widget types. Details on the
matching mechanism are described under
<link linkend="gtkrc-pathnames-and-patterns">Pathnames and patterns</link>.
Inside the binding definition, key combinations are bound to 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> such as those defined
in <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> or returned from
gdk_keyval_name(), they have to be parsable by gtk_accelerator_parse().
Specifications of signal emissions consist of a string identifying the signal
name, and a list of signal specific arguments in parenthesis.
</para>
<para>
For example for binding Control and the left or right cursor keys of a
#GtkEntry widget to the #GtkEntry::move-cursor signal, so movement occurs
in 3 letter steps, the following binding can be used:
<informalexample><programlisting>
binding "MoveCursor3" {
......@@ -49,12 +52,12 @@ class "GtkEntry" binding "MoveCursor3"
<anchor id="gtk-bindings-unbind"/>
<title>Unbinding existing key bindings</title>
<para>
Gtk+ already defines a number of useful bindings for the widgets it provides.
Because custom bindings set up in RC files take precedence over the default bindings
shipped with Gtk+, overriding existing bindings as demonstrated in
GTK+ already defines a number of useful bindings for the widgets it provides.
Because custom bindings set up in RC files take precedence over the default
bindings shipped with GTK+, overriding existing bindings as demonstrated in
<link linkend="gtk-bindings-install">Installing a key binding</link>
works as expected. The same mechanism can not be used to "unbind" existing bindings,
however.
works as expected. The same mechanism can not be used to "unbind" existing
bindings, however.
<informalexample><programlisting>
binding "MoveCursor3" {
......@@ -64,14 +67,15 @@ binding "MoveCursor3" {
class "GtkEntry" binding "MoveCursor3"
</programlisting></informalexample>
The above example will not have the desired effect of causing "&lt;Control&gt;Right"
and "&lt;Control&gt;Left" key presses to be ignored by Gtk+. Instead, it just causes
any existing bindings from the bindings set "MoveCursor3" to be deleted, so when
"&lt;Control&gt;Right" or "&lt;Control&gt;Left" are pressed, no binding for these keys
is found in binding set "MoveCursor3". Gtk+ will thus continue to search for matching
key bindings, and will eventually lookup and find the default Gtk+ bindings for entries
which implement word movement. To keep Gtk+ from activating its default bindings, the
"unbind" keyword can be used like this:
The above example will not have the desired effect of causing
"&lt;Control&gt;Right" and "&lt;Control&gt;Left" key presses to be ignored
by GTK+. Instead, it just causes any existing bindings from the bindings
set "MoveCursor3" to be deleted, so when "&lt;Control&gt;Right" or
"&lt;Control&gt;Left" are pressed, no binding for these keys is found in
binding set "MoveCursor3". GTK+ will thus continue to search for matching
key bindings, and will eventually lookup and find the default GTK+ bindings
for entries which implement word movement. To keep GTK+ from activating its
default bindings, the "unbind" keyword can be used like this:
<informalexample><programlisting>
binding "MoveCursor3" {
......@@ -81,12 +85,15 @@ binding "MoveCursor3" {
class "GtkEntry" binding "MoveCursor3"
</programlisting></informalexample>
Now, Gtk+ will find a match when looking up "&lt;Control&gt;Right" and "&lt;Control&gt;Left"
key presses before it resorts to its default bindings, and the match instructs it to abort
("unbind") the search, so the key presses are not consumed by this widget.
As usual, further processing of the key presses, e.g. by an entries parent widget,
is now possible.
Now, GTK+ will find a match when looking up "&lt;Control&gt;Right" and
"&lt;Control&gt;Left" key presses before it resorts to its default
bindings, and the match instructs it to abort ("unbind") the search, so
the key presses are not consumed by this widget. As usual, further processing
of the key presses, e.g. by an entry's parent widget, is now possible.
</para>
<para>
The "unbind" functionality has been introduced in GTK+ 2.12.
</para>
</refsect2>
......@@ -104,7 +111,7 @@ is now possible.
<varlistentry>
<term><link linkend="Resource-Files">Resource Files</link>
</term>
<listitem><para>Gtk+ Resource Files - behavior and style definitions.</para></listitem>
<listitem><para>GTK+ Resource Files - behavior and style definitions.</para></listitem>
</varlistentry>
</variablelist>
......@@ -117,9 +124,10 @@ is now possible.
<para>
A binding set maintains a list of activatable key bindings.
A single binding set can match multiple types of widgets.
Similar to styles, widgets can be mapped by widget name paths, widget class paths or widget class types.
When a binding within a set is matched upon activation, an action signal is emitted on
the target widget to carry out the actual activation.
Similar to styles, widgets can be mapped by widget name paths, widget
class paths or widget class types. When a binding within a set is
matched upon activation, an action signal is emitted on the target
widget to carry out the actual activation.
</para>
@set_name: unique binding set name
......@@ -133,7 +141,8 @@ the target widget to carry out the actual activation.
<!-- ##### STRUCT GtkBindingEntry ##### -->
<para>
Each key binding element of a binding sets binding list is represented by a #GtkBindingEntry.
Each key binding element of a binding sets binding list is represented by
a #GtkBindingEntry.
</para>
@keyval: key value to match
......@@ -141,7 +150,7 @@ Each key binding element of a binding sets binding list is represented by a #Gtk
@binding_set: binding set this entry belongs to
@destroyed: implementation detail
@in_emission: implementation detail
@marks_unbound:
@marks_unbound: implementation detail
@set_next: linked list of entries maintained by binding set
@hash_next: implementation detail
@signals: action signals of this entry
......
......@@ -179,7 +179,7 @@ application.)
%TRUE by default.
@pack: one of #GtkPackType indicating whether the child is packed with
reference to the start (top/left) or end (bottom/right) of the GtkBox.
@is_secondary:
@is_secondary: %TRUE if the child is secondary
<!-- ##### FUNCTION gtk_box_pack_start ##### -->
<para>
......
......@@ -373,7 +373,7 @@ Parses the given string for underscores and converts the next
character to an underlined character. The last character that
was underlined will have its lower-cased accelerator keyval returned (i.e.
&quot;_File&quot; would return the keyval for &quot;f&quot;. This is
probably only used within the Gtk+ library itself for menu items and such.
probably only used within the GTK+ library itself for menu items and such.
</para>
@label: The #GtkLabel you want to affect.
......@@ -402,7 +402,7 @@ probably only used within the Gtk+ library itself for menu items and such.
<!-- ##### MACRO gtk_label_set ##### -->
<para>
Aliases gtk_label_set_text(). Probably used for backward compatibility with
Gtk+ 1.0.x.
GTK+ 1.0.x.
</para>
......
......@@ -15,7 +15,7 @@ It may also have a resize grip (a triangular area in the lower right corner)
which can be clicked on to resize the window containing the statusbar.
</para>
<para>
Status bars in Gtk+ maintain a stack of messages. The message at
Status bars in GTK+ maintain a stack of messages. The message at
the top of the each bar's stack is the one that will currently be displayed.
</para>
<para>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment