Generic FunctionPackage: cgToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.1
Unrevised from 8.0 to 8.1.
8.0 version

help-button

Arguments: basic-pane

Returns whether basic-pane has a "question mark" button in its title-bar for invoking context-sensitive help. If the user clicks this button and then clicks a dialog-item or child window of basic-pane, then the generic function context-sensitive-help is called. An application can add methods to context-sensitive-help to display help on the clicked dialog-item or child window.

Microsoft Windows note: due to operating system design, this button may not be used along with the minimize or maximize buttons (see minimize-button and maximize-button). Those buttons will not appear if specified along with the help-button option.

GTK note: A help button will never appear on a top-level window, because X window managers do not provide such a thing.

This property should be specified by passing a help-button initarg to make-window, since this property cannot be changed on an existing window by calling setf and this generic function. (You may also specify it interactively in the inspector for a form window; the button will not appear on the form itself but will appear on the running window of the form.)


Copyright (c) 1998-2009, Franz Inc. Oakland, CA., USA. All rights reserved.
Documentation for Allegro CL version 8.1. This page was not revised from the 8.0 page.
Created 2009.7.29.

ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.1
Unrevised from 8.0 to 8.1.
8.0 version