1.63.2 Instance variables

frame <-> name: name

Name of the frame. Used by application<-member to find frames in an application. Defaults to object<-class_name.

See also frame<->label.

frame <- label: name

Title shown by the OS in the frame's title bar.

frame <- application: application*

Application this frame belongs to. Combining frames into an application lets the application find them by name and define modal relations between them. See frame->modal.

frame <-> display: display

Display (monitor) hosting the frame. Defaults to @display. Changing it after frame->create is not allowed.

frame <- background: colour|pixmap

Background of the frame's client area.

frame <- area: area

Client-area rectangle (the frame without title-bar and borders) in display coordinates. Reflects the current state regardless of what last updated it.

See also frame->set, frame<-bounding_box and frame->geometry.

See also

- frame->set
- frame<-size

frame-geometry: name*

Pending geometry specification used by frame->create to position the frame. Filled by frame->initialise from the frame.geometry class variable, or by frame->geometry. Class frame itself does not provide a default; subclasses commonly do so end users can override the position in ~/.xpce/Defaults.

See library(persistent_frame) for a frame subclass that persists its geometry and sub-window layout.

For the syntax see frame->geometry.

See also

- frame->create
- frame->geometry

frame <- placed: bool

@on once the OS has positioned the frame. Used internally to distinguish an as-yet-unpositioned frame from one whose position has been chosen.

frame-members: chain

Chain of member windows. Holds plain windows and windows wrapped in a window_decorator. The getter frame<-members returns the chain of undecorated windows.

frame <- kind: {toplevel,transient,popup}

What this frame is from the desktop's point of view:

• toplevel — ordinary application window: title bar, can be minimised and resized through the OS. Default.
• transient — dialog box / inspector window for a parent toplevel. Usually decorated but skipped from the task switcher.
• popup — completely invisible to the OS window manager. Used for tooltips and popup menus. Cannot normally receive keyboard input; use transient if you need text input.

  The kind can only be changed before frame->create.

  See also

  - frame->initialise
  - frame->transient_for
  - frame->show_label

frame <- transient_for: frame*

Frame for which this frame is a transient (e.g. its parent toplevel). Only meaningful when frame<-kind is transient.

See also

- frame<-transients
- frame->transient_for

frame <- transients: chain*

Back-pointer chain holding the frames that are transients of this frame. Maintained by frame->transient_for and frame->unlink. Used to propagate state changes (mapped/exposed/hidden) to the transients.

See also

- frame<-transient_for
- frame->transient_for

frame <- modal: {application,transient}*

A modal frame must be completed before its context can be used again. By default (@nil) the user may operate on any frame. transient blocks just the frame in frame<-transient_for; application blocks every frame in the same frame<-application.

Typical pattern:

display_for(Owner, Result) :-
        new(D, dialog('Enter information')),
        send(D, transient_for, Owner),
        send(D, modal, transient),
        <fill the dialog>
        get(D, confirm_centered,
            Owner?area?center, Return),
        send(D, destroy),
        Return \== @nil.

See also frame<-confirm, frame->transient_for and class application.

frame <- status: {unlinking,unmapped,hidden,iconic,window,full_screen}

Current visibility of the frame:

• unmapped — no OS counterpart yet (the frame exists only as an xpce object).
• hidden — OS counterpart exists but is not visible. Used to stash a frame for later reuse.
• iconic — minimised.
• window (also written open) — fully visible. Reached via frame->open.
• full_screen — maximised across the entire screen. Reach it with send(F, status, full_screen) after frame->create.

  See also frame->open, frame<-confirm and frame->wait. frame->show and frame->closed map to this slot for backward compatibility.

frame <-> can_delete: bool

When @off, the frame refuses an OS close request (e.g. clicking the close button). Defaults to @on.

See also

- frame->wm_delete
- frame->wm_protocol

frame <-> can_resize: bool

When @on (default) the OS allows the user to resize the frame. Set to @off before frame->create to lock the size.

frame <-> confirm_done: bool

When @on, a confirmation dialog pops up before honouring an OS close request (see frame->wm_delete).

Defaults to the value of the confirm_done class variable (off).

See also

- frame->wm_delete
- frame->wm_protocol
- frame<-can_delete

frame <- input_focus: bool

@on while the frame holds keyboard focus in the OS.

On change to @on the frame sends window->input_focus to frame<-keyboard_focus (or to the window under the pointer). On change to @off the window that currently owns input focus is sent window->input_focus.

See also

- frame->keyboard_focus
- frame->input_window

frame <-> sensitive: bool

When @off the frame ignores all user input. Used internally by frame->busy_cursor when block_input is @on.

frame-return_value: unchecked

Holds the value passed to frame->return until frame<-confirm picks it up.

See also

- frame->return
- frame<-confirm

frame <- wm_protocols: sheet

Sheet mapping protocol names to code objects, used by the frame->wm_protocol/frame->done_message/frame->save_message family of OS close/save handlers.

See also

- frame->wm_protocol
- frame->delete_wm_protocol