$root.$iwindows.WINDOW

Parent: $root.$iwindows

Class notation

Properties

Object specific
$backgroundskin Icon ID of skin used for background
$backgroundskinalign Alignment of background skin picture kPALbottomCenter kPALbottomLeft kPALbottomRight kPALcenter kPALcenterLeft kPALcenterRight kPALtilekPALtopCenter kPALtopLeft kPALtopRight
$bringinfront If true, the window opens in front of palette style windows
$clickbehind If true, the window allows clicks to bring other windows to the front
$closebox If true, the window has a close box or system menu
$controlmethod The control method
$dockingedge The border style of the edge of the window docking area
kBorderChisel kBorderEmbossed kBorderNone kBorderPlain
$enablemenuandtoolbars If true, all main toolbars and menus are enabled when this window is on top
$enterable If true, the window instance is in enterable mode
$growbox If true, the window has a grow box or grow border
$hasmenus If true, the window has a menu bar
$hasstatusbar If true, the window has a status bar
$helpbutton If true, the window has a help button in the title bar. Applies to Windows 32 bit platforms only
$isdrawer If true, the window for this instance is a drawer (MacOS only)
$issheet If true, the window for this instance is a sheet (MacOS only)
$keepclicks If true, the window receives clicks which cause it to be brought to the front
$maximized If true, the window has been maximized
$menuedge The border style of the edge of the menu
kBorderChisel kBorderEmbossed kBorderNone kBorderPlain
$minimizebox If true, the window has a minimize box
$minimized If true, the window has been minimized
$minimizeiconid The id of the icon used when the window is minimized; on some platforms, this icon is also displayed in the window title bar
$modelessdata If true, the window is always in enter data mode
$norefresh If true, screen updates to the window instance are disabled; the window instance will not draw until you set $norefresh to kFalse. Use this property to improve performance, for example when setting complex grid exceptions
$showcommands If true, the window causes the commands menu to be installed
$showtitle If true, the window displays a title
$startfield The ident or order number of the initial enterable field of the window
$statusbarpos A kSBPos... constant, which specifies the position of the window status bar when $hasstatusbar is kTrue
kSBPosBottom kSBPosPlatformDefault kSBPosTop
$statusedge The border style of the edge of the status bar
kBorderChisel kBorderEmbossed kBorderNone kBorderPlain
$style The window style kDialog kNoframe kPalette kSimple kTitle
$title The window title
$toolbarnames The names of the toolbar classes used in the window docking area
$toolbaroptions Set of toolbar options (e.g. kTBOptionShowText). Note that you can only assign this property when $toolbarpos is not kDockingAreaNone. Also note that kTBOptionOSXOmnisTopToolbar can only be toggled when designing a window
$toolbarpos The position of the toolbar in the window; this can be any of the kDockingArea... constants except kDockingAreaFloating
kDockingAreaBottom kDockingAreaLeft kDockingAreaNone kDockingAreaRight kDockingAreaTop
$toplevelhwnd The window identifier of the outer-most hwnd of the window instance. The properties of $toplevelhwnd are assignable. Set a reference to object.$toplevelhwnd.$ref, to access its properties
$usesheets If true, standard OK messages, file dialogs and working messages are opened as sheets on MacOS
$zoombox If true, the window has a zoom box or maximize box
Standard $alpha $backcolor $backgroundtheme $backpattern $classdata $classtype $contextmenu $dropmode $edgefloat $forecolor$framehwnd $height $helpfile $horzscroll $hscroll $hwnd $isprivate $left $name $top $vertscroll $visible $vscroll $width

Methods

Object specific
$bringtofront $bringtofront([bRestoreIfMaximized=kFalse]) Bring the window instance to the front. If bRestoreIfMaximized is kTrue, also restore the window to its previous size and position if it is currently maximized
$maximize $maximize() Maximize the window instance
$minimize $minimize() Minimize the window instance
Standard $canclose $close $redraw

Events

Object specific
evCancel

Sent to a window when an Cancel button or key is pressed
Parameters

pEventCode The event code
evClose

Sent to a window when it is about to be closed
Parameters

pEventCode The event code
evCloseBox

Sent to a window when its close box is clicked
Parameters

pEventCode The event code
evCustomMenu

Sent to the top window when a line on a custom menu is selected
Parameters

pEventCode The event code
pMenuLine A reference to the menu line which was selected
evMaximized

Sent to a window when it has been maximized
Parameters

pEventCode The event code
evMinimized

Sent to a window when it has been minimized
Parameters

pEventCode The event code
evMoved

Sent to a window when it has been moved
Parameters

pEventCode The event code
evOK

Sent to a window when an OK button or key is pressed
Parameters

pEventCode The event code
evResized

Sent to a window when it has been resized
Parameters

pEventCode The event code
evRestored

Sent to a window when it has been restored to its normal size
Parameters

pEventCode The event code
evStandardMenu

Sent to the top window when a line on a standard Omnis menu is selected
Parameters

pEventCode The event code
pCommandNumber The Omnis command number selected from a built-in menu
evToolbarButton

Sent to a window when its toolbar button is clicked (MacOSX only)
Parameters

pEventCode The event code
evToTop

Sent to a window when it becomes the top window
Parameters

pEventCode The event code
evWindowClick

Sent to the top window when another window is clicked
Parameters

pEventCode The event code
pClickedWindow A reference to the field or window which was clicked
pStayingBehind If true,the window receiving the click will not come to the front as a result of the click (can only be true on MacOSX)
Standard evCanDrop evClick evDoubleClick evDrop evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUpevOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp

Children

$bobjs $ivars $menus $methods
$objs $statusbar $toolbars $tvars