CLEARWIN_STRING@

Platform

Win32, x64

Purpose

To obtain an information string from ClearWin+.

Syntax

CHARACTER(*) FUNCTION CLEARWIN_STRING@( STR )
CHARACTER(*) STR

Description

When in a ClearWin+ call-back this function is used to determine extra information about the nature of the call-back. For example passing STR = 'CALLBACK_REASON' will reveal more about why the call-back was called.

The following values for STR are valid:

 

CHECKING_DIRECTORY, FILE_FOUND and FIND_FILE_CALLBACK_REASON
Set in the callback provided to FIND_FILE@.

CURRENT_TEXT_ITEM, CURRENT_TEXT_DOCUMENT and CURRENT_TEXT_TITLE
Information about a document being browsed to within a %ht (Hypertext). 'CURRENT_TEXT_ITEM' is the new URL, 'CURRENT_TEXT_DOCUMENT' is the source document and 'CURRENT_TEXT_TITLE' is the title of the current page. See Hypertext windows.

CURRENT_MENU_ITEM
This option will return a string containing the current menu item selected. It is employed when using dynamic menus that have a shared call-back (see Dynamic menus).

CURRENT_URL
Is the URL being navigated to when the callback reason is HYPERTEXT_LINK

DROPPED_FILE
Is a string containing the full path and filename of the object dropped into a format window using %dr (OnDragDrop Callback).

ERROR_REPORT< br/> Contains the current error message if a native graph plotting routine returns an error code. See Native graph plotting.

EDITED_TEXT
When a %lv (List View), %tv (Tree Control) or %bv (Branch View) item is edited, this contains the new item text.

MESSAGE_TEXT
Contains the text sent via SEND_TEXT_MESSAGE@.

PRINTER_DOCUMENT
Contains the title of the printed document. This can be set via SET_CLEARWIN_STRING@ prior to calling routines such as PRINT_GRAPHICS_PAGE@, OPEN_PRINTER@ etc.

CALLBACK_REASON
Whenever a call-back function is invoked, this string can be used to determine the reason for the call. The following list of reasons (upper case letters only) may be extended in the future, so programs should be designed to ignore reasons which they do not recognise.

 

Reason

Comments

 

'ACCELERATOR'

Call associated with %ac (Accelerator Key).

 

'BEGIN_DRAG'

An item in a %lv (List View) or %bv (Branch View) is being dragged.

 

'BEGIN_EDIT'

A label is about to be edited in a %lv (List View) or %bv (Branch View).

 

'BUTTON_PRESS'

A button has been pressed.

 

'CHECKBOX_CHANGE'

A checkbox in a %lv (List View) has changed state.

 

'CLOSEUP'

The droplist in a %el (Editable Combo Box) has been closed.

 

'COLOURING'

User_colour event for edit box (%eb (Edit Box)).

 

'DATA_ALTERATION'

The contents of %eb (Edit Box), %rd (Edit Integer) (etc.) box have been altered.

 

'DIRTY'

Indicates an OpenGL window is in need of re-painting.

 

'DO_COMMAND'

The callback was called because of calling DO_COMMAND@. See also %rc (Register Command).

 

'DRAG_AND_DROP'

Call in response to dropping a file onto the window.

 

'DROP_TARGET'

During a drag and drop this reason is used to identify when the target of the drag changes. This will change as the mouse moves. Applies to %bv (Branch View) and %lv (List View).

 

'DROPDOWN'

The droplist in a %el (Editable Combo Box) has been opened.

 

'DROPPED_FILE'

A file has been dropped - see %dr (OnDragDrop Callback).

 

'EDIT_KEY_DOWN'

The user has pressed a keyboard key during a label edit. Applies to %bv (Branch View) and %lv (List View).

 

'END_DRAG'

An item in a %lv (List View) or %bv (Branch View) has completed a drag.

 

'END_EDIT'

A label is about to be edited in a %lv (List View) or %bv (Branch View)

 

'ENUMERATED_PARAMETER'

An enumerated parameter (%ep (Enumerated parameter)) has been selected from within a parameter box.

 

'FILE_OPEN'

Call from standard call-backs 'FILE_OPENR' or 'FILE_OPENW'.

 

'GAINING_FOCUS'

Edit box gets input focus.

 

'HSCROLL'

Horizontal scrollbar moved

 

'HYPERTEXT_CHANGE'

Called when hypertext is being changed.

 

'HYPERTEXT_LINK'

Call-back from activating a hypertext link in %ht or %wb.

 

'ITEM_DOUBLE_CLICKED'

Listbox item double clicked.

 

'ITEM_EXPANDED'

A node in a %bv (Branch View) has been expanded or collapsed.

 

'ITEM_SELECTED'

Listbox item selected.

 

'KEY_DOWN'

A keyboard key has been pressed.

 

'LEFT_MOUSE_PRESS'

This indicates that a graphics icon has been dragged within a %gr (Graphics Region). See also: ADD_GRAPHICS_ICON@.

 

'LOSING_FOCUS'

Edit box loses input focus.

 

'MB_COMMAND'

Button press in a %mb (Multi-button Toolbar).

 

'MB_CUSTOMISE?'

User has double clicked the customise dialog in a %mb (Multi-button Toolbar).

 

'MB_DELETE?'

User has started moving a button in a %mb (Multi-button Toolbar).

 

'MB_DROPDOWN?'

User has requested a dropdown menu in a %mb (Multi-button Toolbar).

 

'MB_HELP'

User has clicked the help button in the customised dialog in a %mb (Multi-button Toolbar).

 

'MB_INSERT?'

User has completed moving a button in a %mb (Multi-button Toolbar).

 

'MDI_PAGE_TURN'

The active child window has changed in a %fr (MDI Frame).

 

'MENU_SELECTION'

A menu item has been invoked.

 

'MESSAGE_HOOK'

Call of %mg (Message Callback) related function.

 

'MOUSE_CLICK'

Node clicked in a %bv (Branch View).

 

'MOUSE_ENTER', 'MOUSE_LEAVE'

Indicates that the mouse has entered or left the area of a %ib (Image Button). The %ib must have the [mouse_hover] option for this callback reason to be used.

 

'MOUSE_LEFT_CLICK'

Left button down.

 

'MOUSE_LEFT_RELEASE'

Left button up.

 

'MOUSE_DOUBLE_CLICK'

Left double click.

 

'MOUSE_MIDDLE_CLICK'

Middle button down.

 

'MOUSE_MIDDLE_RELEASE'

Middle button up.

 

'MOUSE_MOVE'

Mouse movement.

 

'MOUSE_RIGHT_CLICK'

Right button down.

 

'MOUSE_RIGHT_RELEASE'

Right button up.

 

'PLOT_ADJUST'

When a %pl (SIMPLEPLOT Graphics Region) is changed -- resize for example.

 

'QUERY_SHUTDOWN'

Windows is asking to shutdown. See %ew (Exit Windows Callback).

 

'RESIZE'

Called when a control is being re-sized.

 

'SCROLL'

Scroll complete.

 

'SET_SELECTION'

An item has been selected in a %lv (List View) or %bv (Branch View).

 

'SETUP'

OpenGL window resized, see %og (OpenGL Graphics Region).

 

'SIZE_ADJUST'

A %ib (Image Button) is about to be displayed.

 

'STRING_CHANGE'

Text has changed in a %el (Editable Combo Box).

 

'TIMER'

Timer has fired in a %dl (Timer).

 

'USER_MESSAGE'

Message recieved via %rm (External Message Handler).

 

'USER_PARAMETER'

A user parameter (%up (User callback parameter)) has been selected from within a parameter box.

 

'TIMER'

Call associated with %dl (Timer).

 

'VSCROLL'

Vertical scrollbar moved

 

'WINDOW_CLOSE'

Call in response to %cc (Control Closure).

 

'WINDOW_CLOSED'

Call in response to %`cc.

 

'WINDOW_STARTUP'

Call in response to %sc (OnShow Callback).

 

'+'

Called as part of a compound call-back.

 

'?'

Not currently in a call-back.

 

Return value

Returns the value of the specified string parameter.

See also

SET_CLEARWIN_STRING@

 

 

Basket
Empty
 
Copyright © 1999-2020 Silverfrost Limited