After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 666364 - GtkEntry: 'activate' documentation needs clarification
GtkEntry: 'activate' documentation needs clarification
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
2.24.x
Other All
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2011-12-16 14:33 UTC by Sean Bright
Modified: 2014-01-22 06:40 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Sean Bright 2011-12-16 14:33:08 UTC 
The current documentation for GtkEntry's activate signal reads, in part:

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control activation programmatically.

This is a point of confusion for some users (read: me), as it's not clear why an application should not connect to this signal and what the recommended alternative is.
Comment 1 Ben Pfaff 2012-01-20 04:09:52 UTC 
I find this extra confusing because the GTK+ FAQ contradicts it: the question "How do I make a GtkEntry widget activate on pressing the Return key?" is answered with "Just attach to the activate signal on the entry..."
Comment 2 David King 2012-11-15 18:21:42 UTC 
Matthias Clasen fixed this in GTK+ 3 (commit 4a25bac0e7685000fff90a211db6ac60f6b74ab1), although the GTK+ 2 documentation still has the problematic sentence. Should that commit be cherry-picked to the gtk-2-24 branch?
Comment 3 William Jon McCann 2014-01-22 06:40:31 UTC 
Cherry-picked to gtk-2-24.