Arguments: windows-graphics &optional (stream-units-p t)
Returns the page-width attribute of the first argument. 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 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-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 windows-graphics 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.
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.