Generic Function

Summary

Returns a value which indicates how the top level interface is displayed.

Package

capi

Signature

top-level-interface-display-state interface

Arguments

interface

A top level interface or dialog window

Description

Top level interfaces and dialogs can be manipulated by the user, such as being iconifed or maximized. The program can manipulate these windows too. The function top-level-interface-display-state returns a value that indicates the current state of the interface interface . The following values can be returned:

:normal

The window is visible and has its normal size.

:maximized

The window is visible and has been maximized.

:iconic

The window is visible as an icon.

:hidden

The window is not visible.

These values can also be passed as the :display-state initarg when making a top level interface.

In addition, the function (setf top-level-interface-display-state) can be used to change the state of a top level interface. The value can be set to one of the above, or to :restore if the current state is :iconic or :hidden . When set to :restore , the state will become :normal or :maximized depending on how the interface was visible in the past.

See also

top-level-interface-p
top-level-interface-geometry
set-top-level-interface-geometry
interface