summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtkwidget.xml
diff options
context:
space:
mode:
authorJohn Finlay <finlay@src.gnome.org>2004-11-12 20:36:33 +0000
committerJohn Finlay <finlay@src.gnome.org>2004-11-12 20:36:33 +0000
commitcc6548c16e311c611d1423b709bc39ccbff07423 (patch)
treef97db428f9a2eda1ccbc956ccc95ac87f373d04c /docs/reference/pygtk-gtkwidget.xml
parent05816dabf73d631e85cc53bca27243db2d7fa68d (diff)
downloadpygtk-cc6548c16e311c611d1423b709bc39ccbff07423.tar.gz
Add descriptions of these PyGTK 2.6 methods.
* pygtk-gobject-functions.xml (signal_list_ids, signal_lookup) (signal_name, signal_query): Add descriptions of these PyGTK 2.6 methods. * pygtk-gtkwidget.xml (set_accelerator): Change wording to clarify argument value usage. (stan@saticed.me.uk)
Diffstat (limited to 'docs/reference/pygtk-gtkwidget.xml')
-rw-r--r--docs/reference/pygtk-gtkwidget.xml30
1 files changed, 18 insertions, 12 deletions
diff --git a/docs/reference/pygtk-gtkwidget.xml b/docs/reference/pygtk-gtkwidget.xml
index 0b82cf86..6c027274 100644
--- a/docs/reference/pygtk-gtkwidget.xml
+++ b/docs/reference/pygtk-gtkwidget.xml
@@ -3374,8 +3374,8 @@ toplevel</simpara></listitem>
<varlistentry>
<term><parameter
role="keyword">accel_key</parameter>&nbsp;:</term>
- <listitem><simpara>the keyval of the
-accelerator</simpara></listitem>
+ <listitem><simpara>the keyval of the accelerator e.g.
+<literal>ord('q')</literal></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
@@ -3396,17 +3396,23 @@ an accelerator for the widget in <parameter>accel_group</parameter> that
causes <parameter>accel_signal</parameter> to be emitted if the accelerator
is activated. The accelerator key and modifiers are specified by
<parameter>accel_key</parameter> and <parameter>accel_mods</parameter>
-respectively. <parameter>accel_flags</parameter> is a combination of
-<literal>gtk.ACCEL_VISIBLE</literal> and
-<literal>gtk.ACCEL_LOCKED</literal>. The <parameter>accel_group</parameter>
-needs to be added to the widget's toplevel via the <link
-linkend="method-gtkwindow--add-accel-group"><methodname>gtk.Window.add_accel_group</methodname>()</link>
-method. Accelerators added through this method are not user changeable
-during runtime. If you want to support accelerators that can be changed by
-the user, the <link
-linkend="method-gtkwidget--set-accel-path"><methodname>set_accel_path</methodname>()</link>
+respectively. <parameter>accel_mods</parameter> should be a combination of
+the <link linkend="gdk-modifier-constants">Modifier
+Constants</link>. <parameter>accel_flags</parameter> is a combination of
+<literal>gtk.ACCEL_VISIBLE</literal> and <literal>gtk.ACCEL_LOCKED</literal>
+(see the <link linkend="gtk-accel-flags-constants">Accel Flags
+Constants</link>). The <parameter>accel_group</parameter> needs to be added
+to the widget's toplevel via the <link
+linkend="method-gtkwindow--add-accel-group"><methodname>gtk.Window.add_accel_group</methodname>()</link>
+method and the signal specified by <parameter>accel_signal</parameter> must
+have signal flags that include the <literal>gobject.SIGNAL_ACTION</literal>
+flag (see the <link linkend="gobject-signal-constants">Signal Flag
+Constants</link> for more information). Accelerators added through this
+method are not user changeable during runtime. If you want to support
+accelerators that can be changed by the user, the <link
+linkend="method-gtkwidget--set-accel-path"><methodname>set_accel_path</methodname>()</link>
or <link
-linkend="method-gtkmenuitem--set-accel-path"><methodname>gtk.MenuItem.set_accel_path</methodname>()</link>
+linkend="method-gtkmenuitem--set-accel-path"><methodname>gtk.MenuItem.set_accel_path</methodname>()</link>
methods instead.</para>
</refsect2>