All Manuals > Common Lisp Interface Manager 2.0 User's Guide > Chapter 9 Defining Application Frames > 9.9 Frame Managers

NextPrevUpTopContentsIndex

9.9.2 Frame Manager Operators

frame-manager [Generic Function]

Arguments: frame

Summary: Returns frame 's current frame manager if it is adopted; otherwise, it returns nil .

(setf frame-manager) [Generic Function]

Arguments: frame-manager frame

Summary: Changes the frame manager of frame to frame-manager . In effect, the frame is disowned from its old frame manager and is adopted into the new frame manager. Transferring a frame preserves its frame-state ; for example, if the frame was previously enabled, it will be enabled in the new frame manager.

frame-manager-frames [Generic Function]

Arguments: frame-manager

Summary: Returns a list of all the frames being managed by frame-manager . This function returns objects that reveal CLIM's internal state; do not modify those objects.

adopt-frame [Generic Function]

Arguments: frame-manager frame

disown-frame [Generic Function]

Arguments: frame-manager frame

Summary: These functions insert or remove a frame from a frame manager's control. These functions allow a frame manager to allocate and deallocate resources associated with a frame. For example, removing a frame from a frame manager that is talking to a remote server allows it to release all remote resources used by the frame.

frame-state [Generic Function]

Arguments: frame

Summary: Returns one of :disowned , :enabled , :disabled , or :shrunk , indicating the current state of frame .

enable-frame [Generic Function]

Arguments: frame

disable-frame [Generic Function]

Arguments: frame

shrink-frame [Generic Function]

Arguments: frame

Summary: These functions force a frame into the enabled, disabled, or shrunken states. A frame in the enabled state may be visible if it is not occluded or placed out of the user's focus of attention. A disabled frame is never visible. A shrunk frame is accessible to the user for re-enabling, but may be represented in some abbreviated form, such as an icon or a menu item.

These functions call note-frame-state-changed to notify the frame manager that the state of the frame changed.

note-frame-state-changed [Generic Function]

Arguments: frame-manager frame new-state

Summary: Notifies the frame manager frame-manager that the frame frame has changed its state to state .

generate-panes [Generic Function]

Arguments: frame-manager frame

Summary: This function is invoked by a standard method of adopt-frame . It is the responsibility of the frame implementor to provide a method that invokes setf on frame-panes on the frame with a value of type pane . define-application-frame automatically supplies a generate-panes method if either the :pane or :panes option is used in the define-application-frame .

find-pane-for-frame [Generic Function]

Arguments: frame-manager frame

Summary: This function is invoked by a standard method of adopt-frame . It must return the root pane of the frame's layout. It is the responsibility of the frame implementor to provide a method that constructs the frame's top-level pane. define-application-frame automatically supplies a a method for this function if either the :pane or :panes option is used.

note-command-enabled [Generic Function]

Arguments: frame-manager frame command-name

note-command-disabled [Generic Function]

Arguments: frame-manager frame command-name

Summary: Notifies the frame manager frame-manager that the command named by command-name has been enabled or disabled (respectively) in the frame frame . The frame manager can update the appearance of the user interface as appropriate, for instance, by "graying out" a newly disabled command from a command menu or menu bar.


Common Lisp Interface Manager 2.0 User's Guide - 7 Aug 2017

NextPrevUpTopContentsIndex