page-height

Arguments: stream &optional (stream-units-p t)

Returns the page-height attribute of stream. stream should be a cg-stream. The value may be set at creation time by passing the page-height initarg, or any time later by calling (setf page-height) or set-page-size.

If stream-units-p is true the value is in stream units; otherwise it is in line-heights. See cg-coordinates.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 stream 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.

See also page-width and set-page-size.

Copyright (c) 1998-2019, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 9.0 page.
Created 2015.5.21.