Arguments: windows-graphics &optional (stream-units-p t)
Returns the page-height attribute of its first argument. If stream-units-p is true the value is in stream units, otherwise it is in line-heights. See About coordinate systems in Common Graphics in cgide.htm.
The value is always an integer, rounded if necessary when
stream-units-p is nil. Page-height is the
height of what might be called the canvas of the window, only a
portion of which may be visible. If you add vertical scrollbars to a
window whose page-height is greater than its interior-height, the
range of the scrollbars is the page-height and you can scroll the
visible portion of the window up and down over that page height.
The function page-height always returns a number, which is either the
value returned by explicit-page-height if it
returns a number, or else the number returned by
default-page-height. The function (setf
page-height) may be passed either an explicit page-height number or
else nil to make page-height default
according to the default-page-height method for the
window.
Note that the page-height property uses
explicit-page-height as its reader function. This
means that a page-height property in the IDE's inspector will be
nil unless a page-height has been explicitly
assigned. The writer function is still (setf page-height), and so a
page-height property may be changed in the inspector either to an
explicit number or to nil.
If windows-graphics is an instance of the drawable control, this function returns (or sets with setf) the height of the entire "canvas" that may be scrolled onto the drawable. Typically used only when the vertical scrollbar is enabled.
Note: incompatible change in release 6.0: in releases prior
to 6.0, when a frame-with-single-child instance
was passed to this operator, the operator was actually applied to the
child (the result of applying frame-child to the
frame-with-single-child instance). In release 6.0, this redirection no
longer occurs. If you intend this operator to apply to the
frame-child, pass that to this operator rather than the parent. This
is a non-backward-compatible-change. See the release notes for more
information.
Common Graphics and IDE documentation is described in About Common Graphics and IDE documentation in cgide.htm.
The documentation is described in introduction.htm and the index is in index.htm.
Copyright (c) 1998-2000, Franz Inc. Berkeley, CA., USA. All rights reserved.
Created 2000.10.5.