Generic Function | Package: cg | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 10.1 Unrevised from 10.0 to 10.1. 10.0 version

## help-button-pressed

Arguments: window

This generic function is called whenever the user left-clicks the "question-mark button" on the frame of a `frame-window` that has the help-button property. window is the frame-window that has the help-button that was clicked. Applications may override the default method in order to tell the user what to do next in some custom way.

The behavior of the help-button is hard-wired to wait for the user to left-click a control or child window in that window, and to then call context-sensitive-help with that control or child window (unless the user cancels by pressing the ESCAPE key or clicking elsewhere). help-button-pressed is therefore useful only for telling the user to click on a control or child window in that window for some reason.

The default method calls window-message on window with the string "Left-click a control in the same window for help on that control." Due to the general functionality of window-message, this string will appear in the window's `status-bar` or `common-status-bar` if the window has one, or else will appear in an ancestor window's `status-bar` or `common-status-bar`, if any.

Copyright (c) 1998-2022, Franz Inc. Lafayette, CA., USA. All rights reserved.
This page was not revised from the 10.0 page.
Created 2019.8.20.

|  | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 10.1 Unrevised from 10.0 to 10.1. 10.0 version