Check-in [81708cd9ed]

	"174":{"url":"./tip/174.md","tcl-ticket":"1578137","created":"15-Mar-2004","post-history":"","state":"Final","tcl-version":"8.5","vote":"Done","type":"Project","title":"# TIP 174: Math Operators as Commands","author":["Kristoffer Lawson <[email protected]>","Donal K. Fellows <[email protected]>","David S. Cargo <[email protected]>","Peter Spjuth <[email protected]>","Kevin B. Kenny <[email protected]>"],"is-jest":false},
	"173":{"url":"./tip/173.md","created":"11-Mar-2004","post-history":"","state":"Final","tcl-version":"8.5","vote":"Done","type":"Project","title":"# TIP 173: Internationalisation and Refactoring of the 'clock' Command","discussions-to":"news:comp.lang.tcl","author":["Kevin Kenny <[email protected]>"],"is-jest":false},
	"172":{"url":"./tip/172.md","created":"08-Mar-2004","obsoleted-by":"248","post-history":"","state":"Withdrawn","tcl-version":"8.5","vote":"No voting","type":"Project","title":"# TIP 172: Improve UNIX Tk Look and Feel","author":["David N. Welton <[email protected]>"],"is-jest":false},
	"171":{"url":"./tip/171.md","created":"05-Mar-2004","post-history":"","state":"Final","tcl-version":"8.6","vote":"Done","type":"Project","title":"# TIP 171: Change Default <MouseWheel> Bindings Behavior","author":["Jeff Hobbs <[email protected]>","Keith Vetter <[email protected]>"],"is-jest":false},
	"170":{"url":"./tip/170.md","created":"30-Jan-2004","post-history":"","state":"Draft","implementation-url":"http://nac.sf.net/","tcl-version":"8.7","vote":"Pending","type":"Project","title":"# TIP 170: Better Support for Nested Lists","author":["Sergey Babkin <[email protected]>","Don Porter <[email protected]>","Donal K. Fellows <[email protected]>"],"is-jest":false},
	"169":{"url":"./tip/169.md","tk-ticket":"994629","created":"28-Jan-2004","post-history":"","state":"Final","tcl-version":"8.5","vote":"Done","type":"Project","title":"# TIP 169: Add Peer Text Widgets","author":["Brian Griffin <[email protected]>","Vince Darley <[email protected]>"],"is-jest":false},
	"168":{"url":"./tip/168.md","tk-ticket":"886240","created":"25-Jan-2004","post-history":"","state":"Final","vote":"Done","tcl-version":"8.5","type":"Project","title":"# TIP 168: Cubic Bezier Curves on the Canvas","author":["Lars Hellström <[email protected]>"],"is-jest":false},
	"167":{"url":"./tip/167.md","created":"19-Nov-2003","post-history":"","state":"Draft","tk-branch":"tip-167","tcl-version":"8.7","vote":"Pending","type":"Project","title":"# TIP 167: Add a New Option for Context Help for Windows","author":["Ramon Ribó <[email protected]>"],"is-jest":false},
	"166":{"url":"./tip/166.md","keywords":"Tk,image get,image put","created":"19-Nov-2003","post-history":"","state":"Final","tk-branch":"tip-166","tcl-version":"8.7","vote":"Done","type":"Project","title":"# TIP 166: Reading and Writing the Photo Image Alpha Channel","author":["Donal K. Fellows <[email protected]>","Simon Bachmann <[email protected]>"],"is-jest":false},
	"165":{"url":"./tip/165.md","tk-ticket":"1008975","keywords":"Tk,substitution","created":"17-Nov-2003","post-history":"","state":"Final","tcl-version":"8.5","vote":"Done","type":"Project","title":"# TIP 165: A User-Data Field for Virtual Events","author":["Donal K. Fellows <[email protected]>"],"is-jest":false},
	"164":{"url":"./tip/164.md","keywords":"Tk,canvas","state":"Final","type":"Project","tk-branch":"tip-164","author":["Arjen Markus <[email protected]>","Dimitrios Zachariadis <[email protected]>","Donal K. Fellows <[email protected]>"],"votes-for":"DKF, JN, FV, SL, AK","votes-against":"none","created":"17-Nov-2003","title":"# TIP 164: Add Rotate Subcommand to the Canvas Widget","post-history":"","vote":"Done","tcl-version":"8.7","votes-present":"none","is-jest":false},
	"163":{"url":"./tip/163.md","tcl-ticket":"745851","created":"14-Nov-2003","post-history":"","state":"Final","vote":"Done","tcl-version":"8.5","type":"Project","title":"# TIP 163: A [dict merge] Subcommand","author":["Joe English <[email protected]>"],"is-jest":false},
	"162":{"url":"./tip/162.md","created":"23-Oct-2003","post-history":"","state":"Final","tcl-branch":"rmax-ipv6-branch","tcl-version":"8.6","vote":"Done","type":"Project","title":"# TIP 162: IPv6 Sockets for Tcl","author":["Rafael Martínez Torres <[email protected]>","Donal K. Fellows <[email protected]>","Reinhard Max <[email protected]>"],"is-jest":false},
	"161":{"url":"./tip/161.md","created":"19-Oct-2003","post-history":"","state":"Final","tk-branch":"tip-161","tcl-version":"8.7","vote":"Done","type":"Project","title":"# TIP 161: Change Default for Menu's -tearoff Option to False","author":["Mark Roseman <[email protected]>","François Vogel <[email protected]>"],"is-jest":false},
	"160":{"url":"./tip/160.md","state":"Final","type":"Project","author":["Donal K. Fellows <[email protected]>"],"votes-for":"DKF, JN, SL, AK","votes-against":"none","created":"17-Oct-2003","title":"# TIP 160: Improvements to Terminal and Serial Channel Handling","post-history":"","tcl-version":"8.7","vote":"Done","tcl-branch":"tip-160","votes-present":"FV","is-jest":false},

	"4":{"url":"./tip/4.md","created":"26-Oct-2000","post-history":"","state":"Draft","vote":"Pending","type":"Informative","title":"# TIP 4: Tcl Release and Distribution Philosophy","discussions-to":"news:comp.lang.tcl","author":["Brent Welch <[email protected]>","Donal K. Fellows <[email protected]>","Larry W. Virden <[email protected]>","Larry W. Virden <[email protected]>"],"is-jest":false},
	"3":{"url":"./tip/3.md","created":"14-Sep-2000","obsoleted-by":"467","post-history":"","state":"Accepted","vote":"Done","type":"Process","title":"# TIP 3: TIP Format","author":["Andreas Kupries <[email protected]>","Donal K. Fellows <[email protected]>"],"is-jest":false},
	"2":{"url":"./tip/2.md","created":"12-Sep-2000","post-history":"","state":"Draft","vote":"Pending","type":"Process","title":"# TIP 2: TIP Guidelines","author":["Andreas Kupries <[email protected]>","Donal K. Fellows <[email protected]>","Don Porter <[email protected]>","Mo DeJong <[email protected]>","Larry W. Virden <[email protected]>","Kevin Kenny <[email protected]>"],"is-jest":false},
	"1":{"url":"./tip/1.md","created":"14-Sep-2000","obsoleted-by":"386","post-history":"","state":"Withdrawn","vote":"No voting","type":"Informational","title":"# TIP 1: TIP Index","author":["TIP Editor <[email protected]>"],"is-jest":false},
	"0":{"url":"./tip/0.md","created":"11-Dec-2000","post-history":"","state":"Final","vote":"Done","type":"Process","title":"# TIP 0: Tcl Core Team Basic Rules","author":["John Ousterhout <[email protected]>"],"is-jest":false},
	"@min": 0,
	"@max": 549
}, "@timestamp": 1560012667}

</tr>
<tr class='state-draft type-project version-87'>
<td valign='top'><a href='./tip/167.md'>167</a></td>
<td valign='top'>Project</td>
<td valign='top'>8.7</td>
<td valign='top'>Draft</td>
<td valign='top' ><a href='./tip/167.md'>Add a New Option for Context Help for Windows</a></td>
<td valign='top'><a href='/tk/timeline?r=tip-167'>Link</a></td>
</tr>
<tr class='state-final type-project version-87'>
<td valign='top'><a href='./tip/166.md'>166</a></td>
<td valign='top'>Project</td>
<td valign='top'>8.7</td>
<td valign='top'>Final</td>
<td valign='top' ><a href='./tip/166.md'>Reading and Writing the Photo Image Alpha Channel</a></td>

# TIP 167: Add a New Option for Context Help for Windows
	Author:         Ramon Ribó <[email protected]>
	State:          Draft
	Type:           Project
	Vote:           Pending
	Created:        19-Nov-2003
	Post-History:   
	Tcl-Version:    8.7
	Tk-Branch:      tip-167
-----

# Abstract

This TIP proposes adding a new option to **wm attributes** for the
Windows version of Tk that offers contextual help in that window.
Additionally, a new event type `<<Help>>` is defined, that will be
delivered when the user picks the Help button in the window and picks
over a widget.  The event will be also hitted when user presses F1
over one window.

# Rationale

Contextual help is very important in a program to help users to

configured to have this option, a small question mark button is
displayed in the window title bar near the close button. If users pick
that button, a question mark cursor is actived and the user can pick a
widget \(or location in a widget.\)  The typical program reaction to
this is to offer a pop-up window with some short help text or to open
the program help in the relevant section.

Additionally, the new proposed event `<<Help>>` can also get
information when user presses key F1 over one window.

This implementation is proposed for the Windows OS only, though in the
future some Window Managers like KDE \(in Linux\) have the same feature
and could be also implemented.  In any case, this TIP only proposes
implementation on Windows.

# Specification

A new option will be added to **wm attributes** with the following
syntax:

 > **wm attributes** _window_ **-contexthelp** ?_boolean_?

If set and if the window is transient, the question mark button will
appear in the window title bar.

A new virtual event `<<Help>>` is added to the event list so as a user can
do:

	  bind $w <<Help>> {puts "You pressed widget %W"}

This event will hit in two situations: when the user presses the
question mark in the title bar of the window and pick a widget; and
when user presses the F1 key \(or other platform-defined help key\) over
one window \(this latter case only for bindings in the toplevel\).

The event will support the usual `%W`, `%x`, `%y` substitutions and other
values.

# Reference Implementation

[Tk branch `tip-167`](/tk/timeline?r=tip-167)
<http://sf.net/tracker/?func=detail&atid=312997&aid=845248&group_id=12997>

# Comments

It is preferable to use a virtual event `<<Help>>` instead of extending the set of X events.  \(In particular, adding a new `<Help>` event means there has to be a new **HelpMask** bit flag to select for it, and we're running out of event mask bits\).

# Copyright

This document has been placed in the public domain.