ARM Club 1/ARM_CLUB_CD.iso/contents/apps/program/d/eventshell/Docs/Windows

Text File | 1993-11-14 | 11.0 KB | 475 lines

FNshell_WindowSetSpriteArea()
Params =>
         int window handle
         int address of sprite area

       <=
         int window handle

--------------------------------------------------------

PROCshell_OpenWindow()
Params =>
         int window handle
         int full flag
         int front flag

Any panes attached to the window with
PROCshell_AttachPane will be opened
automatically.

--------------------------------------------------------

PROCshell_CloseWindow()
Params =>
         int window handle

Any panes attached to the window with
PROCshell_AttachPane will be closed
automatically.

--------------------------------------------------------

FNshell_MessageWindow()
Params =>
         str message text
         int cancel flag
         str program name
         str header

       <=
         int result

This routine is useful for OK to quit type
windows. The returned result is 1 if OK
was clicked, 2 if Cancel was selected.

Cancel Flag
FALSE = don't display a CANCEL icon
TRUE  = message window has a CANCEL icon

Program Name
Displayed in the title bar of the
message window

Header
When null then the title bar will read
"Message from AppName". When non-null
the header is displayed instead

--------------------------------------------------------

PROCshell_WindowMoveTo()
Params =>
         int window handle to move
         int x coord to move to
         int y coord to move to

See also PROCshell_WindowMoveToIcon.

--------------------------------------------------------

PROCshell_WindowMoveToIcon()
Params =>
         int window handle to move
         int window handle containing icon
         int icon handle
         int x offset of moved window from icon
         int y offset of moved window from icon

A problem can occur with this call if RISC OS
2 is in use. As it does not seem possible to
discover the scroll offsets of the iconbar the
window may nove to the wrong position. Any
suggestions would be gratefully received...

See also PROCshell_WindowMoveTo.

--------------------------------------------------------

PROCshell_WindowCentreOnPointer()
Params =>
         int window handle to move

This routine attempts to centre the
window on the current pointer position.
It may fail to do so if the pointer is
too close to the edge of the desktop
and windows are not allowed to move
outside the desktop.

This routine is useful in the 'PreOpen'
function of a static dialog box. Dynamic
dialog boxes are automatically centred
on the pointer.

See also PROCshell_WindowMoveTo.

--------------------------------------------------------

PROCshell_CreateWindow()
Params =>
         str window identifier
         int (ignored on entry)

       <=
         int window handle of newly created window

--------------------------------------------------------

PROCshell_OpenWindowStatic()
Params =>
         int window handle

The window will be brought to the top
of the stack by this call. The window
must have been created with a call to
PROCshell_CreateWindowStatic - an error
will be generated if this is not the
case.

Any panes attached to the window with
PROCshell_AttachPane will be opened
automatically.

--------------------------------------------------------

PROCshell_CreateWindowStatic()
Params =>
         str window identifier
         int (ignored on entry)

       <=
         int window handle of newly created window

--------------------------------------------------------

PROCshell_WindowRetitle()
Params =>
         int window handle (may be altered,
             new value returned)
         str new title

The window handle may be changed by this
routine, be sure to use the value returned
when referring to the window in the future.

It is not necessary to make the window title
indirected, but titles longer than 11 characters
will be truncated without warning if it is not.

Attempting to use a title which is longer than
the allocated buffer will again cause truncation.

--------------------------------------------------------

PROCshell_WindowResize()
Params =>
         int  window handle
         int  min x coord of workarea
         int  min y coord of workarea
         int  max x coord of workarea
         int  max y coord of workarea
         bool open flag

--------------------------------------------------------

PROCshell_WindowBringToTop()
Params =>
         int window handle to bring to top

This routine causes a wimp message to be sent to
bring a window to the top. You cannot use this
routine on windows owned by your own task, but
you can use PROCshell_OpenWindow in this case.

It may take several wimp poll events before the
window is opened, however, so you cannot assume
it is actually open immediately after this call.

You can use FNshell_WindowIsOnTop to check the
status of the window after this call.

--------------------------------------------------------

FNshell_WindowIsOnTop()
Params =>
         int  window handle

       <=
         bool TRUE if window is on top, otherwise
              FALSE

This function can be used to discover if the given
window is on top of the stack (i.e. completely
uncovered). It is especially useful after a call
to PROCshell_WindowBringToTop as it may take
several calls to Wimp_Poll before the window is
brought to the top. The window may belong to another
task.

--------------------------------------------------------

FNshell_WindowHasTitleBar()
Params =>
         int  window handle

       <=
         bool TRUE if window has a title bar, otherwise
              FALSE

--------------------------------------------------------

FNshell_WindowGetTitle()
Params =>
         int window handle

       <=
         str window title (null if no title)

--------------------------------------------------------

FNshell_WindowTitleBufferLength()
Params =>
         int window handle

       <=
         int buffer length (12 if title is not
             indirected)

--------------------------------------------------------

FNshell_WindowIsMoveable()
Params =>
         int  window handle

       <=
         bool TRUE if window is moveable, otherwise
              FALSE

--------------------------------------------------------

FNshell_WindowIsAPane()
Params =>
         int  window handle

       <=
         bool TRUE if window is a pane, otherwise
              FALSE

--------------------------------------------------------

FNshell_WindowIsNotBounded()
Params =>
         int  window handle

       <=
         bool TRUE if window may move outside
              the screen area, otherwise FALSE

--------------------------------------------------------

FNshell_WindowTrapsHotKeys()
Params =>
         int  window handle

       <=
         bool TRUE if window traps hot keys,
              otherwise FALSE

--------------------------------------------------------

FNshell_WindowHasBeenToggled()
Params =>
         int  window handle

       <=
         bool TRUE if window has been toggled to
              full size, otherwise FALSE

--------------------------------------------------------

FNshell_WindowHasInputFocus()
Params =>
         int  window handle

       <=
         bool TRUE if window has the input focus,
              otherwise FALSE

--------------------------------------------------------

FNshell_WindowHasBackIcon()
Params =>
         int  window handle

       <=
         bool TRUE if window has a send to back icon,
              otherwise FALSE

--------------------------------------------------------

FNshell_WindowHasCloseIcon()
Params =>
         int  window handle

       <=
         bool TRUE if window has a close icon,
              otherwise FALSE

--------------------------------------------------------

FNshell_WindowHasToggleIcon()
Params =>
         int  window handle

       <=
         bool TRUE if window has a toggle icon,
              otherwise FALSE

--------------------------------------------------------

FNshell_WindowHasVScrollBar()
Params =>
         int  window handle

       <=
         bool TRUE if window has a vertical scroll bar,
              otherwise FALSE

--------------------------------------------------------

FNshell_WindowHasHScrollBar()
Params =>
         int  window handle

       <=
         bool TRUE if window has a horizontal scroll bar,
              otherwise FALSE

--------------------------------------------------------

FNshell_WindowHasAdjustSizeIcon()
Params =>
         int  window handle

       <=
         bool TRUE if window has an adjust size icon,
              otherwise FALSE

--------------------------------------------------------

FNshell_WindowIsOpen()
Params =>
         int  window handle

       <=
         bool TRUE if window is open, otherwise
              FALSE

--------------------------------------------------------

PROCshell_WindowToggleBackIcon()
Params =>
         int  window handle

       <=
         int updated window handle

Adds a 'Back icon' to a window if it doesn't
have one, removes it if it does. Also redisplays
window in its new state if it is open.

--------------------------------------------------------

PROCshell_WindowToggleCloseIcon()
Params =>
         int  window handle

       <=
         int updated window handle

Adds a 'Close icon' to a window if it doesn't
have one, removes it if it does. Also redisplays
window in its new state if it is open.

--------------------------------------------------------

PROCshell_WindowToggleTitleBar()
Params =>
         int  window handle

       \<=
         int updated window handle

Adds a Title bar to a window if it doesn't one,
removes it if it does. Also redisplays window
in its new state if it is open.

--------------------------------------------------------

PROCshell_WindowToggleToggleIcon()
Params =>
         int  window handle

       <=
         int updated window handle

Adds a 'Toggle size icon'  to a window if it
doesn't one, removes it if it does. Also
redisplays window in its new state if it is
open.

--------------------------------------------------------

PROCshell_WindowToggleVScrollBar()
Params =>
         int  window handle

       <=
         int updated window handle

Adds a vertical scroll bar to a window if
it doesn't one, removes it if it does. Also
redisplays window in its new state if it is
open.

--------------------------------------------------------

PROCshell_WindowToggleAdjustSizeicon()
Params =>
         int  window handle

       <=
         int updated window handle

Adds a 'Adjust size icon' to a window if it
doesn't one, removes it if it does. Also
redisplays window in its new state if it is
open.

--------------------------------------------------------

PROCshell_WindowToggleHScrollBar()
Params =>
         int  window handle

       <=
         int updated window handle

Adds a horizontal scroll bar to a window if
it doesn't one, removes it if it does. Also
redisplays window in its new state if it is
open.

--------------------------------------------------------

FNshell_WindowLoaded()
Params =>
         str  window name (max 11 characters)

       <=
         bool TRUE if template is loaded, otherwise
              FALSE

--------------------------------------------------------