| Allegro CL version 8.2 Unrevised from 8.1 to 8.2. 8.1 version |
Arguments: stream &optional (stream-units-p t)
Returns the page-width attribute of the
stream argument. stream
should be a cg-stream
. The value may be set at
creation time by passing the page-width initarg,
or any time later by calling (setf page-width) or set-page-size.
If stream-units-p is true, the value is in stream units, otherwise it is in space-widths (the width of the space character in the default font). See cg-coordinates.htm.
The value is always an integer, rounded if necessary when
stream-units-p is nil
. page-width is the width of what
might be called the canvas of the window, only a portion of which may
be visible. If you add horizontal scrollbars to a window whose page-width is greater
than its interior-width, the range of the
scrollbars is the page-width and you can scroll the
visible portion of the window left and right over that page-width.
The function page-width always returns a number,
which is either the value returned by explicit-page-width if it returns a
number, or else the number returned by default-page-width. The function
(setf page-width) may be passed either an explicit page-width number
or else nil
to make page-width default
according to the default-page-width method for the
window.
Note that the page-width property uses explicit-page-width as
its reader function. This means that a page-width property in the IDE's
inspector will be nil
unless a page-width has
been explicitly assigned. The writer function is still (setf
page-width), and so a page-width property may be changed
in the inspector either to an explicit number or to nil
.
If stream is an instance of a drawable
control, this
function returns (or sets with setf) the width of the entire
"canvas" that may be scrolled onto the drawable. Typically used only
when the horizontal scrollbar is enabled.
See also page-height and set-page-size.
Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.
| Allegro CL version 8.2 Unrevised from 8.1 to 8.2. 8.1 version |