Structure: window

Object Description:

A window identifier

Creation Command:

see below

    Alpha window

walpha command

    Component window

wcomponent command

    Display window

wdisplay command

    Graphic window

wgraphic command

    Panel window

wpanel command

    Tab (Property) window

wtab command

    Table window

wtable command

    Tree window

wtree , treenode commands

    Web window

wweb command

Permitted Scope:

global, application or local

Array Capability:

Yes

Membership Potential:

compound, gstructure, structure, custom

Graphic Primitive Capability:

No

User Function Capability:

Yes, window_function

 

Generic Elements

.access

-

string

Access rights

.alength

*

numeric

Array length

.class

*

string

Identifier class (window)

.desc

-

string

Description

.elements

*

string [160]

Structure element names

.etypes

*

string [160]

Structure element types

.is_class

*

numeric func

Whether identifier is an instance of a particular class

.is_proc

*

numeric

Whether identifier is a procedure/function

.num_elements

*

numeric

Structure element count (160)

.owner

*

string

Owner user-id

.time

-

time

Modification time

.type

*

string

Identifier type (window)

.variant

*

string

Identifier variant (identifier)

* = Read only element

 

Generic Window Elements

.atable

*

atable

Atable to be used during window callbacks

.background

-

color

Display area background color

.buttons

-

callback[16]

Procedure to execute on user button hits

.button_labels

-

string[16]

Procedure to execute on user button hits

.canvas

*

numeric

X-windows handle for external use

.child

*

window[ ]

Sub-windows

.child_count

*

numeric

Sub-window count

.color

-

color

Window widget color

.cursor

-

cursor

Graphic input cursor to use within window

.customize

*

procedure

Extend the window structure

.deiconify

-

callback

Procedure to execute on window open

.delete

-

callback

Procedure to execute on window delete

.drop_files

-

callback

Statements to execute on file drag and drop

.embedded

-

string

Name of an embed container housing the window

.flash

*

numeric func

Flash the window

.ghosted

-

numeric

Window sensitivity

.help

-

callback

Procedure to execute on help (button 1)

.icon

-

string

File name of icon cameo (or null)

.iconify

-

callback

Procedure to execute on window iconize

.icon_name

-

string

Title for window icon

.icon_rect

-

numeric[4]

Screen position of window icon

.id

*

numeric

Window number

.inrect

-

numeric[4]

Screen position of window inner contents

.menubar

*

menupane

Menubar menupane

.move

-

callback

Command procedure executed when window changes position.

.open

-

numeric

Whether window is currently in use

.other_color

-

color

Window secondary color

.outrect

-

numeric[4]

Screen position of window frame

.parent

-

window

Parent window

.resizable

-

numeric

Whether window can be resized

.resize

-

callback

Procedure to execute on window resize

.scroll

-

callback

Procedure to execute when window scrolls

.scrollbars

*

numeric

Whether window has scrollbars

.shell_name

-

string

Window X resource name

.style

*

string

Window type

.title

-

string

Window title

.title_numbered

-

numeric

Whether the title includes window number

.visibility

-

numeric

Window visibility

.z_order

-

numeric

Window stacking priority

* = Read-only element

 

Alpha Window Elements

.bottom_row

-

numeric

Index of the bottom row in view

.columns

-

numeric

Current window width in characters

.file

-

string

Text file currently shown in window (or null)

.font

-

font

Font (system) for printable characters

.left_column

-

numeric

Index of the left most column in view

.lines

-

string[ ]

Contents of the text lines

.line_colors

-

color[ ]

Color of the text lines

.max_columns

*

numeric

Width of the longest text line

.num_lines

*

numeric

Number of text lines

.right_column

-

numeric

Index of the right most column in view

.rows

-

numeric

Current window height in rows

.tabs

-

numeric[ ]

Tab stops for output

.text_color

-

color

Default color for text

.top_row

-

numeric

Index of the top row in view

* = Read-only element

 

Component Window Elements

.component

*

component

External object

* = Read-only element

 

Display Window Elements

.angle

-

numeric

Image rotation angle

.clip

-

numeric[4]

Image clip rectangle

.down

-

callback

Procedure to execute on mouse press in the window

.drag

-

callback

Procedure to execute on mouse movement in the window

.exec

-

callback

Procedure to execute on a mouse hit in window contents

.exec_button

-

numeric

Button which invokes the window.exec pulldown menu

.file

-

string

Raster file currently on view

.popup

*

menupane

window.exec popup menupane

.resolution

-

numeric

Screen to file pixel resolution

.track

-

callback

Mouse tracking echo function

.up

-

callback

Procedure to execute on mouse release in the window

* = Read-only element

 

Graphic Window Elements

.annotate

*

procedure

Manually add autotext annotation (text labels to) graphic primitives

.annotation_layer

*

layer

Autotext annotation layer

.anti_aliasing

-

numeric

State of vector anti-aliasing

.auto_box

-

numeric

State of the auto-box

.auto_grid

-

numeric

State of the auto-grid

.auto_scalebar

-

numeric

State of the auto-scalebar

.auto_vane

-

numeric

State of the auto-vane

.axes

*

point[3]

Local modeling axes

.background

-

fillstyle

Canvas area background fill

.background_layer

*

layer

Background layer

.bleed

-

numeric

Instance bleed factor for clipping

.border

*

numeric

Border thickness

.box

-

point[2]

Orthogonal box

.browsing

-

numeric

State of entity browsing

.cloth

-

string

Cloth file for raster overlays

.cloth_layers

*

layers[]

Graphic backcloth layers

.cloth_level

-

numeric

Current cloth level on display

.cloth_mag

-

numeric

Current cloth magnification

.cloth_outline

-

numeric

Whether backcloth raster images are drawn in outline only

.corners

-

point[2]

Points corresponding to the window corners (work area)

.depth_clipping

-

numeric

Whether Z clipping is necessary during entity rendring

.display_group

*

group

All viewable primitives

.double_buffering

-

numeric

Whether double buffering is enabled

.down

-

callback

Statements to execute on a mouse press in the window

.drag

-

callback

Statements to execute on mouse movement in the window

.dynamic_rank

-

numeric

Dynamic window rank capability

.ebrowsed

-

epointer

The current entity during entity browsing.

.exec

-

callback

Statements to execute on a mouse hit in the window

.exec_button

-

numeric

Button which invokes the exec pulldown menu

.eye

*

point

Eye position

.focus

*

point

Focus position

.fragments

-

numeric

Fragment visibility status

.full_erase

-

numeric

Erase mode

.gc_display

-

numeric

Display of graphic control

.greek

-

numeric[3]

Text greeking pixel limits

.grid

*

grid

Grid characteristics

.grid_layer

*

layer

Grid layer

.groups

*

group[ ]

Window display groups

.groups_ex

*

group[ ]

Window exclusion groups

.group_order

-

group[ ]

Group display order

.layers

-

layers[]

Graphic layers

.lens

*

numeric

Perspective lens angle

.lug_display

-

numeric

Display of entity lugs

.mpp

-

numeric

Ratio of world meters per pixel

.overlay

-

group

Overlay group

.pick_filter

-

filter

Filter used during picking

.pick_group

-

group

Selection group (dynamic) use during picking

.pick_tolerance

-

numeric

Screen tolerance during picking

.pixel_factor

-

numeric

Ratio of current world units per pixel

.plot_scale

-

numeric

Scale for plot output (via dump command)

.populate

-

callback

Statements to execute to populate window groups during redraws

.popup

*

menupane

window.exec popup menpane

.post_redraw

-

callback

Procedure to execute after window has been redrawn

.post_vector_layer

*

layer

Post-vector graphic layer

.pre_redraw

-

callback

Procedure to execute before window is redrawn

.pre_vector_layer

*

layer

Pre-vector graphic layer

.rank

-

numeric

Window rank

.redraw

-

callback

Procedure to execute during window redraw

.reset

*

numeric func

Redraw the window in "reset" mode

.save_under

-

numeric

Whether a save-under is active [1 or 0]

.scale

-

numeric

True scale for window contents

.scalebar_layer

*

layer

Scalebar layer

.text_angles

-

numeric[2]

Angle range for glabel text display

.tol_base

-

point

Window tolerance base point

.tols

-

numeric[3]

Window select tolerances

.track

-

callback

Statements to execute on mouse movement in the window when no mouse button is down

.up

-

callback

Procedure to execute on mouse release in the window

.vane_color

-

color

Vane color (or null)

.vane_font

-

font

Vane character

.vane_layer

*

layer

Vane layer

.vector_layer

*

layer func

Layer associated with a group

.vector_layers

-

layers[]

Graphic vector layers

.view

*

numeric

Index of the current view

.view_corners

-

point[2]

Visible window corners (in 3-D space)

.wheel

-

callback

Statements to execute on a mouse wheel event in the window

.work_area

-

numeric[2]

Virtual work area as a factor of the visible window.

* = Read-only element

 

Panel or Tab Window Elements

.changed

-

numeric

Whether panel values have changed

.design

*

numeric

Whether the window is in design mode

.deswin

*

window

Design window

.panels

*

panel

Sub-panels

.panel_count

*

numeric

Sub-panel count

.reset

*

numeric func

Perform a window "reset"

.select

-

callback

Statements to execute on interactive sub-window selection (Tab windows only)

.selected

-

numeric

Index of currently selected tab (Tab windows only).

.tab_buttons

*

panel[ ]

Tab button sub-panels (Tab windows only)

.traversal

-

string[ ]

Panel keyboard traversal order

.undo

*

numeric func

Perform a window "undo"

* = Read-only element

 

Table Window Elements

.bottom_row

-

numeric

Index of the bottom row in view

.column_data

-

string [ ] [ ]

Table column text values

.columns

-

numeric

Table width (in panels)

.current

-

numeric[ ]

Currently selected rows/columns

.panels

*

panel

Sub-panels in one row

.panel_count

*

numeric func

Sub-panel count

.row_data

-

string[ ] [ ]

Table row text values

.rows

-

numeric func

Table height (in panels)

.select

-

callback

Procedure to execute on row/column selection and de-selection

.selected

-

numeric[ ]

Row/column selection status

.top_row

-

numeric

Index of the top row in view

* = Read-only element

 

Tree Window Elements

.add_node

-

treenode fn

Add a top-level node

.context_node

*

treenode

Node currently under the mouse on detection of a right mouse click in the window.

.exec

-

callback

Pulldown procedure to execute on a right mouse click in the window

.nodes

*

treenode[ ]

Top level nodes

.node_count

*

numeric

Top level node count

.popup

*

menupane

Exec callback menupane

.reset

*

numeric func

Remove all nodes

.selected_node

*

treenode

Currently selected node

.track

-

callback

Statements to execute when the mouse passes over a treenode.

* = Read-only element

 

Web Window Elements

.busy

*

numeric

Busy state of the window

.go_back

*

numeric func

Revisit the previous page

.go_forward

*

numeric func

Revisit the next page

.go_home

*

numeric func

Revisit the home page

.history

*

string[ ]

List of visited pages

.history_titles

*

string[ ]

List of visited page titles

.post_navigate

-

callback

Statements to execute after visiting a new page

.pre_navigate

-

callback

Statements to execute before visiting a new page

.quiet

-

numeric

Whether to display web pages in quiet mode (suppressing error dialogs)

.refresh

*

numeric func

Revisit the current page

.stop

*

numeric func

Cancel loading the current page

.url

-

string

URL of the current page

.url_title

-

string

Title of the current page

* = Read-only element