RexxDW is an external function package that allows a Rexx programmer to write cross platform GUI applications, using a lightweight portable GUI API called Dynamic Windows (dwindows). The fundamental building blocks of a RexxDW program consist of two major components; widgets and event handlers or callbacks. Various widgets are packed into the required layout and events are connected to the widgets to carry out the required behaviour. The structure of a RexxDW program consists of various initialisation; creation of the widgets, packing them, connecting callbacks, and then calling the event loop handler to dispatch the event to the appropriate callbacks. The callbacks are normal Rexx subroutines. There are two event loop handlers depending on whether your Rexx interpreter supports the RexxCallback() API. DW_main() is used for interpreters that have RexxCallback(); DW_main_iteration() is used for those interpretes that don't. All of the functions in RexxDW are based on the same function in dwindows. Some function arguments will differ due to the nature of the Rexx API interface. The format of the function names is dw_(target)_(action)[_(options)]. eg. for tree widgets, functions act on both the tree itself and the tree items within the tree widget, so DW_tree_new() executes the "new" action on the tree widget, DW_tree_item_change() executes the "change" action on the tree item, not the tree. Some dwindows functions are not available in RexxDW, mainly because they are not able to be implemented: dw_icon_load, etc... A number of functions have been added to RexxDW that are not part of dwindows: dw_and, dw_or, dw_radiobutton_set, dw_radiobutton_get,... document dw_exec()?? add DW_container_get_column_type and DW_filesystem_get_column_type can dw_window_maximize() be implemented as dw_window_set_style() with MAXIMIZE attribute set and MINIMIZE attribute unset? no VALUE_CHANGE callback on spinbutton widget document that KEY_PRESS needs to be trapped in toplevel window but BUTTON_PRESS in low-level window (confirm on all platforms) bug in (Windows at least) item_select callback on container. Seems that the callback gets called twice irrespective of whether 0 or 1 is returned from the callback. bug (Windows) with drawing directly to a render window (ie not via a pixmap) (see rexxdw.rexx, Utility TAB) bug dw_listbox_selected() is supposed to return DW_LIT_NONE (-1) but dw_listbox_selected() returns unsigned int Under GTK+ 2.0 or greater, a call to dw_window_set_font() causes an expose event to fire. If dw_window_set_font() is called within the expose callback, you get an infinite loop. Bit of a bugger if your expose event sets different fonts for different lines!!! RexxDW runs on Windows 9x/Me/NT/2k/XP, OS/2 3.0+ and on any Un*x platform that has GTK+ 1.x installed (but works better with GTK+ 2.x). RexxDW lives at href:http://rexxdw.sf.net Dynamic Windows lives at href:http://dwindows.netlabs.org

The following "constants" are defined when RexxDW starts. By default, all constants are stored in an array with the stem preset to !REXXDW.! This can be changed by using the 'CONSTANTPREFIX' value of DW_variable(). If you use "Procedure" on your labels, you MUST "EXPOSE !REXXDW." or the stem you set with DW_variable() will not be visible. To reference the constants defined below, you must prefix them. So the "constant" DW_DESKTOP would be, by default, referenced in your code as !REXXDW.!DW_DESKTOP. DW_variable

MiscellaneousFlags The following is a list of miscellaneous flags. GTK_MAJOR_VERSION - 0 if NOT GTK+ platform, 1 for GTK+ 1.x, 2 for GTK+ 2.x HAVE_REXXCALLBACK - 1 if the interpreter supports RexxCallback() API DW_DESKTOP - the psuedo "window" which is the desktop DIRSEP - the Operating System directory separator PATHSEP - the Operating System path separator

FileDialogFlags The following is a list of the pre-defined flags that are used in a call to DW_file_browse() to determine the dialog type displayted. DW_DIRECTORY_OPEN - a directory selector dialog DW_FILE_OPEN - a file open dialog DW_FILE_SAVE - a file save dialog DW_file_browse

ContainerScrollFlags The following is a list of the pre-defined flags that are used in a call to DW_container_scroll() to indicate the direction of scrolling. DW_SCROLL_UP - scroll up a number of lines DW_SCROLL_DOWN - scroll down a number of lines DW_SCROLL_TOP - scroll to the top of the container DW_SCROLL_BOTTOM - scroll to the bottom of the container DW_container_scroll

TextAttributeFlags The following is a list of the pre-defined flags that are used in a call to DW_window_set_style() to specify the formatting of text within a widget. The following work on all platforms: - DW_DT_LEFT - text is left-aligned - DW_DT_RIGHT - text is right-aligned - DW_DT_CENTER - text is centered - DW_DT_VCENTER - text is centered vertically The following attributes only have an effect on OS/2: - DW_DT_QUERYEXTENT - DW_DT_UNDERSCORE - DW_DT_STRIKEOUT - DW_DT_TEXTATTRS - DW_DT_EXTERNALLEADING - DW_DT_TOP - DW_DT_BOTTOM - DW_DT_HALFTONE - DW_DT_MNEMONIC - DW_DT_WORDBREAK - DW_DT_ERASERECT DW_window_set_style

WindowStyleFlags The following is a list of the pre-defined flags that can be used when creating a new window. Any number of values from "Style Types" can be used plus optionally one value from "Initial State Types" are logically "or"ed together using DW_or(). Style Types: - DW_FCF_TITLEBAR - display titlebar - DW_FCF_SYSMENU - DW_FCF_MENU - DW_FCF_SIZEBORDER - DW_FCF_MINBUTTON - display minimise button - DW_FCF_MAXBUTTON - display maximise button - DW_FCF_MINMAX - DW_FCF_VERTSCROLL - DW_FCF_HORZSCROLL - DW_FCF_DLGBORDER - DW_FCF_BORDER - DW_FCF_SHELLPOSITION - DW_FCF_TASKLIST - DW_FCF_NOBYTEALIGN - DW_FCF_NOMOVEWITHOWNER - DW_FCF_SYSMODAL - DW_FCF_HIDEBUTTON - DW_FCF_HIDEMAX - DW_FCF_AUTOICON Initial State Types: - DW_FCF_MAXIMIZE - start maximised - DW_FCF_MINIMIZE - start minimised DW_window_new

ContainerColumnFlags The following is a list of the pre-defined flags that can be used when creating a container widget. When used in DW_container_setup() or DW_filesystem_setup(), one value from "Column Types", one value from "Alignment" and any value from "Separators" are logically "or"ed together using DW_or(). Column Types: - DW_CFA_BITMAPORICON - the column contains an image - DW_CFA_STRING - the column contains an unstructured string - DW_CFA_ULONG - the column contains an integer - DW_CFA_TIME - the column contains a time in the format Time('N') - DW_CFA_DATE - the column contains a date in the format Date('S') - DW_CFA_STRINGANDICON - the column contains a string and an image (not implemented) Alignment: - DW_CFA_CENTER - the column is centered - DW_CFA_LEFT - the column is left aligned - DW_CFA_RIGHT - the column is right aligned Separators (not applicable on all platforms): - DW_CFA_HORZSEPARATOR - the column has a cell border on the top and bottom - DW_CFA_SEPARATOR - the column has a cell border on the left and right DW_container_setup, DW_filesystem_setup

ContainerQueryFlags The following is a list of the pre-defined flags that can be used when querying a container widget. DW_CRA_ALL - all rows are queried DW_CRA_SELECTED - only rows selected are queried DW_CRA_CURSORED - only the row(s) currently have focus; ie. highlighted DW_container_query_start, DW_container_query_next

MLESearchFlags The following is a list of the pre-defined flags that can be used in the SearchFlags argument in DW_mle_search(). DW_MLE_CASESENSITIVE - search done respecting case DW_mle_search

MLEEditableFlags The following is a list of the pre-defined flags that can be used in the EditableFlags argument in DW_mle_set_editable(). DW_EDITABLE - MLE is editable DW_READONLY - MLE is not editable; ie readonly DW_mle_set_editable

MLEWordWrapFlags The following is a list of the pre-defined flags that can be used in the WordWrapFlags argument in DW_mle_set_word_wrap(). DW_WORD_WRAP - words are wrapped in the MLE DW_DONT_WORD_WRAP - no word wrapping occurs in the MLE DW_mle_set_word_wrap

PointerTypes The following is a list of the pre-defined mouse pointer types used in the Pointer argument in DW_window-set_pointer(). DW_POINTER_DEFAULT - the default pointer shape DW_POINTER_CLOCK - a clock pointer DW_POINTER_ARROW - an arrow pointing to the top left DW_window_set_pointer

Colours The following is a list of the pre-defined colours known to RexxDW. These colour constants are used in functions that require pre-defined colours. DW_CLR_BLACK DW_CLR_DARKRED DW_CLR_DARKGREEN DW_CLR_BROWN DW_CLR_DARKBLUE DW_CLR_DARKPINK DW_CLR_DARKCYAN DW_CLR_PALEGRAY DW_CLR_DARKGRAY DW_CLR_RED DW_CLR_GREEN DW_CLR_YELLOW DW_CLR_BLUE DW_CLR_PINK DW_CLR_CYAN DW_CLR_WHITE DW_CLR_DEFAULT DW_color_background_set, DW_color_foreground_set, DW_color_choose

WidgetOrientation The following constants are used in widgets that require an orientation to be specified. DW_VERT - vertical orientation DW_HORZ - horizontal orientation DW_box_new, DW_groupbox_new, DW_splitbar_new, DW_scrollbar_new

NotebookTabLocation The following constants are used in the TabLocation argument in a call to DW_notebook_new() to specify whether notebook tabs are located at the top or bottom of the window. DW_TAB_TO_TOP - notebook tabs are displayed across the top DW_TAB_TO_BOTTOM - notebook tabs are displayed across the bottom DW_notebook_new

NotebookPageLocation The following constants are used in the PageLocation argument in a call to DW_notebook_page_new() to specify if the page is created in front or behind other pages. DW_PAGE_TO_FRONT - page is created in front of other pages DW_PAGE_TO_BACK - page is created behind other pages DW_notebook_page_new

MenuConstants The following constants are used in a number of menu related function calls. DW_MENU_START - add the item at the start of the menu items DW_MENU_END - add the item at the end of the menu items DW_MENU_CHECKABLE - the menu item is checkable DW_MENU_NOT_CHECKABLE - the menu item is not checkable DW_MENU_SEPARATOR - the string to indicate the menu item is a separator DW_menu_append_item, DW_menu_item_set_check

BoxExpansionFlags The following constants are used in the box packing functions to specify whether the box expand in a horizontal or vertical direction. DW_EXPAND_HORZ - expand the box horizontally DW_DONT_EXPAND_HORZ - don't expand the box horizontal DW_EXPAND_VERT - expand the box vertically DW_DONT_EXPAND_VERT - don't expand the box vertically DW_box_pack_start, DW_box_pack_end

ListboxSelection The following constants are used in the Selection argument to a call to DW_listbox_new(). DW_LB_SINGLE_SELECTION - indicates that only 1 row in the listbox is selectable DW_LB_MULTIPLE_SELECTION - indicates that multiple rows in the listbox are selectable DW_listbox_new

ListboxSelected The following is a list of the pre-defined flags that can be used when setting the State of a listbox or combobox. DW_LB_SELECTED - set the item to be selected DW_LB_UNSELECTED - set the item to NOT be selected DW_listbox_select

ListboxReturn The following is the return value from DW_listbox_selected() or DW_listbox_selected_multi() if no item in the listbox has been selected. DW_LB_NONE - no listbox item selected DW_listbox_selected(), DW_listbox_selected_multi()

WidgetChecked The following constants are used to indicate the state of a widget that can have a boolean state. DW_CHECKED - widget is "on" or set DW_UNCHECKED - widget is "off" or unset DW_checkbox_set, DW_radiobutton_set

ContainerClearFlags The following constants are used in the Redraw argument to a call to DW_container_clear(). DW_REDRAW - redraw the cleared container DW_DONT_REDRAW - don't redraw the cleared container DW_container_new

ContainerSelection The following constants are used in the Selection argument to a call to DW_container_new(). DW_SINGLE_SELECTION - indicates that only 1 row in the container is selectable DW_MULTIPLE_SELECTION - indicates that multiple rows in the container are selectable DW_container_new

RectangleFill The following constants are used in the Fill argument to a call to DW_draw_rect(). DW_FILL - draws a filled rectangle DW_DONT_FILL - draws an outline rectangle 1 pixel in width DW_draw_rect

MessageboxFlags The following constants are used in the Flags argument to a call to DW_messagebox(). Logically "or" one value from Buttons and one value from Icons Buttons: - DW_MB_OK - DW_MB_OKCANCEL - DW_MB_YESNO - DW_MB_YESNOCANCEL Icons: - DW_MB_WARNING - DW_MB_ERROR - DW_MB_INFORMATION - DW_MB_QUESTION DW_messagebox

MessageboxResults The following constants are returned from a call to DW_messagebox(). DW_MB_RETURN_OK DW_MB_RETURN_YES DW_MB_RETURN_NO DW_MB_RETURN_CANCEL DW_messagebox

VirtualKeys The following is a list of the mnemonic key values known to RexxDW. These keys are returned in a KeyPressEvent Callback, in the VirtualKey argument. DW_VK_CANCEL DW_VK_BACK DW_VK_TAB DW_VK_CLEAR DW_VK_RETURN DW_VK_MENU DW_VK_PAUSE DW_VK_CAPITAL DW_VK_ESCAPE DW_VK_SPACE DW_VK_PRIOR DW_VK_NEXT DW_VK_END DW_VK_HOME DW_VK_LEFT DW_VK_UP DW_VK_RIGHT DW_VK_DOWN DW_VK_SELECT DW_VK_PRINT DW_VK_EXECUTE DW_VK_SNAPSHOT DW_VK_INSERT DW_VK_DELETE DW_VK_HELP DW_VK_LWIN DW_VK_RWIN DW_VK_NUMPAD0 DW_VK_NUMPAD1 DW_VK_NUMPAD2 DW_VK_NUMPAD3 DW_VK_NUMPAD4 DW_VK_NUMPAD5 DW_VK_NUMPAD6 DW_VK_NUMPAD7 DW_VK_NUMPAD8 DW_VK_NUMPAD9 DW_VK_MULTIPLY DW_VK_ADD DW_VK_SEPARATOR DW_VK_SUBTRACT DW_VK_DECIMAL DW_VK_DIVIDE DW_VK_F1 DW_VK_F2 DW_VK_F3 DW_VK_F4 DW_VK_F5 DW_VK_F6 DW_VK_F7 DW_VK_F8 DW_VK_F9 DW_VK_F10 DW_VK_F11 DW_VK_F12 DW_VK_F13 DW_VK_F14 DW_VK_F15 DW_VK_F16 DW_VK_F17 DW_VK_F18 DW_VK_F19 DW_VK_F20 DW_VK_F21 DW_VK_F22 DW_VK_F23 DW_VK_F24 DW_VK_NUMLOCK DW_VK_SCROLL DW_VK_LSHIFT DW_VK_RSHIFT DW_VK_LCONTROL DW_VK_RCONTROL DW_VK_LMENU DW_VK_RMENU KeyPressEventCallback

KeyStates The following is a list of the mnemonic key state values known to Rexx/DW. These keys are returned in a KeyPressEvent Callback, in the KeyState argument. DW_KC_CTRL DW_KC_SHIFT DW_KC_ALT KeyPressEventCallback

MouseButtons The following is a list of the mnemonic mouse button values known to RexxDW. These buttons are returned in a ButtonPressEvent Callback, in the Button argument. DW_VK_LBUTTON DW_VK_RBUTTON DW_VK_MBUTTON ButtonPressEventCallback ButtonReleaseEventCallback

Fontnames Font names in Rexx/DW are platform dependent. This section explains how to specify fonts on each of the supported platforms. Windows: Fonts are specifed in the format: 'size.family [Bold] [Italic]' As an example, the following specify various font specifications for 8 point Courier: fixedfont = '8.Courier' italicfont = '8.Courier Italic' boldfont = '8.Courier Bold' bolditalicfont = '8.Courier Bold Italic' GTK+ 2.x: Fonts are specified in the format: 'family [bold] [italic] size' As an example, the following specify various font specifications for 14 point monospace: fixedfont = 'monospace 14' italicfont = 'monospace italic 14' boldfont = 'monospace bold italic 14' bolditalicfont = 'monospace italic 14' GTK+ 1.x: Fonts are specified using full X11 specification. As an example, the following specify various font specifications for 120 courier: fixedfont = '-adobe-courier-medium-r-normal-*-*-120-*-*-m-*-iso8859-1' italicfont = '-adobe-courier-medium-o-normal-*-*-120-*-*-m-*-iso8859-1' boldfont = '-adobe-courier-bold-r-normal-*-*-120-*-*-m-*-iso8859-1' bolditalicfont = '-adobe-courier-bold-o-normal-*-*-120-*-*-m-*-iso8859-1' OS/2: Fonts are specifed in the format: 'size.family [Bold] [Italic]' As an example, the following specify various font specifications for 5 System VIO: fixedfont = '5.System VIO' italicfont = '5.System VIO Italic' boldfont = '5.System VIO Bold' bolditalicfont = '5.System VIO Bold Italic'

Packing One of the most important aspects of laying out widgets in a Rexx/DW program is how packing works. This section explains the Rexx/DW packing mechanism. The above ?????? TODO - horz/vert boxes, pack empty spaces, expand/dont_expand

Callbacks Rexx/DW is an event driven application. What this means is that internally various events occur, such as a key press, a window becoming exposed. Rexx/DW allows you to call an internal Rexx procedure when various events occur. Each widget you create has certain valid events associated with it. As part of your code you associate a particular event with a widget. This is done by calling DW_signal_connect(). This associates an event on a particular widget with an internal Rexx procedure, so that when the particular event occurs on that widget your procedure is executed and certain parameters are passed to it. Details on what parameters are passed is detailed below depending on the type of event. The internal Rexx procedure is called in the context of where DW_main() or DW_main_iteration() is called. This is important when considering what Rexx variables may or may not be in scope. It is probably better to always use PROCEDURE EXPOSE (myglobals) on procedures so you know that any variables you use within your procedure will not affect an others outside without you explicitly listing them. Once you have handled an event in your code, you can return 1 to inform Dynamic Windows that all processing has been handled for the particular event. Dynamic Windows will not execute its default event handling code. If your event handler returns 0, then Dynamic Windows will execute its default event handling code. The values of the supported events are: REXXDW_CONFIGURE_EVENT_CB REXXDW_KEY_PRESS_EVENT_CB REXXDW_BUTTON_PRESS_EVENT_CB REXXDW_BUTTON_RELEASE_EVENT_CB REXXDW_MOTION_NOTIFY_EVENT_CB REXXDW_DELETE_EVENT_CB REXXDW_EXPOSE_EVENT_CB REXXDW_CLICKED_EVENT_CB REXXDW_ITEM_ENTER_EVENT_CB REXXDW_ITEM_CONTEXT_EVENT_CB REXXDW_LIST_SELECT_EVENT_CB REXXDW_ITEM_SELECT_EVENT_CB REXXDW_SET_FOCUS_EVENT_CB REXXDW_VALUE_CHANGED_EVENT_CB REXXDW_SWITCH_PAGE_EVENT_CB REXXDW_COLUMN_CLICK_EVENT_CB With Rexx interpreters that don't provide RexxCallBack() it is not possible to inform Dynamic Windows to execute the default callback functionality after your event handler has executed its code, because the return value is returned to the Rexx program; via DW_main_iteration(), not to Dynamic Windows.

ConfigureEventCallback rcode = ConfigureEventCallback(Window, Width, Height [,UserData[,...]]) Called when a DW_CONFIGURE_EVENT signal fires on a window. This event usually occurs when a window's size is changed. Window - value of the window handle that has been resized Width - the new width of Window in pixels Height - the new height of Window in pixels UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. ... Call dw_signal_connect window, !REXXDW.!DW_CONFIGURE_EVENT, 'configure_cb', , 'fred', 'mary' ... configure_cb: Procedure Expose !REXXDW. Parse Arg win, width, height, var1, var2 Say 'New width:' width 'height:' height 'for Window:' win 'UserVar1:' var1 , 'UserVar2:' var2 Return 1

KeyPressEventCallback rcode = KeyPressEventCallback(Window, ASCIIKey, VirtualKey, KeyState [,UserData[,...]]) Called when a DW_KEY_PRESS_EVENT signal fires on a window. Occurs when the user presses a key. Window - value of the window handle in which the key was pressed ASCIIKey - the Hex representation of the key pressed. If not as ASCII key then the empty string is returned and VirtualKey should be used VirtualKey - the mnemonic key value of the key pressed KeyState - indicates whether SHIFT, CTRL or ALT modifiers are active UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. VirtualKeys KeyStates ... Call dw_signal_connect window, !REXXDW.!DW_KEY_PRESS_EVENT, 'keypress_cb', , 'fred', 'mary' ... keypress_cb: Procedure Expose !REXXDW. Parse Arg win, ascii, virtual, state, var1, var2 Say 'ASCII Key:' ascii 'Virtual Key:' virtual 'State:' state 'UserVar1:' , var1 'UserVar2:' var2 If virtual = !REXXDW.!DW_VK_F1 Then Return 1 Return 1

ButtonPressEventCallback rcode = ButtonPressEventCallback(Window, X, Y, Button [,UserData[,...]]) Called when a DW_BUTTON_PRESS_EVENT signal fires on a window. This occurs when the user clicks a button with the mouse. Window - value of the window handle in which the mouse button was pressed X - the X coordinate where the mouse button was pressed, relative to the top left corner of the Window Y - the Y coordinate where the mouse button was pressed, relative to the top left corner of the Window Button - which mouse button was pressed UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. MouseButtons ... Call dw_signal_connect window, !REXXDW.!DW_BUTTON_PRESS_EVENT, , 'buttonpress_cb', 'fred' ... buttonpress_cb: Parse Arg win, x, y, button, data Say 'Button:' button 'pressed at:' x'/'y 'in Window:' win Return 1

ButtonReleaseEventCallback rcode = ButtonReleaseEventCallback(Window, X, Y, Button [,UserData[,...]]) Called when a DW_BUTTON_RELEASE_EVENT signal fires on a window. This occurs when the user releases a button on the mouse. Window - value of the window handle in which the mouse button was released X - the X coordinate where the mouse button was released, relative to the top left corner of the Window Y - the Y coordinate where the mouse button was released, relative to the top left corner of the Window Button - which mouse button was released UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. MouseButtons ... Call dw_signal_connect window, !REXXDW.!DW_BUTTON_RELEASE_EVENT, , 'buttonrelease_cb', 'fred' ... buttonreleases_cb: Parse Arg win, x, y, button, data Say 'Button:' button 'released at:' x'/'y 'in Window:' win Return 1

MotionNotifyEventCallback rcode = MotionNotifyEventCallback(Window, X, Y, Button [,UserData[,...]]) Called when a DW_MOTION_NOTIFY_EVENT signal fires on a window. This occurs when the user moves the mouse. Window - value of the window handle in which the mouse button was released X - the X coordinate where the mouse button was released, relative to the top left corner of the Window Y - the Y coordinate where the mouse button was released, relative to the top left corner of the Window State - ????????????????? UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. ButtonPressEventCallback ButtonReleaseEventCallback ... Call dw_signal_connect window, !REXXDW.!DW_MOTION_NOTIFY_EVENT, , 'motionnotify_cb', 'fred' ... motionnotify_cb: Parse Arg win, x, y, state, data Say 'Mouse movied to' x'/'y 'in Window:' win 'with state:' state Return 1

DeleteEventCallback rcode = DeleteEventCallback(Window [,UserData[,...]]) Called when a DW_DELETE_EVENT signal fires on a window. This occurs when the user closes the window by clicking the close icon on the window title bar, or when dw_window_destroy() ???? is called on the window. Window - value of the window handle in which the mouse button was released UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. DW_window_destroy ... Call dw_signal_connect window, !REXXDW.!DW_DELETE_EVENT, 'delete_cb', , 'fred' ... delete_cb: Parse Arg win, data Say 'Window:' win 'deleted' Return 1

ExposeEventCallback rcode = ExposeEventCallback(Window, X, Y, Width, Height [,UserData[,...]]) Called when a DW_EXPOSE_EVENT signal fires on a window. This occurs when the window is exposed. Window - value of the window handle in which the mouse button was released X - the top left X coordinate of the exposed area Y - the top left Y coordinate of the exposed area Width - the width of the exposed area Height - the height of the exposed area UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. ... Call dw_signal_connect window, !REXXDW.!DW_EXPOSE_EVENT, 'expose_cb', , 'fred' ... expose_cb: Parse Arg win, x, y, width, height, data Say 'Window:' win 'exposed at' x'/'y 'size:' width'/'height Return 1

ClickedEventCallback rcode = ClickedEventCallback(Window [,UserData[,...]]) Called when a DW_CLICKED_EVENT signal fires on a window. This occurs when the user clicks in the window; usually a button window. Window - value of the window handle that was clicked UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. ... Call dw_signal_connect window, !REXXDW.!DW_CLICKED_EVENT, 'clicked_cb', , 'fred' ... clicked_cb: Parse Arg win, data Say 'Window:' win 'clicked' Return 1

ItemEnterEventCallback rcode = ItemEnterEventCallback(Window, Text [,UserData[,...]]) Called when a DW_ITEM_ENTER_EVENT signal fires on a window. This occurs when the user double-clicks or presses ENTER key in a container window. Window - value of the window handle that was clicked Text - the string set by a call to DW_container_set_row_title() UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. DW_container_set_row_title ... Call dw_signal_connect window, !REXXDW.!DW_ITEM_ENTER_EVENT, 'itementer_cb', , 'fred' ... itementer_cb: Parse Arg win, text, data Say 'Item text' text 'entered in Window:' win 'userdata:' data Return 1

ItemContextEventCallback rcode = ItemContextEventCallback(Window, Text, X, Y, ItemData [,UserData[,...]]) Called when a DW_ITEM_CONTEXT_EVENT signal fires on a window. This occurs when the user clicks the right mouse button in a container or tree window. Window - value of the window handle that was clicked Text - the string set by a call to DW_container_set_row_title() or the third argument ???? to DW_tree_item_change() X - the X coordinate where the mouse button was pressed, relative to the top left corner of the Window Y - the Y coordinate where the mouse button was pressed, relative to the top left corner of the Window ItemData - ???? UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. DW_container_set_row_title, DW_tree_item_change When connecting this signal to a Tree widget, DW_signal_connect() MUST be called BEFORE the Tree is populated. When connecting this signal to a Container widget, DW_signal_connect() MUST be called AFTER the Container is populated. ... Call dw_signal_connect window, !REXXDW.!DW_ITEM_CONTEXT_EVENT, , 'itemcontext_cb', 'fred' ... itemcontext_cb: Parse Arg win, text, x, y, itemdata, userdata Say 'Item text' text 'entered in Window:' win 'at' x'/'y 'userdata:' userdata Return 1

ListSelectEventCallback rcode = ListSelectEventCallback(Window, Item [,UserData[,...]]) Called when a DW_LIST_SELECT_EVENT signal fires on a window. This occurs when the user clicks an entry in a listbox or combobox; ie an item in a list is selected. Window - value of the window handle that was clicked Item - the index of the item in the list that is selected. This index is 0-based. UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. ... Call dw_signal_connect window, !REXXDW.!DW_LIST_SELECT_EVENT, , 'listselect_cb', 'fred' ... listselect_cb: Parse Arg win, item, userdata Say 'Item number' item 'selected in Window:' win 'userdata:' userdata Return 1

ItemSelectEventCallback rcode = ItemSelectEventCallback(Window, Item, Text, Itemdata [,UserData[,...]]) Called when a DW_ITEM_SELECT_EVENT signal fires on a window. This occurs when the user clicks the left button on an item in a container or tree window. selected. Window - value of the window handle that was clicked Item - the index of the item in the list that is selected. This index is 0-based. Text - the string set by a call to DW_container_set_row_title() or the second argument to DW_tree_insert() ItemData - the string set by a the fifth argument to a call to DW_tree_insert() UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. When connecting this signal to a Tree widget, DW_signal_connect() MUST be called BEFORE the Tree is populated otherwise the signal will never fire. When connecting this signal to a Container widget, DW_signal_connect() MUST be called AFTER the Container is populated. ... Call dw_signal_connect window, !REXXDW.!DW_ITEM_SELECT_EVENT, , 'itemselect_cb', 'fred' ... itemselect_cb: Parse Arg win, item, text, userdata Say 'Item number' item 'selected in Window:' win 'text is:' text , 'userdata:' userdata Return 1

SetFocusEventCallback rcode = SetFocusEventCallback(Window [,UserData[,...]]) Called when a DW_SET_FOCUS_EVENT signal fires on a window. This occurs when the user gives focus to a window, either by clicking the left button in the window or by tabbing to the window. selected. Window - value of the window handle that was clicked UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. ... Call dw_signal_connect window, !REXXDW.!DW_SET_FOCUS_EVENT, 'setfocus_cb', , 'fred' ... setfocus_cb: Parse Arg win, userdata Say 'Window:' win 'now has focus userdata:' userdata Return 1

ValueChangedEventCallback rcode = ValueChangedEventCallback(Window, Value [,UserData[,...]]) Called when a DW_VALUE_CHANGED_EVENT signal fires on a window. This occurs when the user adjusts a scrollbar, or a slider control. Window - value of the window handle that was clicked Value - the new value of the top of the scrollbar thumb in units defined by DW_scrollbar_set_range() UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. DW_scrollbar_set_range, DW_slider_set_pos ... Call dw_signal_connect window, !REXXDW.!DW_VALUE_CHANGED_EVENT, , 'valuechanged_cb', 'fred' ... valuechanged_cb: Parse Arg win, val, userdata Say 'The top of the scrollbar thumb is now' val 'in Window:' win , 'userdata:' userdata Return 1

SwitchPageEventCallback rcode = SwitchPageEventCallback(Window, Page [,UserData[,...]]) Called when a DW_SWITCH_PAGE_EVENT signal fires on a window. This occurs when the user clicks on a tab in a notebook. Window - value of the window handle that was clicked Page - the index of the page of the notebook selected. Page numbers are 0 based. UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. ... Call dw_signal_connect window, !REXXDW.!DW_SWITCH_PAGE_EVENT, , 'switchpage_cb', 'fred' ... switchpage_cb: Parse Arg win, page, userdata Say 'Page' page 'of Window:' win 'selected. userdata:' userdata Return 1

ColumnClickEventCallback rcode = ColumnClickEventCallback(Window, Column [,UserData[,...]]) Called when a DW_COLUMN_CLICK_EVENT signal fires on a window. This occurs when the user clicks on a column heading of a container window. selected. Window - value of the window handle that was clicked Column - the index of the column of the container selected. Column numbers are 0 based. UserData - following optional values that the user supplied when the signal event was connected Return 1 to ensure that the default callback is not called. Return 0 to enable the default callback to be called. ... Call dw_signal_connect window, !REXXDW.!DW_COLUMN_CLICK_EVENT, , 'columnclick_cb', 'fred' ... columnclick_cb: Parse Arg win, column, userdata Say 'Column' column 'of Window:' win 'selected. userdata:' userdata Return 1

TimerEventCallback rcode = TimerEventCallback([UserData[,...]]) Called when a generic timer goes off. This occurs after the period specified by DW_timer_connect(). selected. UserData - optional values that the user supplied when the signal event was connected Return 1 to ensure that the timer is rearmed. Return 0 to ensure that the timer is not rearmed. The return code from the function called as a result of the timer firing determines whether the timer continues to fire after the specified period. DW_timer_connect ... Call dw_timer_connect window, 5000, 'timer_cb', 'fred' ... timer_cb: Parse Arg userdata Say 'Our timer went off after 5 seconds' 'userdata:' userdata Return 1

The following external functions comprise Rexx/DW.

Widgets are the fundamental display items in RexxDW. RexxDW supports a range of widgets to enable a rich GUI interface for your Rexx programs. RexxDW supports all common widget types as follows: box button checkbox/radiobutton container/filesystem dialog rendering entryfield listbox/combobox menu multiline edit notebook percent scrollbar slider spinbutton splitbar text tree window

Boxes are used to layout the GUI display. Widgets are packed into a box to position that widget. A box can be horizontal or vertical, which determines the arrangement of the widgets packed into the box. So to arrange two widgets side-by-side, you would create a horizontal box, your two widgets, and pack those two widgets into the box and they appear beside each other.

DW_box_new win = dw_box_new( Orientation ) Creates a new generic box window. A box is the basic widget for arranging the location and position of other widgets. Orientation- !REXXDW.!DW_VERT to indicate a vertical box !REXXDW.!DW_HORZ to indicate a horizontal box A window identifier. DW_groupbox_new, WidgetOrientation The orientation of a box determines the orientation of the widgets that are packed into this box. Creating a horizontal box and packing two buttons into it will result in the two buttons being placed side by side. ... box = dw_box_new( !REXXDW.!DW_VERT ) Call dw_box_pack_start win, box, 0, 0, !REXXDW.!DW_EXPAND_HORZ, , !REXXDW.!DW_EXPAND_VERT, 0

DW_groupbox_new win = dw_groupbox_new( Orientation, Title ) Creates a new generic groupbox window. A box is the basic widget for arranging the location and position of other widgets. The difference between a box and a groupbox is that a groupbox contains a border and a Title in the top left corner. Orientation- !REXXDW.!DW_VERT to indicate a vertical box !REXXDW.!DW_HORZ to indicate a horizontal box Title - the text to display as the box title A window identifier. DW_box_new, WidgetOrientation The orientation of a box determines the orientation of the widgets that are packed into this box. Creating a horizontal box and packing two buttons into it will result in the two buttons being placed side by side. ... box = dw_groupbox_new( !REXXDW.!DW_VERT, 'Editor' ) Call dw_box_pack_start win, box, 0, 0, !REXXDW.!DW_EXPAND_HORZ, , !REXXDW.!DW_EXPAND_VERT, 0

DW_box_pack_start dw_box_pack_start( ParentBox, BoxToPack, BoxWidth, BoxHeight, HorzExpand, VertExpand, Padding ) Packs the BoxToPack at the start of the ParentBox; ie at the left of a horizontal ParentBox, or the top of a vertical ParentBox. The height and width of the box can be specified as is the ability to allow the box to expand horizontally or vertically. ParentBox - the box into which the BoxToPack is packed BoxToPack - the box that requires packing BoxWidth - the initial width of the box in pixels BoxHeight - the initial height of the box in pixels HorzExpand - indicate if the box can be expanded horizontally. Specify either !REXXDW.!DW_EXPAND_HORZ or !REXXDW.!DW_DONT_EXPAND_HORZ VertExpand - indicate if the box can be expanded vertically. Specify either !REXXDW.!DW_EXPAND_VERT or !REXXDW.!DW_DONT_EXPAND_VERT Padding - The number of pixels of padding to add around all sides of BoxToPack No return result. DW_box_pack_end The BoxToPack argument can be 0, which will result in empty space being packed. ... button = dw_bitmapbutton_new_from_file( 'Quit', 0, 'quit' ) Call dw_box_pack_start win, button, 0, 32, !REXXDW.!DW_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0

DW_box_pack_end dw_box_pack_end( ParentBox, BoxToPack, BoxWidth, BoxHeight, HorzExpand, VertExpand, Padding ) Packs the BoxToPack at the end of the ParentBox; ie at the right of a horizontal ParentBox, or the bottom of a vertical ParentBox. The height and width of the box can be specified as is the ability to allow the box to expand horizontally or vertically. ParentBox - the box into which the BoxToPack is packed BoxToPack - the box that requires packing BoxWidth - the initial width of the box in pixels BoxHeight - the initial height of the box in pixels HorzExpand - indicate if the box can be expanded horizontally. Specify either !REXXDW.!DW_EXPAND_HORZ or !REXXDW.!DW_DONT_EXPAND_HORZ VertExpand - indicate if the box can be expanded vertically. Specify either !REXXDW.!DW_EXPAND_VERT or !REXXDW.!DW_DONT_EXPAND_VERT Padding - The number of pixels of padding to add around all sides of BoxToPack No return result. DW_box_pack_start The BoxToPack argument can be 0, which will result in empty space being packed. ... button = dw_bitmapbutton_new_from_file( 'Quit', 0, 'quit' ) Call dw_box_pack_end win, button, 0, 32, !REXXDW.!DW_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0

Buttons enable an action to be carried out by the user clicking the left mouse button on the widget. RexxDW supports two types of button; plain text buttons and bitmap buttons.

DW_button_new win = dw_button_new( ButtonText, Id ) Creates a new text button. A button is a widget which contains text and can be clicked to execute some action. ButtonText - the text to display in the button Id - a numeric identifier used to identify the window A window identifier. DW_bitmapbutton_new_from_file ... button = dw_button_new( "Quit", 10 )

DW_bitmapbutton_new_from_file win = dw_bitmapbutton_new_from_file( BubbleText, Id, Filename ) Creates a new button window using a bitmap image. BubbleText - the text to display when the mouse is over the button Id - a numeric identifier used to identify the window Filename - the name of a file containing a valid bitmap image (.BMP, or .XPM) A window identifier. DW_button_new ... button = dw_bitmapbutton_new_from_file( 'Quit', 0, 'quit' ) Call dw_box_pack_start win, button, 32, 32, !REXXDW.!DW_DONT_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0

The Calendar widget displays a month calendar from which the user can select a date.

DW_calendar_new win = dw_calendar_new( Id ) Creates a new calendar. A calendar is a widget which allows the user to select a date. Id - a numeric identifier used to identify the window A window identifier. DW_calendar_get_date, DW_calendar_set_date On OS/2 this is a dummy text widget. On GTK, only 1 month is ever displayed. On Windows, more than 1 month is displayed depending on whether the widget is packed with expanding on. ... calendar = dw_calendar_new( 10 )

DW_calendar_get_date date = dw_calendar_get_date( Win ) Gets the selected date of the widget. Win - the window identifier returned from DW_calendar_new() The date selected in Rexx's DATE('S') format. DW_calendar_new, DW_calendar_set_date ... calendar = dw_calendar_new( 10 ) ... date = dw_calendar_get_date( calendar )

DW_calendar_set_date dw_calendar_set_date( Win, Date ) Sets the date for the widget. Win - the window identifier returned from DW_calendar_new() Date - the date to set the widget to. Must be in Rexx DATE( 'S' ) format. None DW_calendar_new, DW_calendar_get_date ... calendar = dw_calendar_new( 10 ) ... date = dw_calendar_set_date( calendar, Date( 'S' ) )

Checkboxes provide a simple mechanism for a user to indicate a boolean value response. Radiobuttons provide the user with a means to choose from a list of options.

DW_checkbox_new win = dw_checkbox_new( CheckboxText, Id ) Creates a new checkbox. A checkbox is a widget that allows for a boolean value to be set. It contains text to describe the boolean value being set. CheckboxText - the text to display next to the checkbox Id - a numeric identifier used to identify the window A window identifier. DW_checkbox_get, DW_checkbox_set ... checkbox = dw_checkbox_new( "Allow user to delete", 0 )

DW_radiobutton_new win = dw_radiobutton_new( ButtonText, Id ) Creates a new radiobutton. A radiobutton is a widget that allows for one of a number of values to be set. It contains text to describe the value being set. A number of radiobuttons are created together with one of them set at any point in time. ButtonText - the text to display next to the radiobutton Id - a numeric identifier used to identify the window A window identifier. DW_checkbox_new, DW_groupbox_new For radiobuttons to work properly, all radiobuttons that are to be grouped together MUST be packed into the same groupbox and they MUST have a unique Id within the groupbox. langs = 'Rexx Perl Tcl C COBOL' groupbox = dw_groupbox_new( !REXXDW.!DW_VERT, 0, 'Favourite Language' ) Do i = 1 To Words( langs ) rb.i = dw_radiobutton_new( Word( langs, i ), i*10 ) Call dw_box_pack_start groupbox, rb.i, 150, 15, !REXXDW.!DW_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0 End Call dw_radiobutton_set rb.1, !REXXDW.!DW_CHECKED

DW_checkbox_set dw_checkbox_set( Win, State ) Sets the state of the specified checkbox. Win - the window identifier returned from DW_checkbox_new() State - the initial state of the checkbox; !REXXDW.!DW_CHECKED or !REXXDW.!DW_UNCHECKED No return result. DW_checkbox_new, DW_checkbox_get, WidgetChecked ... checkbox = dw_checkbox_new( "Allow access", 0 ) Call dw_checkbox_set( checkbox, !REXXDW.!DW_CHECKED )

DW_radiobutton_set dw_radiobutton_set( Win, State ) Sets the state of the radiobutton to checked or not. Win - the window identifier returned from DW_radiobutton_new() State - set to DW_CHECKED or DW_UNCHECKED No return result. DW_radiobutton_get langs = 'Rexx Perl Tcl C COBOL' groupbox = dw_groupbox_new( !REXXDW.!DW_VERT, 0, 'Favourite Language' ) Do i = 1 To Words( langs ) rb.i = dw_radiobutton_new( Word( langs, i ), i*10 ) Call dw_box_pack_start groupbox, rb.i, 150, 15, !REXXDW.!DW_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0 End Call dw_radiobutton_set rb.1, !REXXDW.!DW_CHECKED

DW_checkbox_get win = dw_checkbox_get( Win ) Queries the state of the specified checkbox. Win - the window identifier returned from DW_checkbox_new() 1 if the checkbox is checked, 0 if not checked. DW_checkbox_new, DW_checkbox_set ... checkbox = dw_checkbox_new( "Allow access", 0 ) ... rc = dw_checkbox_get( checkbox ) cb_result = 'Unchecked Checked' Say 'Allow access checkbox' Word( cb_result, rc+1 )

DW_radiobutton_get boolean = dw_radiobutton_get( Win ) Determines if a radiobutton has been checked or not. Win - the window identifier returned from DW_radiobutton_new() 1 if the radiobutton is checked, 0 if unchecked DW_radiobutton_set langs = 'Rexx Perl Tcl C COBOL' groupbox = dw_groupbox_new( !REXXDW.!DW_VERT, 0, 'Favourite Language' ) Do i = 1 To Words( langs ) rb.i = dw_radiobutton_new( Word( langs, i ), i*10 ) Call dw_box_pack_start groupbox, rb.i, 150, 15, !REXXDW.!DW_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0 End Call dw_radiobutton_set rb.1, !REXXDW.!DW_CHECKED ... Do i = 1 To Words( langs ) If dw_radiobutton_get( rb.i ) Then Do Say 'Your favourite language is' Word( langs, i ) Leave End End

These widgets provide a two-dimensional display of read-only data. Data are displayed in rows and columns, with automatically created scrollbars to display the complete set of data. Columns can be resized by the user at runtime. A Filesystem is the same as a normal Container, except that the first column consists of a column of string and icon items, which usually displays a filename. All DW_container*() functions (for which there is no specific "Filename" equivalent) also works with a "Filename" widget.

DW_container_new win = dw_container_new( Id, Selection ) Creates a new container. A container is a widget that provides a grid of cells with column headings. Id - a numeric identifier used to identify the window Selection - !REXXDW.!DW_SINGLE_SELECTION indicates that only 1 row in the container is selectable !REXXDW.!DW_MULTIPLE_SELECTION indicates that multiple rowsin the container are selectable A window identifier. ContainerSelection ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION )

DW_container_alloc alloc = dw_container_alloc( Win, RowCount ) Allocates working memory for a container window. Win - the window identifier returned from DW_container_new() RowCount - the number of rows of data that the container will initially contain An identifier for the working memory. DW_container_new, DW_container_clear After a container window is created, you need to allocate memory for the initial number of rows that the container will contain. This call does that and must be called after creating the container. The allocated memory will be freed when the container is destroyed and by a call to DW_container_clear(). ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) alloc = dw_container_alloc( container, 10 ) ...

DW_container_setup dw_container_setup( Win, FlagsArray, TitlesArray[,Separator] ) Defines properties for the columns in a container. Win - the window identifier returned from DW_container_new() FlagsArray - an array containing column flags TitlesArray- an array containing column heading titles Separator - An optional flag under OS/2 ????? No return result. DW_container_change_item, DW_filesystem_setup, ContainerColumnFlags The FlagsArray is a Rexx stem variable name, including a trailing period. The 0th compound variable (eg Flags.0) contains a count of the number of items in the array. Each item in the array can contain a combination of the values described in ContainerColumnFlags. ... flags.0 = 2 flags.1 = dw_or( !REXXDW.!DW_CFA_STRINGANDICON, !REXXDW.!DW_CFA_LEFT, , !REXXDW.!DW_CFA_SEPARATOR, !REXXDW.!DW_CFA_HORZSEPARATOR ) flags.2 = dw_or( !REXXDW.!DW_CFA_STRING, !REXXDW.!DW_CFA_LEFT, , !REXXDW.!DW_CFA_SEPARATOR, !REXXDW.!DW_CFA_HORZSEPARATOR ) titles.0 = 2 titles.1 = 'Title' titles.2 = 'Command' ... container = dw_container_new( 1, !REXXDW.!DW_MULTIPLE_SELECTION ) Call dw_container_setup container, 'flags.', 'titles.', 0 alloc = dw_container_alloc( container, numrows ) ... Do i = 1 To numrows Call dw_container_set_item container, alloc, 0, i-1, title.i, icon.i Call dw_container_set_item container, alloc, 1, i-1, command.i Call dw_container_set_row_title alloc, i-1, "Row"i End

DW_filesystem_setup dw_filesystem_setup( Win, FlagsArray, TitlesArray, Separator ) Defines properties for the columns in a filesystem container. Win - the window identifier returned from DW_container_new() FlagsArray - an array containing column flags TitlesArray- an array containing column heading titles No return result. DW_filesystem_change_item, DW_container_setup, ContainerColumnFlags The FlagsArray is a Rexx stem variable name, including a trailing period. The 0th compound variable (eg Flags.0) contains a count of the number of items in the array. Each item in the array can contain a combination of the values described in ContainerColumnFlags. ... flags.0 = 2 flags.1 = dw_or( !REXXDW.!DW_CFA_STRINGANDICON, !REXXDW.!DW_CFA_LEFT, , !REXXDW.!DW_CFA_SEPARATOR, !REXXDW.!DW_CFA_HORZSEPARATOR ) flags.2 = dw_or( !REXXDW.!DW_CFA_STRING, !REXXDW.!DW_CFA_LEFT, , !REXXDW.!DW_CFA_SEPARATOR, !REXXDW.!DW_CFA_HORZSEPARATOR ) titles.0 = 2 titles.1 = 'Title' titles.2 = 'Command' ... container = dw_container_new( 1, !REXXDW.!DW_MULTIPLE_SELECTION ) alloc = dw_container_alloc( container, numrows ) Call dw_filesystem_setup container, 'flags.', 'titles.' ... normalfileicon = dw_icon_load_from_file( '/home/mark/normalfile' ) Do i = 1 To numrows Call dw_filesystem_set_file container, alloc, '/home/mark/myfile', myicon Call dw_filesystem_set_item container, alloc, 0, i-1, title.i, icon.i Call dw_filesystem_set_item container, alloc, 1, i-1, command.i Call dw_container_set_row_title alloc, i-1, "Row"i End

DW_container_set_item dw_container_set_item( Win, Memory, Column, Row, Data [,Data2] ) Adds the initial data into a cell of a container. Win - the window identifier returned from DW_container_new() Memory - the memory identifier returned by a call to DW_container_alloc() Column - the column of the data to be changed, 0 based Row - the row of the data to be changed, 0 based Data - the new data value for the cell Data2 - extra data for the cell if the column type is !REXXDW.!DW_CFA_STRINGANDICON (not implemented yet) No return result. DW_container_change_item, DW_container_setup, ContainerColumnFlags DW_filesystem_change_item, DW_filesystem_set_item The Data (and Data2) arguments must match the data type of the column when defined in the call to DW_container_setup(). ... flags.0 = 2 flags.1 = dw_or( !REXXDW.!DW_CFA_STRINGANDICON, !REXXDW.!DW_CFA_LEFT, , !REXXDW.!DW_CFA_SEPARATOR, !REXXDW.!DW_CFA_HORZSEPARATOR ) flags.2 = dw_or( !REXXDW.!DW_CFA_STRING, !REXXDW.!DW_CFA_LEFT, , !REXXDW.!DW_CFA_SEPARATOR, !REXXDW.!DW_CFA_HORZSEPARATOR ) titles.0 = 2 titles.1 = 'Title' titles.2 = 'Command' ... container = dw_container_new( 1, !REXXDW.!DW_MULTIPLE_SELECTION ) alloc = dw_container_alloc( container, numrows ) Call dw_container_setup container, 'flags.', 'titles.', 0 ... Do i = 1 To numrows Call dw_container_set_item container, alloc, 0, i-1, title.i, icon.i Call dw_container_set_item container, alloc, 1, i-1, command.i Call dw_container_set_row_title alloc, i-1, "Row"i End

DW_filesystem_set_file dw_filesystem_set_file( Win, Memory, Row, Filename, Icon ) Adds the data in the first cell of a filesystem container. Win - the window identifier returned from DW_container_new() Memory - the memory identifier returned by a call to DW_container_alloc() Row - the row of the data to be changed, 0 based Filename - the new filename for the cell Icon - the icon identifier returned from DW_icon_load_from_file() to be the new icon for the cell No return result. DW_filesystem_change_file, DW_filesystem_set_item ... normalfileicon = dw_icon_load_from_file( '/home/mark/normalfile' ) container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) alloc = dw_container_alloc( container, 10 ) ... Call dw_filesystem_set_file container, alloc, 10, '/home/mark/newfile.txt', , normalfileicon

DW_filesystem_set_item dw_filesystem_set_item( Win, Memory, Column, Row, Data [,Data2] ) Adds the initial data into a cell of a filesystem container. Win - the window identifier returned from DW_container_new() Memory - the memory identifier returned by a call to DW_container_alloc() Column - the column of the data to be changed, 0 based Row - the row of the data to be changed, 0 based Data - the new data value for the cell Data2 - extra data for the cell if the column type is !REXXDW.!DW_CFA_STRINGANDICON (not implemented yet) No return result. DW_container_change_item, DW_container_setup, ContainerColumnFlags DW_filesystem_change_item, DW_container_set_item The Data (and Data2) arguments must match the data type of the column when defined in the call to DW_container_setup(). ... flags.0 = 2 flags.1 = dw_or( !REXXDW.!DW_CFA_STRINGANDICON, !REXXDW.!DW_CFA_LEFT, , !REXXDW.!DW_CFA_SEPARATOR, !REXXDW.!DW_CFA_HORZSEPARATOR ) flags.2 = dw_or( !REXXDW.!DW_CFA_STRING, !REXXDW.!DW_CFA_LEFT, , !REXXDW.!DW_CFA_SEPARATOR, !REXXDW.!DW_CFA_HORZSEPARATOR ) titles.0 = 2 titles.1 = 'Title' titles.2 = 'Command' ... container = dw_container_new( 1, !REXXDW.!DW_MULTIPLE_SELECTION ) alloc = dw_container_alloc( container, numrows ) Call dw_filesystem_setup container, 'flags.', 'titles.', 0 ... Do i = 1 To numrows Call dw_filesystem_set_file container, alloc, i-1, fname.i, icon.i Call dw_filesystem_set_item container, alloc, 0, i-1, title.i, icon.i Call dw_filesystem_set_item container, alloc, 1, i-1, command.i Call dw_container_set_row_title alloc, i-1, "Row"i End

DW_container_change_item dw_container_change_item( Win, Column, Row, Data [,Data2] ) Changes the data in a cell of a container. Win - the window identifier returned from DW_container_new() Column - the column of the data to be changed, 0 based Row - the row of the data to be changed, 0 based Data - the new data value for the cell Data2 - extra data for the cell if the column type is !REXXDW.!DW_CFA_STRINGANDICON (not implemented yet) No return result. DW_container_set_item The Data (and Data2) arguments must match the data type of the column when defined in the call to DW_container_setup(). ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) ... Call dw_container_change_item container, 0, 10, 'New string data'

DW_filesystem_change_file dw_filesystem_change_file( Win, Row, Filename, Icon ) Changes the data in the first cell of a filesystem container. Win - the window identifier returned from DW_container_new() Row - the row of the data to be changed, 0 based Filename - the new filename for the cell Icon - the icon identifier returned from DW_icon_load_from_file() to be the new icon for the cell No return result. DW_filesystem_change_item, DW_filesystem_set_file ... normalfileicon = dw_icon_load_from_file( '/home/mark/normalfile' ) ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) ... Call dw_filesystem_change_file container, 10, '/home/mark/newfile.txt', , normalfileicon

DW_filesystem_change_item dw_filesystem_change_item( Win, Column, Row, Data [,Data2] ) Changes the data in a cell of a container. Win - the window identifier returned from DW_container_new() Column - the column of the data to be changed, 0 based Row - the row of the data to be changed, 0 based Data - the new data value for the cell Data2 - extra data for the cell if the column type is !REXXDW.!DW_CFA_STRINGANDICON (not implemented yet) No return result. DW_container_set_item The Data (and Data2) arguments must match the data type of the column when defined in the call to DW_container_setup(). ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) ... Call dw_filesystem_change_item container, 0, 10, 'New string data'

DW_container_insert dw_container_insert( Win, Memory, RowCount ) Inserts the allocated memory into the container. Win - the window identifier returned from DW_container_new() Memory - the memory identifier returned by a call to DW_container_alloc() RowCount - the number of rows of data that the container will initially contain No return result. DW_container_new, DW_container_alloc ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) alloc = dw_container_alloc( container, numrows ) ... Call dw_container_insert container, alloc, numrows

DW_container_set_row_title dw_container_set_row_title( Memory, Row, TitleText ) Assigns a textual string for the specified Row. Used to identify this row in other container functions Memory - the memory identifier returned by a call to DW_container_alloc() Row - the row of data to be assigned the value; 0 based TitleText - the text to be associated with the row No return result. DW_container_cursor, DW_container_delete_row, DW_container_query_next, DW_container_query_start ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) alloc = dw_container_alloc( container, numrows ) ... Do i = 1 To numrows Call dw_container_set_row_title alloc, i-1, "Row"i End ... Call dw_container_delete_row container, "Row10"

DW_container_set_column_width dw_container_set_column_width( Win, Column, Width ) Sets the width of the column in the container to Width pixels. Win - the window identifier returned from DW_container_new() Column - the column that requires a specific width; 0 based Width - the width of the column in pixels No return result. DW_container_optimize Columns with a set fixed width are not changed when DW_container_optimize() is called. ... container = dw_container_new( 1, !REXXDW.!DW_MULTIPLE_SELECTION ) ... Call dw_container_set_width( container, 0, 25 )

DW_container_optimize dw_container_optimize( Win ) Rearranges the width of the container columns to provide the optimum display of the columns. Win - the window identifier returned from DW_container_new() No return result. ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) alloc = dw_container_alloc( container, numrows ) ... Call dw_container_insert container, alloc, numrows Call dw_container_optimize container

DW_container_clear dw_container_clear( Win, Redraw ) Clears the container of all rows and frees the memory allocated with DW_container_alloc(). Win - the window identifier returned from DW_container_new() Redraw - see ContainerClearFlags No return result. DW_container_delete, ContainerClearFlags ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) ... Call dw_container_clear container, !REXXDW.!DW_DONT_REDRAW

DW_container_delete dw_container_delete( Win, NumRows ) Deletes NumRows from the the container starting with the first row. Win - the window identifier returned from DW_container_new() NumRows - the number of rows to delete No return result. DW_container_delete_row ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) ... Call dw_container_delete container, 5

DW_container_delete_row dw_container_delete_row( Win, TitleText ) Deletes the row from the container which has the specified TitleText Win - the window identifier returned from DW_container_new() TitleText - the text that was set by a call to DW_container_set_row_title() No return result. DW_container_delete, DW_container_set_row_title ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) alloc = dw_container_alloc( container, numrows ) ... Do i = 1 To numrows Call dw_container_set_row_title alloc, i-1, "Row"i End ... Call dw_container_delete_row container, "Row10"

DW_container_query_start text = dw_container_query_start( Win, Flags ) Initiates a query on a container for subsequent calls to DW_container_query_next(). Returns the title text associated with the first row in the container based on Flags. The title text having previously been set with a call to DW_container_set_row_title(). Win - the window identifier returned from DW_container_new() Flags - !REXXDW.!DW_CRA_ALL indicates that all rows in the container should be queried. !REXXDW.!DW_CRA_SELECTED indicates that only those rows that have been selected should be queried. !REXXDW.!DW_CRA_CURSORED indicates that only those items that have focus should be queried. The title text of the row or the empty string to indicate the end of the query. ie no more rows are available for querying. DW_container_query_next, DW_container_set_row_title ... container = dw_container_new( 1, !REXXDW.!DW_MULTIPLE_SELECTION ) ... selected = dw_container_query_start( container, !REXXDW.!DW_CRA_SELECTED ) Do While selected \= '' Say 'Title of row selected is' selected selected = dw_container_query_next( container, !REXXDW.!DW_CRA_SELECTED ) End

DW_container_query_next text = dw_container_query_next( Win, Flags ) Returns the title text associated with the next row in the container. The title text having previously been set with a call to DW_container_set_row_title(). Win - the window identifier returned from DW_container_new() Flags - !REXXDW.!DW_CRA_ALL indicates that all rows in the container should be queried. !REXXDW.!DW_CRA_SELECTED indicates that only those rows that have been selected should be queried. !REXXDW.!DW_CRA_CURSORED indicates that only those items that have focus should be queried. The title text of the row or the empty string to indicate the end of the query. ie no more rows are available for querying. As the only way of knowing that the query has returned all rows in subsequent calls to this function, all rows MUST have a non-blank title text. DW_container_query_start, DW_container_set_row_title ... container = dw_container_new( 1, !REXXDW.!DW_MULTIPLE_SELECTION ) ... selected = dw_container_query_start( container, !REXXDW.!DW_CRA_SELECTED ) Do While selected \= '' Say 'Title of row selected is' selected selected = dw_container_query_next( container, !REXXDW.!DW_CRA_SELECTED ) End

DW_container_cursor dw_container_cursor( Win, TitleText ) Rearranges the view of the container so that the row with the specified TitleText is visible. Win - the window identifier returned from DW_container_new() TitleText - the text that was set by a call to DW_container_set_row_title() No return result. DW_container_set_row_title ... container = dw_container_new( 1, !REXXDW.!DW_SINGLE_SELECTION ) alloc = dw_container_alloc( container, numrows ) ... Do i = 1 To numrows Call dw_container_set_row_title alloc, i-1, "Row"i End ... Call dw_container_cursor container, "Row10"

DW_container_scroll dw_container_scroll( Win, Direction, NumRows ) Scrolls the current view of the container by NumRows rows in the direction specified by Direction. Win - the window identifier returned from DW_container_new() Direction: o !REXXDW.!DW_SCROLL_TOP shows the first rows in the container o !REXXDW.!DW_SCROLL_BOTTOM shows the last rows in the container o !REXXDW.!DW_SCROLL_UP scrolls up NumRows rows o !REXXDW.!DW_SCROLL_DOWN scrolls down NumRows rows No return result. ContainerScrollFlags The NumRows argument is ignored for !REXXDW.!DW_SCROLL_TOP and !REXXDW.!DW_SCROLL_BOTTOM. ... container = dw_container_new( 1, !REXXDW.!DW_MULTIPLE_SELECTION ) ... Call dw_container_scroll( container, !REXXDW.!DW_SCROLL_UP, 10 )

A rendering widget allows low-level graphics drawing to be done. Two widget types can be rendered; a render window and a pixmap. The "normal" way to write low-level graphics is to draw into an off-screen pixmap, and then "bitblt" the off-screen pixmap into the render window. This is much faster that drawing directly into the render window itself. Two callbacks can be used with Render windows; DW_EXPOSE_EVENT and DW_CONFIGURE_EVENT. Whenever the Render window's size is changed a "configure" event is fired. Whenever a portion of the window is made visible, an "expose" event fires.

DW_render_new win = dw_render_new( Id ) Creates a new render window. A render window is used to draw primitive graphics on, or to be the window in which a pixmap is rendered. Id - a numeric identifier used to identify the window A render identifier. render = dw_render_new( 10 ) depth = dw_color_depth_get() pixmap = dw_pixmap_new( render, 64, 64, depth )

DW_pixmap_new win = dw_pixmap_new( Win, Width, Height, Depth ) Creates a new pixmap widget of the given dimensions. Win - the window identifier returned from DW_render_new() that the pixmap is associated with Width - the width of the pixmap in pixels Height - the height of the pixmap in pixels Depth - the colour depth of the pixmap as returned from DW_color_depth_get() A pixmap identifier. render = dw_render_new( 10 ) depth = dw_color_depth_get() pixmap = dw_pixmap_new( render, 64, 64, depth )

DW_pixmap_new_from_file win = dw_pixmap_new_from_file( Win, Filename ) Creates a new pixmap widget from the specified Filename. Win - the window identifier returned from DW_render_new() that the pixmap is associated with Filename - the name of a file containing a valid bitmap image (.BMP, or .XPM) A pixmap identifier. The size of the pixmap is determined from the dimensions of the .BMP or .XPM render = dw_render_new( 10 ) pixmap = dw_pixmap_new_from_file( render, '/home/mark/mypixmap' )

DW_pixmap_destroy dw_pixmap_destroy( Pixmap ) Destroys a Pixmap. Pixmap - the pixmap identifier returned from DW_pixmap_new() or DW_pixmap_new_from_file() No return result. DW_pixmap_new, DW_pixmap_new_from_file render = dw_render_new( 10 ) pixmap = dw_pixmap_new_from_file( render, '/home/mark/mypixmap' ) ... Call dw_pixmap_destroy( pixmap )

DW_pixmap_bitblt dw_pixmap_bitblt( DestWin, DestPixmap, DestX, DestY, Width, Height, SrcWin, SrcPixmap, SrcX, SrcY ) Copies a portion of a render window or pixmap to another render window or pixmap. DestWin - the destination window identifier returned from DW_render_new() DestPixmap - the destination pixmap identifier returned from DW_pixmap_new() or DW_pixmap_new_from_file() DestX - the X coordinate of the destination measured in pixels DestY - the Y coordinate of the destination measured in pixels Width - the width of the portion to copy measured in pixels Height - the height of the portion to copy measured in pixels SrcWin - the source window identifier returned from DW_render_new() SrcPixmap - the source pixmap identifier returned from DW_pixmap_new() SrcX - the X coordinate of the source measured in pixels SrcY - the Y coordinate of the source measured in pixels No return result. DW_pixmap_new, DW_pixmap_new_from_file, DW_render_new Only one of DestWin, DestPixmap is specified; the other should be 0 Only one of SrcWin, SrcPixmap is specified; the other should be 0 render = dw_render_new( 10 ) depth = dw_color_depth_get() pixmap = dw_pixmap_new( render, 64, 64, depth ) ... Call dw_pixmap_bitblt( render, 0, 0, 0, 64, 64, 0, pixmap, 0, 0 )

DW_pixmap_width width = dw_pixmap_width( Win ) returns the width of the specified pixmap. Win - the window identifier returned from DW_pixmap_new() or DW_pixmap_new_from_file() The pixmap's width DW_pixmap_height render = dw_render_new( 10 ) pixmap = dw_pixmap_new_from_file( render, '/home/mark/mypixmap' ) Say 'The width of the pixmap is' dw_pixmap_width( pixmap )

DW_pixmap_height width = dw_pixmap_height( Win ) returns the height of the specified pixmap. Win - the window identifier returned from DW_pixmap_new() or DW_pixmap_new_from_file() The pixmap's height DW_pixmap_width render = dw_render_new( 10 ) pixmap = dw_pixmap_new_from_file( render, '/home/mark/mypixmap' ) Say 'The height of the pixmap is' dw_pixmap_height( pixmap )

DW_draw_text dw_draw_text( Win, Pixmap, Fill, X, Y, Text ) Draws the specified Text at the coordinates X/Y. The colour of the Text is set by a call to DW_color_foreground_set(). The font of the text is set by a call to DW_window_set_font() against the render box in which the text is drawn eith directly, or via a pixmap. Win - the window identifier returned from DW_render_new() Pixmap - the pixmap identifier returned from DW_pixmap_new() X - the x coordinate in pixels of the top left corner Y - the y coordinate in pixels of the top left corner Text - the text to be drawn No return result DW_render_new, DW_pixmap_new, DW_color_foreground_set DW_draw_line, DW_draw_point, DW_draw_rect, RectangleFill, DW_window_set_font Only one of Win or Pixmap is required. The other argument should be set to 0. ... win = dw_render_new( 0 ) Call dw_window_set_font win, myfont ... Call dw_draw_text win, 0, 10, 34, 'A string at 10/34'

DW_draw_line dw_draw_line( Win, Pixmap, X1, Y1, X2, Y2 ) Draws a line between the coordinates X1/Y1 and X2/Y2 in either the render window identfied by Win or the pixmap identified by Pixmap. The line is 1 pixel in width and the colour of the line is set by a call to DW_color_foreground_set(). Win - the window identifier returned from DW_render_new() Pixmap - the pixmap identifier returned from DW_pixmap_new() X1 - the x coordinate in pixels of one end of the line Y1 - the y coordinate in pixels of one end of the line X2 - the x coordinate in pixels of the other end of the line Y2 - the y coordinate in pixels of the other end of the line No return result DW_render_new, DW_pixmap_new, DW_color_foreground_set, DW_draw_point, DW_draw_rect, DW_draw_text Only one of Win or Pixmap is required. The other argument should be set to 0. ... win = dw_render_new( 0 ) ... Call dw_draw_line win, 0, 10, 10, 34, 56

DW_draw_rect dw_draw_rect( Win, Pixmap, Fill, X, Y, Width, Height ) Draws a rectangle with the top left corner at the coordinates X/Y with the specified Width and Height. All measurements are in pixels. The colour of the rectangle is set by a call to DW_color_foreground_set(). Win - the window identifier returned from DW_render_new() Pixmap - the pixmap identifier returned from DW_pixmap_new() Fill - indicate if a filled or outline rectangle is drawn X - the x coordinate in pixels of the top left corner Y - the y coordinate in pixels of the top left corner Width - the width of the rectangle Height - the height of the rectangle No return result DW_render_new, DW_pixmap_new, DW_color_foreground_set DW_draw_line, DW_draw_point, DW_draw_text, RectangleFill Only one of Win or Pixmap is required. The other argument should be set to 0. ... win = dw_render_new( 0 ) ... Call dw_draw_rect win, 0, !REXXDW.!DW_FILL, 10, 34, 40, 40

DW_draw_point dw_draw_point( Win, Pixmap, X, Y ) Draws a point 1 pixel in size at the coordinates X/Y. The colour of the point is set by a call to DW_color_foreground_set(). Win - the window identifier returned from DW_render_new() Pixmap - the pixmap identifier returned from DW_pixmap_new() X - the x coordinate in pixels of the point Y - the y coordinate in pixels of the point No return result DW_render_new, DW_pixmap_new, DW_color_foreground_set DW_draw_line, DW_draw_rect, DW_draw_text Only one of Win or Pixmap is required. The other argument should be set to 0. ... win = dw_render_new( 0 ) ... Call dw_draw_point win, 0, 10, 34

Entryfields allow a user to enter a single line of text.

DW_entryfield_new win = dw_entryfield_new( CurrentText, Id ) Creates a new entryfield. An entryfield is a single line window into which text can be entered. CurrentText - the initial text to display in the entryfield Id - a numeric identifier used to identify the window A window identifier. DW_entryfield_password_new, DW_entryfield_set_limit ... entryfield = dw_entryfield_new( "Initial value", 0 )

DW_entryfield_password_new win = dw_entryfield_password_new( CurrentText, Id ) Creates a new password entryfield. A password entryfield is similar to an entryfiled, but any character displayed in the entryfield is replaced by an asterisk to mask the contents. CurrentText - the initial text to display in the entryfield Id - a numeric identifier used to identify the window A window identifier. DW_entryfield_new, DW_entryfield_set_limit ... entryfield = dw_entryfield_password_new( "mypassword", 0 )

DW_entryfield_set_limit dw_entryfield_set_limit( Win, Length ) Sets the maximum number of characters that can be entered into an entryfield. Win - the window identifier returned from DW_entryfield_new() or DW_entryfield_password_new() Length - the maximum number of characters allowed No return result. DW_entryfield_new, DW_entryfield_password_new ... entryfield = dw_entryfield_password_new( "mypassword", 0 ) Call dw_entryfield_set_limit entryfield, 10

Listboxes provide a list of selectable items. A combobox is a listbox plus an entry field.

DW_listbox_new win = dw_listbox_new( Id, Selection ) Creates a new listbox. A listbox contains a list of item values. Id - a numeric identifier used to identify the window Selection - indicates if one or more items are selectable at once A window identifier. DW_combobox_new, ListboxSelection ... listbox = dw_listbox_new( 10, !REXXDW.!DW_LB_SINGLE_SELECTION )

DW_combobox_new win = dw_combobox_new( ComboboxText, Id ) Creates a new combobox. A combobox contains a single line text entry field plus a selectable item from a list of pre set item values. ButtonText - the text to display as the default value of the combobox Id - a numeric identifier used to identify the window A window identifier. DW_listbox_new ... combobox = dw_combobox_new( "Default", 0 )

DW_listbox_selector_new win = dw_listbox_selector_new( LeftHeading, RightHeading, Width, Height, ValueArray, SetArray ) Creates a new Listbox Selector widget. A Listbox Selector widget provides two listboxes side-by-side with buttons to move items from one listbox to another. LeftHeading - the text to appear above the left Listbox RightHeading - the text to appear above the right Listbox Width - the minumum width of the Listboxes Height - the minumum height of the Listboxes ValueArray - an array containing the text to be displayed in the Listboxes SetArray - an array specifying which values in ValueArray are displayed in which Listbox A window identifier, which is actually a Box widget suitable for packing. The ValueArray is a Rexx "array" containing the items that are to be displayed in the Listboxes. The SetArray is a Rexx "array" with values set to 1 or 0. When creating the Listbox Selector, if an item in the SetArray has a value of 1 the corresponding item in the ValueArray is displayed in the left Listbox. When an item is moved from the left Listbox to the right Listbox, the corresponding item in the SetArray is set to 1. When an item is moved from the right Listbox to the left Listbox, the corresponding item in the SetArray is set to 0. The ValueArray and SetArray stem variable names should be global, so that they can be referenced inside RexxDW callbacks. value.0 = 3 value.1 = 'line 1' value.2 = 'line 2' value.3 = 'line 3' ind.0 = 3 ind.1 = 1 ind.2 = 1 ind.3 = 0 ls = dw_listbox_selector_new( 'Selected', 'Available', 100, 200, 'value.', 'ind.' ) ... Do i = 1 To value.0 If ind.i = 1 Then Say 'Value:' value.i 'has been selected' End

DW_listbox_append dw_listbox_append( Win, Text ) Appends the specified Text to the end of the current items in the listbox or combobox specified by Win. Win - the window identifier returned from DW_listbox_new() or DW_combobox_new Text - the text of the item to append to the list No return result. listbox = dw_listbox_new( 0, !REXXDW.!DW_LB_SINGLE_SELECTION ) Do i = 1 To 5 Call dw_listbox_append listbox, text.i End

DW_listbox_list_append dw_listbox_list_append( Win, TextArray ) Appends each item in the specified TextArray to the end of the current items in the listbox or combobox specified by Win. Win - the window identifier returned from DW_listbox_new() or DW_combobox_new TextArray - an array containing text of the items to append to the list No return result. listbox = dw_listbox_new( 0, !REXXDW.!DW_LB_SINGLE_SELECTION ) text.0 = 3 text.1 = 'line 1' text.2 = 'line 2' text.3 = 'line 3' Call dw_listbox_list_append listbox, 'text.'

DW_listbox_clear dw_listbox_clear( Win ) Removes all items from the listbox or combobox specified by Win. Win - the window identifier returned from DW_listbox_new() or DW_combobox_new No return result. DW_listbox_delete listbox = dw_listbox_new( 0, !REXXDW.!DW_LB_SINGLE_SELECTION ) Do i = 1 To 5 Call dw_listbox_append listbox, text.i End ... Call dw_listbox_clear( listbox )

DW_listbox_count count = dw_listbox_count( Win ) Returns the number of items in the listbox or combobox specified by Win. Win - the window identifier returned from DW_listbox_new() or DW_combobox_new The number of items in the list. combobox = dw_combobox_new( "Default", 0 ) Do i = 1 To 5 Call dw_listbox_append combobox, text.i End Say 'There are' dw_listbox_count( combobox ) 'items in the list'

DW_listbox_delete dw_listbox_delete( Win, Index ) Deletes the item specified by Index from the list of items in the listbox or combobox specified by Win. Win - the window identifier returned from DW_listbox_new() or DW_combobox_new Index - the 0 based index of the item to delete No return result. DW_listbox_clear combobox = dw_combobox_new( "Default", 0 ) Do i = 1 To 5 Call dw_listbox_append combobox, text.i End ... Call dw_listbox_delete combobox, 4

DW_listbox_select dw_listbox_select( Win, Index, State ) Sets the State of the item specified by Index in the list of items in the listbox or combobox specified by Win. Win - the window identifier returned from DW_listbox_new() or DW_combobox_new Index - the 0 based index of the item to change its state State - indicates whether the item is to be selected or not No return result. DW_listbox_selected, ListboxSelected If the listbox was created with DW_LB_SINGLE_SELECTION, then setting an item to be selected will unselect an item that is currently selected. If the listbox was created with DW_LB_MULTIPLE_SELECTION, then setting an item to be selected will leave any other item already selected alone. listbox = dw_listbox_new( 10, !REXXDW.!DW_LB_SINGLE_SELECTION ) Do i = 1 To 5 Call dw_listbox_append listbox, text.i End ... Call dw_listbox_select listbox, 4, !REXXDW.!DW_LB_SELECTED

DW_listbox_selected index = dw_listbox_selected( Win ) Returns the index of the item in the listbox or combobox currently selected or !REXXDW.!DW_LB_NONE if none selected. Win - the window identifier returned from DW_listbox_new() or DW_combobox_new The 0 based index of the item selected. ListboxReturn, DW_listbox_select, DW_listbox_selected_multi listbox = dw_listbox_new( 10, !REXXDW.!DW_LB_SINGLE_SELECTION ) Do i = 1 To 5 Call dw_listbox_append listbox, text.i End ... Call dw_listbox_select listbox, 4, !REXXDW.!DW_LB_SELECTED ... Say 'Item' dw_listbox_selected( listbox ) 'is currently selected'

DW_listbox_selected_multi index = dw_listbox_selected_multi( Win, Start ) Returns the index of the next item in the listbox currently selected or !REXXDW.!DW_LB_NONE if none selected. Win - the window identifier returned from DW_listbox_new() Start - the index to start looking from The 0 based index of the next item selected. ListboxReturn, DW_listbox_select, DW_listbox_selected This call only works on listboxes created with DW_LB_MULTIPLE_SELECTION; and not on comboboxes. The first call should use -1 as Start, and on subsequent calls, the index returned from the previous call. listbox = dw_listbox_new( 10, !REXXDW.!DW_LB_MULTIPLE_SELECTION ) Do i = 1 To 5 Call dw_listbox_append listbox, text.i End ... Call dw_listbox_select listbox, 2, !REXXDW.!DW_LB_SELECTED Call dw_listbox_select listbox, 4, !REXXDW.!DW_LB_SELECTED ... idx = -1 Do Forever idx = dw_listbox_selected_multi( listbox, idx ) If idx = !REXXDW.!DW_LB_NONE Then Leave Say 'Item' idx 'is currently selected' End

DW_listbox_set_top dw_listbox_set_top( Win, Index ) Sets the item with Index to be the first item displayed in the viewport of the listbox. Win - the window identifier returned from DW_listbox_new() Index - the 0 based index of the item to display at the top of the viewport No return result. This does not work on comboboxes. listbox = dw_listbox_new( 10, !REXXDW.!DW_LB_SINGLE_SELECTION ) Do i = 1 To 5 Call dw_listbox_append listbox, text.i End ... Call dw_listbox_set_top listbox, 4

DW_listbox_set_text dw_listbox_set_text( Win, Index, Text ) Sets the Text of the Index item in the listbox or combobox Win - the window identifier returned from DW_listbox_new() or DW_combobox_new Index - the 0 based index of the item to change its text Text - the new text of the item No return result. DW_listbox_append listbox = dw_listbox_new( 10, !REXXDW.!DW_LB_SINGLE_SELECTION ) Do i = 1 To 5 Call dw_listbox_append listbox, text.i End ... Call dw_listbox_set_text listbox, 4, 'New Text'

DW_listbox_get_text text = dw_listbox_get_text( Win, Index ) Returns the text of the item with Index in the listbox or combobox Win - the window identifier returned from DW_listbox_new() or DW_combobox_new Index - 0 based index into the list of items for which the text is required The text of the item. combobox = dw_combobox_new( "Default", 0 ) Do i = 1 To 5 Call dw_listbox_append combobox, text.i End Say 'Item 3 is' dw_listbox_get_text( combobox, 3 )

Menus provide a list of textual options to the user to select an action. RexxDW provides standard drop-down menus located directly under the window's titlebar, or floating popup menus.

DW_menu_new win = dw_menu_new( Id ) Creates a new menu. This menu can be used as a submenu linked to a menubar, or as a popup menu. Id - a numeric identifier used to identify the window A window identifier. DW_menubar_new ... menu = dw_menu_new( 10 )

DW_menubar_new win = dw_menubar_new( Win ) Creates a new menubar. A menubar is located at the top of the specified toplevel window identified by Win. Win - a window identifier returned from a call to DW_window_new(). A menubar identifier. DW_menu_new, DW_window_new Currently under GTK+ you need to call this function AFTER other widgets have been created in the window that this menubar is to reside. ... win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Window on desktop', style ) ... menubar = dw_menubar_new( win )

DW_menu_append_item index = DW_menu_append_item( Menu, Title, Id, Flags, End, Check, Submenu ) Append a menu item to an existing menu or menubar. The menu item can be an individual item or another submenu. Menu - the menu identifier returned from DW_menu_new() or DW_menubar_new() Title - the text of the menu item Id - a numeric identifier used to identify the menu item Flags - effectively ignored End - indicates if the menu item appears at the start or end of the existing list. One of DW_MENU_START or DW_MENU_END Check - indicates if the menu item is checkable or not one of DW_MENU_CHECKABLE or DW_MENU_NOT_CHECKABLE Submenu - a menu identifier returned from a a call to DW_menu_new() A menu identifier. DW_menu_new, DW_menubar_new, MenuConstants Preceding a letter of the Title, will enable that letter to be typed on the keyboard to invoke the callback associated with that menu item. In the source below, with the menu item displayed, typing 'a' will execute 'AddRepositoryCallback' The Title can also be set to DW_MENU_SEPARATOR which will display a line instead of text. A menu item MUST have a unique Id within a particular menu, otherwise the callbacks will not work. menu = dw_menu_new( 0 ) menuitem = dw_menu_append_item( menu, '~Add Repository', 1011, 0, , !REXXDW.!DW_MENU_END, !REXXDW.!DW_MENU_NOT_CHECKABLE, 0 ) Call dw_signal_connect menuitem, !REXXDW.!DW_CLICKED_EVENT, , 'AddRepositoryCallback'

DW_menu_delete_item DW_menu_delete_item( Menu, Id ) Deletes a menu item from an existing menu or menubar. The menu item can be an individual item or another submenu. Menu - the menu identifier returned from DW_menu_new() or DW_menubar_new() Id - a numeric identifier used to identify the menu item No return result. DW_menu_new, DW_menubar_new, DW_menu_append_item, MenuConstants menu = dw_menu_new( 0 ) menuitem = dw_menu_delete_item( menu, '~Add Repository', 1011, 0, , !REXXDW.!DW_MENU_END, !REXXDW.!DW_MENU_NOT_CHECKABLE, 0 ) Call dw_signal_connect menuitem, !REXXDW.!DW_CLICKED_EVENT, , 'AddRepositoryCallback' ... Call dw_menu_delete_item, menu, 1011

DW_menu_destroy DW_menu_destroy( Menu ) Destroys a menu or menubar. Menu - the menu identifier returned from DW_menu_new() or DW_menubar_new() No return result. DW_menu_new, DW_menubar_new menu = dw_menu_new( 0 ) ... Call dw_menu_destroy menu ...

DW_menu_item_set_check DW_menu_item_set_check( Menu, Id, Check ) Sets the menu item identified by Id to checked or unchecked depending on the value of Check. Menu - the menu identifier returned from DW_menu_new() or DW_menubar_new() Id - a numeric identifier used to identify the menu Check - indicates if the menu item is checkable or not one of DW_MENU_CHECKABLE or DW_MENU_NOT_CHECKABLE No return result. DW_menu_new, MenuConstants menu = dw_menu_new( 0 ) menuitem = dw_menu_append_item( menu, '~Add Repository', 1011, 0, , !REXXDW.!DW_MENU_END, !REXXDW.!DW_MENU_NOT_CHECKABLE, 0 ) ... Call dw_menu_item_set_check menu, 1011, !REXXDW.!DW_MENU_CHECKABLE

DW_menu_popup DW_menu_popup( Menu, Win, X, Y ) Displays the popup Menu in the specified window at the location specified by X/Y in pixels relative to ?????. Menu - the menu identifier returned from DW_menu_new() Win - the window identifier returned from various functions that return a window identifier X - the X coordinate where the top left corner of the menu will appear Y - the Y coordinate where the top left corner of the menu will appear No return result. DW_menu_new The popup menu associated with the Menu identifier is destroyed each time DW_menu_popup() is called. menu = dw_menu_new( 0 ) menuitem = dw_menu_append_item( menu, '~Add Repository', 1011, 0, , !REXXDW.!DW_MENU_END, !REXXDW.!DW_MENU_NOT_CHECKABLE, 0 ) ... Call dw_menu_popup menu, win, 30, 130

A multi-line edit widget is similar to an Entryfield, except that more than one line of text can be manipulated.

DW_mle_new win = dw_mle_new( Id ) Creates a new Multi-Line edit widget. An MLE is used to display and edit multiple lines of text. Id - a numeric identifier used to identify the window An MLE identifier. mle = dw_mle_new( 0 )

DW_mle_delete dw_mle_delete( Win[, StartPoint, Length] ) Deletes the text from a Multi-Line Entry widget starting at StartPoint for Length characters Win - the window identifier returned from DW_mle_new() StartPoint - 0 based offset into the MLE counted in characters Length - the number of characters to delete No return result. If no Startpoint is specified, it defaults to 0 (the start of the MLE) If no Length is specified, it defaults to the total number of characters in the MLE. ... mle = dw_mle_new( 0 ) ... Call dw_mle_delete( mle, 0, 100 )

DW_mle_import Location = dw_mle_import( Win, Text, StartPoint ) Inserts the Text into a Multi-Line Entry widget starting at StartPoint. Win - the window identifier returned from DW_mle_new() Text - the text to insert into the MLE StartPoint - 0 based offset into the MLE counted in characters The point into the MLE after the last character in Text was inserted counted in characters. DW_mle_export You need to append a CRLF ('0d0a'x) to the end of text to insert lines. The first call to dw_mle_import() must specify -1 as StartPoint. ... mle = dw_mle_new( 0 ) ... eol = '0d0a'x loc = -1 Do i = 1 To 10 loc = dw_mle_import( mle, 'Inserting line' i 'here'||eol, loc ) End ...

DW_mle_export text = dw_mle_export( Win[, StartPoint, Length] ) Returns the text from a Multi-Line Entry widget starting at StartPoint for Length characters. Win - the window identifier returned from DW_mle_new() StartPoint - 0 based offset into the MLE counted in characters Length - the number of characters to export The text exported. DW_mle_import If no Startpoint is specified, it defaults to 0 (the start of the MLE) If no Length is specified, it defaults to the total number of characters in the MLE. ... mle = dw_mle_new( 0 ) ... contents = dw_mle_export( mle, 0, 100 )

DW_mle_get_size Bytes Lines = dw_mle_get_size( Win ) Returns the number of Bytes and Lines currently in the Multi-Line Entry widget. Win - the window identifier returned from DW_mle_new() Bytes and Lines are returned as two words. PARSE VALUE is the easiest way to obtain both values. DW_mle_new ... mle = dw_mle_new( 0 ) ... Parse Value dw_mle_get_size( mle ) With bytes lines

DW_mle_search Location = dw_mle_search( Win, Text, StartPoint, SearchFlags ) Searches the MLE for Text starting at StartPoint. Win - the window identifier returned from DW_mle_new() Text - the text to search for in the MLE StartPoint - 0 based offset into the MLE counted in characters SearchFlags- optional flag to search respecting case if set to DW_MLE_CASESENSITIVE. default is to search irrespective of case The point into the MLE where the matching Text starts counted in characters. MLESearchFlags ... mle = dw_mle_new( 0 ) ... loc = dw_mle_import( mle, 'More text here', 100 ) ... pos = dw_mle_search( mle, 'text', 0, 0 )

DW_mle_set_curesor dw_mle_set_cursor( Win, Point ) Sets the cursor at Point in the Multi-Line Entry widget. Win - the window identifier returned from DW_mle_new() Point - the character at which to display the cursor in the MLE No return result. ... mle = dw_mle_new( 0 ) ... Call dw_mle_set_cursor( mle, 10 )

DW_mle_set_editable dw_mle_set_editable( Win, EditableFlags ) Sets the state of the Multi-Line Entry widget to be editable or readonly. Win - the window identifier returned from DW_mle_new() EditableFlags - one of DW_EDITABLE or DW_READONLY No return result. MLEEditableFlags By default MLEs are editable ... mle = dw_mle_new( 0 ) ... Call dw_mle_set_editable( mle, !REXXDW.!DW_READONLY )

DW_mle_set_visible dw_mle_set_visible( Win, Line ) Sets the Line in the Multi-Line Entry widget to be visible. Win - the window identifier returned from DW_mle_new() Line - the Line in the MLE to be visible No return result. ... mle = dw_mle_new( 0 ) ... Call dw_mle_set_visible( mle, 10 )

DW_mle_set_word_wrap dw_mle_set_editable( Win, WordWrapFlags ) Sets the state of the Multi-Line Entry widget to allow lines to wrap on word boundaries or be truncated at the edge of the viewport. Win - the window identifier returned from DW_mle_new() WordWrapFlags - one of DW_WORD_WRAP or DW_DONT_WORD_WRAP No return result. MLEWordWrapFlags ... mle = dw_mle_new( 0 ) ... Call dw_mle_set_word_wrap( mle, !REXXDW.!DW_WORD_WRAP )

DW_mle_freeze dw_mle_freeze( Win ) Stops the screen output to a Multi-Line Entry widget. Win - the window identifier returned from DW_mle_new() No return result. DW_mle_thaw On some platforms, there can be excessive scrolling and redraws when text is imported into an MLE. This function reduces these effects. ... mle = dw_mle_new( 0 ) ... Call dw_mle_freeze( mle ) loc = -1 Do i = 1 To text.0 loc = dw_mle_import( mle, text.i, loc ) End Call dw_mle_thaw( mle )

DW_mle_thaw dw_mle_thaw( Win ) Restarts the screen output to a Multi-Line Entry widget. Win - the window identifier returned from DW_mle_new() No return result. DW_mle_freeze On some platforms, there can be excessive scrolling and redraws when text is imported into an MLE. This function reduces these effects. ... mle = dw_mle_new( 0 ) ... Call dw_mle_freeze( mle ) loc = -1 Do i = 1 To text.0 loc = dw_mle_import( mle, text.i, loc ) End Call dw_mle_thaw( mle )

Strictly speaking these widgets are "tabbed notebooks". This widget provides another sort of frame in which other widgets are packed. Notebook pages are frames that overlap the same screen space, but can be brought to the front by the user clicking on the tab.

DW_notebook_new win = dw_notebook_new( Id, TabLocation ) Creates a new tabbed notebook widget. A notebook is a frame in which pages containing other widgets can be packed. Each page can be selected by clicking that page's tab. Id - a numeric identifier used to identify the window TabLocation- indicates if the tabs appear across the top or bottom A notebook identifier. NotebookTabLocation notebook = dw_notebook_new( 0, !REXXDW.!DW_TAB_TO_TOP )

DW_notebook_page_new page = dw_notebook_page_new( Win, Flags, PageLocation ) Creates a new page within a tabbed notebook widget. Win - the window identifier returned from DW_notebook_new() Flags - ignored PageLocation - indicates if the tabs appear across the top or bottom A notebook page identifier. DW_notebook_new, NotebookPageLocation A maximum of 256 pages can be created in a notebook. On Windows, the PageLocation does nothing, so it is best to specify which page is in front once all pages have been created by calling DW_notebook_page_set(). notebook = dw_notebook_new( 0, !REXXDW.!DW_TAB_TO_TOP ) notebookbox = dw_box_new( !REXXDW.!DW_VERT, 0 ) notebookpage = dw_notebook_page_new( notebook, 0, !REXXDW.!DW_PAGE_TO_BACK ) Call dw_notebook_pack notebook, notebookpage, notebookpagebox

DW_notebook_pack dw_notebook_pack( Win, Page, Box ) Packs a generic box into a page in the notebook. Win - the window identifier returned from DW_notebook_new() Page - the page identifier returned from DW_notebook_page_new() Box - the box identifier returned from a DW_box_new() or DW_groupbox_new() No return result. DW_notebook_new, DW_notebook_page_new notebook = dw_notebook_new( 0, !REXXDW.!DW_TAB_TO_TOP ) notebookbox = dw_box_new( !REXXDW.!DW_VERT, 0 ) notebookpage = dw_notebook_page_new( notebook, 0, !REXXDW.!DW_PAGE_TO_BACK ) Call dw_notebook_pack notebook, notebookpage, notebookpagebox

DW_notebook_destroy dw_notebook_destroy( Win, Page ) Destroys the specified Page of a notebook. All widgets inside the Page are also destroyed. Win - the window identifier returned from DW_notebook_new() Page - the page identifier returned from DW_notebook_page_new() No return result. DW_notebook_new, DW_notebook_page_new notebook = dw_notebook_new( 0, !REXXDW.!DW_TAB_TO_TOP ) notebookbox = dw_box_new( !REXXDW.!DW_VERT, 0 ) notebookpage = dw_notebook_page_new( notebook, 0, !REXXDW.!DW_PAGE_TO_BACK ) Call dw_notebook_pack notebook, notebookpage, notebookpagebox ... Call dw_notebook_destoy notebook, notebookpage

DW_notebook_page_set dw_notebook_page_set( Win, Page ) Sets Page to be the notebook page displayed at the front. Win - the window identifier returned from DW_notebook_new() Page - the page identifier returned from DW_notebook_page_new() No return result. DW_notebook_new, DW_notebook_page_get notebook = dw_notebook_new( 0, !REXXDW.!DW_TAB_TO_TOP ) notebookbox = dw_box_new( !REXXDW.!DW_VERT, 0 ) notebookpage = dw_notebook_page_new( notebook, 0, !REXXDW.!DW_PAGE_TO_BACK ) Call dw_notebook_pack notebook, notebookpage, notebookpagebox ... Call dw_notebook_page_set notebook, notebookpage

DW_notebook_page_set_text dw_notebook_page_set_text( Win, Page, Text ) Sets the text on the notebook tab on the Page to Text. Win - the window identifier returned from DW_notebook_new() Page - the page identifier returned from DW_notebook_page_new() Text - the text to display on the tab No return result. notebook = dw_notebook_new( 0, !REXXDW.!DW_TAB_TO_TOP ) notebookbox = dw_box_new( !REXXDW.!DW_VERT, 0 ) notebookpage = dw_notebook_page_new( notebook, 0, !REXXDW.!DW_PAGE_TO_BACK ) Call dw_notebook_pack notebook, notebookpage, notebookpagebox ... Call dw_notebook_page_set_text notebook, notebookpage, 'Tab Text'

DW_notebook_page_set_status_text dw_notebook_page_set_status_text( Win, Page, Text ) Sets the status text area on the Page to Text. Win - the window identifier returned from DW_notebook_new() Page - the page identifier returned from DW_notebook_page_new() Text - the text to display in the status text area No return result. Only OS/2 has a status text area. Other platforms ignore this function. notebook = dw_notebook_new( 0, !REXXDW.!DW_TAB_TO_TOP ) notebookbox = dw_box_new( !REXXDW.!DW_VERT, 0 ) notebookpage = dw_notebook_page_new( notebook, 0, !REXXDW.!DW_PAGE_TO_BACK ) Call dw_notebook_pack notebook, notebookpage, notebookpagebox ... Call dw_notebook_page_set_status_text notebook, notebookpage, 'Subtitle Text'

DW_notebook_page_get page = dw_notebook_page_get( Win, Flags, PageLocation ) Return the page identifier of the notebook page currently at the front. Win - the window identifier returned from DW_notebook_new() A notebook page identifier. DW_notebook_new, DW_notebook_page_set notebook = dw_notebook_new( 0, !REXXDW.!DW_TAB_TO_TOP ) notebookbox = dw_box_new( !REXXDW.!DW_VERT, 0 ) notebookpage = dw_notebook_page_new( notebook, 0, !REXXDW.!DW_PAGE_TO_BACK ) Call dw_notebook_pack notebook, notebookpage, notebookpagebox ... Say 'The pageid of the notebook is:' dw_notebook_page_get( notebook )

A Percent widget is simply a progress bar. Under OS/2 only 1 instance of a percent or slider widget can exist within the same box. So for complete portability, all percent and slider widgets should be enclosed in their own box.

DW_percent_new win = dw_percent_new( Id ) Creates a new percent progress status bar widget. Id - a numeric identifier used to identify the window A percent progress status bar identifier. percent = dw_percent_new( 0 )

DW_percent_set_pos dw_percent_set_pos( Win, Position ) Sets the current position of the percent bar to Position. Win - the window identifier returned from DW_percent_new() Position - the position of the bar as a whole number percentage No return result. percent = dw_percent_new( 0 ) ... now = (bytes_sent*100) % total_bytes Call dw_percent_set_pos percent, now

A Scrollbar widget is used in conjunction with other widgets that are not by default scrollable, to allow details that are not completely visible in a window to be viewable by scrolling. Both horizontal and vertical scrollbars are supported.

DW_scrollbar_new win = dw_scrollbar_new( Orientation, Id ) Creates a new scrollbar. A scrollbar is used to scroll various other widgets like Multi-Line edit windows or listboxes. Orientation- !REXXDW.!DW_VERT to indicate a vertical scrollbar !REXXDW.!DW_HORZ to indicate a horizontal scrollbar Id - a numeric identifier used to identify the window A scrollbar identifier. vscrollbar = dw_scrollbar_new( !REXXDW.!DW_VERT, 0 )

DW_scrollbar_set_range dw_scrollbar_set_range( Win, Range, Thumbwidth ) Sets the maximum value and width of the scrollbar thumb of the scrollbar. Win - the window identifier returned from DW_scrollbar_new() Range - the maximum range of the scrollbar Thumbwidth - the width of the scrollbar's thumb No return result. vscrollbar = dw_scrollbar_new( !REXXDW.!DW_VERT, 0 ) Call dw_scrollbar_set_range vscrollbar, 200, 40 ... Call dw_scrollbar_set_pos vscrollbar, 150 ... Say 'The scrollbar is at' dw_scrollbar_get_pos( vscrollbar )

DW_scrollbar_set_pos dw_scrollbar_set_pos( Win, Position ) Sets the position of the scrollbar. Win - the window identifier returned from DW_scrollbar_new() Position - the position within the scrollbar's range No return result. DW_scrollbar_get_pos vscrollbar = dw_scrollbar_new( !REXXDW.!DW_VERT, 0 ) Call dw_scrollbar_set_range vscrollbar, 200, 40 ... Call dw_scrollbar_set_pos vscrollbar, 150 ... Say 'The scrollbar is at' dw_scrollbar_get_pos( vscrollbar )

DW_scrollbar_get_pos pos = dw_scrollbar_get_pos( Win ) Returns the current position of the scrollbar. Win - the window identifier returned from DW_scrollbar_new() The position of the scrollbar. DW_scrollbar_set_pos vscrollbar = dw_scrollbar_new( !REXXDW.!DW_VERT, 0 ) Call dw_scrollbar_set_range vscrollbar, 200, 40 Say 'The scrollbar is at' dw_scrollbar_get_pos( vscrollbar )

A Slider widget is similar to a Scrollbar, but it allows the user to select a numeric value by dragging a thumb until the desired numeric value is reached. Under OS/2 only 1 instance of a percent or slider widget can exist within the same box. So for complete portability, all percent and slider widgets should be enclosed in their own box.

DW_slider_new win = dw_slider_new( Orientation, Range, Id ) Creates a new slider. A slider provides a widget for selecting a numeric values from a range. Orientation- !REXXDW.!DW_VERT to indicate a vertical scrollbar !REXXDW.!DW_HORZ to indicate a horizontal scrollbar Range - the maximum number of the numeric range Id - a numeric identifier used to identify the window A slider identifier. slider = dw_slider_new( !REXXDW.!DW_VERT, 100, 0 )

DW_slider_set_pos dw_slider_set_pos( Win, Position ) Sets the position of the slider. Win - the window identifier returned from DW_slider_new() Position - the position within the slider's range No return result. DW_slider_get_pos vslider = dw_slider_new( !REXXDW.!DW_VERT, 100, 0 ) ... Call dw_slider_set_pos vslider, 50 ... Say 'The slider is at' dw_slider_get_pos( vslider )

DW_slider_get_pos pos = dw_slider_get_pos( Win ) Returns the current position of the slider. Win - the window identifier returned from DW_slider_new() The position of the slider. DW_slider_set_pos vslider = dw_slider_new( !REXXDW.!DW_VERT, 100, 0 ) Say 'The slider is at' dw_slider_get_pos( vslider )

A Spinbutton widget is similar to a Slider, but the user selects a numeric value by clicking an up or down arrow, or by manually entering the value into an entry field. A Spinbutton will wrap around at each end of its value limits.

DW_spinbutton_new win = dw_spinbutton_new( Text, Id ) Creates a new spinbutton. A spinbutton provides a widget for selecting a numeric values from a range or by manually entering a value. Text - the text describing the spinbutton Id - a numeric identifier used to identify the window A spinbutton identifier. spinbutton = dw_spinbutton_new( 'Select Number', 0 )

DW_spinbutton_set_limits dw_spinbutton_set_limits( Win, Upper, Lower ) Sets the maximum and minimum values the spinbutton can support. Win - the window identifier returned from DW_spinbutton_new() Upper - the maximum number of the spinbutton Lower - the minimum number of the spinbutton No return result. DW_spinbutton_set_pos, DW_spinbutton_get_pos spinbutton = dw_spinbutton_new( 'Select Number', 0 ) Call dw_spinbutton_set_limits spinbutton, 200, 40 ... Call dw_spinbutton_set_pos spinbutton, 150 ... Say 'The spinbutton is at' dw_spinbutton_get_pos( spinbutton )

DW_spinbutton_set_pos dw_spinbutton_set_pos( Win, Position ) Sets the position of the spinbutton. Win - the window identifier returned from DW_spinbutton_new() Position - the position within the spinbutton's range No return result. DW_spinbutton_get_pos spinbutton = dw_spinbutton_new( 'Select Number', 0 ) Call dw_spinbutton_set_limits spinbutton, 200, 40 ... Call dw_spinbutton_set_pos spinbutton, 50 ... Say 'The spinbutton is at' dw_spinbutton_get_pos( spinbutton )

DW_spinbutton_get_pos pos = dw_spinbutton_get_pos( Win ) Returns the current position of the spinbutton. Win - the window identifier returned from DW_spinbutton_new() The position of the spinbutton. DW_spinbutton_set_pos spinbutton = dw_spinbutton_new( 'Select Number', 0 ) Call dw_spinbutton_set_limits spinbutton, 200, 40 ... Call dw_spinbutton_set_pos spinbutton, 150 ... Say 'The spinbutton is at' dw_spinbutton_get_pos( spinbutton )

A Splitbar is another frame in which other widgets are packed. The Splitbar consists of two halves and a divider, which can be dragged by the user to resize each side of the splitbar. The widgets within each side of the Splitbar are automatically resized.

DW_splitbar_new win = dw_splitbar_new( Orientation, FirstBox, SecondBox, Id ) Creates a new splitbar. A splitbar provides a widget for packing two boxes which can be dynamically resized by the user. This function also packs the boxes. Orientation- !REXXDW.!DW_VERT to indicate a vertical box !REXXDW.!DW_HORZ to indicate a horizontal box FirstBox - the box to pack into the left or top half of the splitbar SecondBox - the box to pack into the right or bottom half of the splitbar Id - a numeric identifier used to identify the window A splitbar identifier. WidgetOrientation splitbar = dw_splitbar_new( !REXXDW.!DW_HORZ, box1, box2, 0 ) Call dw_splitbar_set splitbar, 40.0

DW_splitbar_set dw_splitbar_set( Win, Percent ) Sets the relative sizes of the halves of the splitbar, by setting the percentage of the left or top half. Win - the window identifier returned from DW_splitbar_new() Percent - the relative size of the left or top half of the splitbar No return result. splitbar = dw_splitbar_new( !REXXDW.!DW_HORZ, box1, box2, 0 ) Call dw_splitbar_set splitbar, 40.0

DW_splitbat_get perc = dw_splitbar_get( Win ) Returns the current percentage that the first half of the splitbar occupies. Win - the window identifier returned from DW_splitbar_new() The percentage of the first half of the splitbar. DW_splitbar_new, DW_splitbar_set splitbar = dw_splitbar_new( !REXXDW.!DW_HORZ, box1, box2, 0 ) Call dw_splitbar_set splitbar, 40.0 ... Say 'The splitbar percentage is' dw_splitbar_get( splitbar )

StaticText widgets simply display static text.

DW_text_new win = dw_text_new( Text, Id ) Creates a new text window. A text window is a readonly window containing text. Text - the text to appear in the window Id - a numeric identifier used to identify the window A text window identifier. DW_status_text_new text = dw_text_new( 'This is Rexx/DW', 0 )

DW_status_text_new win = dw_status_text_new( Text, Id ) Creates a new status text window. A status text window is a readonly window containing text with a sunken appearence. Text - the text to appear in the window Id - a numeric identifier used to identify the window A status text window identifier. DW_text_new stext = dw_status_text_new( 'The current status is' status, 0 )

A Tree widget provides a hierachical display of items. Paricularly suited to a filesystem display.

DW_tree_new win = dw_tree_new( Id ) Creates a new tree widget. A tree widget allows the user to display a hierarchy in a tree format. Id - a numeric identifier used to identify the window A tree identifier. tree = dw_tree_new( 0 ) Do i = 1 To text.0 item.i = dw_tree_insert_after( tree, topitem, Word( text.i ), , fileicon, parent, 'item'i ) End

DW_tree_insert data = dw_tree_insert( Win, Title[, Icon[, ParentItem[, ItemData]]] ) Inserts the tree item into the Tree at the end of any other items in the Tree with the same ParentItem. Intended to be used when populating and empty Tree Win - the window identifier returned from DW_tree_new() Title - the text to appear next to the item Icon - the icon identifier returned from DW_icon_load_from_file() to appear with the item ParentItem - the item identifier returned from DW_tree_insert() under which this item is to appear ItemData - The user data that is passed to the callback as ItemData argument A tree item identifier. DW_tree_new, DW_tree_insert_after tree = dw_tree_new( 0 ) Do i = 1 To text.0 item.i = dw_tree_insert( tree, Word( text.i ), fileicon, parent, , 'item'i ) End

DW_tree_insert_after data = dw_tree_insert_after( Win, Item, Title[, Icon[, ParentItem[, ItemData]]] ) Inserts the tree item into an existing Tree physically after the item specified in Item and at the level identified by ParentItem Win - the window identifier returned from DW_tree_new() Item - the item in the tree where this item is to follow Title - the text to appear next to the item Icon - the icon identifier returned from DW_icon_load_from_file() to appear with the item ParentItem - the item identifier returned from a previous call to DW_tree_insert_after() or DW_tree_insert() If not specified, the item will be added at the top level. ItemData - The user data that is passed to the callback as ItemData argument A tree item identifier. DW_tree_new, DW_tree_insert tree = dw_tree_new( 0 ) topitem = dw_tree_insert( tree, 'Parent' ) Do i = 1 To text.0 item.i = dw_tree_insert( tree, topitem, Word( text.i ), fileicon, , parent, 'item'i ) End ... Call dw_tree_insert_after( tree, item.5, "New Item", fileicon, item.3 )

DW_tree_clear dw_tree_clear( Win ) Removes all items from a tree widget. Win - the window identifier returned from DW_tree_new() No return result. DW_tree_new, DW_tree_item_delete tree = dw_tree_new( 0 ) ... Call dw_tree_clear tree

DW_tree_item_delete dw_tree_item_delete( Win, Item ) Deletes the specified Item in the tree. If the item is a parent item then all child items under it are also deleted. (Is this true???) Win - the window identifier returned from DW_tree_new() Item - the item identifier returned from DW_tree_insert() or DW_tree_insert_after() No return result. DW_tree_new, DW_tree_insert, DW_tree_insert_after tree = dw_tree_new( 0 ) Do i = 1 To text.0 item.i = dw_tree_insert( tree, Word( text.i ), fileicon ) End ... Call dw_tree_item_delete tree, item.5

DW_tree_item_collapse dw_tree_item_collapse( Win, Item ) Collapses the specified Item in the tree. Win - the window identifier returned from DW_tree_new() Item - the item identifier returned from DW_tree_insert() or DW_tree_insert_after() No return result. DW_tree_new, DW_tree_insert, DW_tree_insert_after, DW_tree_item_expand tree = dw_tree_new( 0 ) Do i = 1 To text.0 item.i = dw_tree_insert( tree, Word( text.i ), fileicon ) End ... Call dw_tree_item_collapse tree, item.5

DW_tree_item_expand dw_tree_item_expand( Win, Item ) Expands the specified Item in the tree. Win - the window identifier returned from DW_tree_new() Item - the item identifier returned from DW_tree_insert() or DW_tree_insert_after() No return result. DW_tree_new, DW_tree_insert, DW_tree_insert_after, DW_tree_item_collapse tree = dw_tree_new( 0 ) Do i = 1 To text.0 item.i = dw_tree_insert( tree, Word( text.i ), fileicon ) End ... Call dw_tree_item_expand tree, item.5

DW_tree_item_set_data dw_tree_item_set_data( Win, Item, UserData ) Sets the userdata for the specified tree Item. Win - the window identifier returned from DW_tree_new() Item - the item in the tree to which the data is to be attached UserData - the string to associate with the tree item's user data No return result. DW_tree_new, DW_tree_item_get_data tree = dw_tree_new( 0 ) Do i = 1 To text.0 item.i = dw_tree_insert( tree, Word( text.i ), fileicon ) Call dw_tree_item_set_data tree, item.i, 'item'i End ... Say 'The data from this item is' dw_tree_item_get_data( tree, item.5 ) , 'and should be "item5"'

DW_tree_item_get_data data = dw_tree_item_get_data( Win, Item ) Returns the data the user set for this Item when calling DW_tree_item_set_data(). Win - the window identifier returned from DW_tree_new() Item - the item identifier returned from DW_tree_insert() The user supplied data. DW_tree_new, DW_tree_item_set_data tree = dw_tree_new( 0 ) Do i = 1 To text.0 item.i = dw_tree_insert( tree, Word( text.i ), fileicon ) Call dw_tree_item_set_data tree, item.i, 'item'i End ... Say 'The data from this item is' dw_tree_item_get_data( tree, item.5 ) , 'and should be "item5"'

DW_tree_item_select dw_tree_item_select( Win, Item ) Makes the specified tree Item the currently selected item. Win - the window identifier returned from DW_tree_new() Item - the item identifier returned from DW_tree_insert() or DW_tree_insert_after() No return result. DW_tree_new, DW_tree_item_set_data, DW_tree_insert, DW_tree_insert_after tree = dw_tree_new( 0 ) Do i = 1 To text.0 item.i = dw_tree_insert( tree, Word( text.i ), fileicon ) Call dw_tree_item_set_data tree, item.i, 'item'i End ... Call dw_tree_item_select( tree, item.5 )

DW_tree_item_change dw_tree_item_change( Win, Item, Title, Icon ) Changes the Title and Icon for the specified tree Item. Win - the window identifier returned from DW_tree_new() Item - the item in the tree where this item is to follow Title - the text to appear next to the item Icon - the icon identifier returned from DW_icon_load_from_file() to appear with the item No return result. DW_tree_new, DW_tree_insert, DW_tree_insert_after tree = dw_tree_new( 0 ) Do i = 1 To text.0 item.i = dw_tree_insert( tree, Word( text.i ), fileicon ) Call dw_tree_item_set_data tree, item.i, 'item'i End ... Call dw_tree_item_change tree, item.5, 'New Title', diricon

A Window is frame in which other widgets are contained. It is also a generic term for a number of other widgets that can be manipulated by a number of functions in this section.

DW_window_new win = dw_window_new( Win, Title, Flags ) Creates a new window. A window is a visible frame containing a border and titlebar. It can also contain minimise/maximise/close buttons etc depending on the value of Flags. Win - the window identifier returned from various functions that return a window identifier or DW_DESKTOP. This is this window's parent window Title - the text to appear in the titlebar of the window (if it has one) Flags - the flags defining the style and initial behaviour of the window A window identifier. WindowStyleFlags win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle )

DW_mdi_new win = dw_mdi_new( Id ) Creates a new Multi-Document Interface (MDI) frame. An MDI frame is used as a container for multiple windows. Id - a numeric identifier used to identify the window An MDI frame identifier. DW_window_new ... mdi = dw_mdi_new( 100 ) ... mdiwin1 = dw_window_new( mdi, 'First MDI window', style ) mdiwin2 = dw_window_new( mdi, 'Second MDI window', style ) ...

DW_window_destroy dw_window_destroy( Win ) Destroys a window and all other items created within it. Win - the window identifier returned from various functions that return a window identifier 0 if successful, any other value is an error DW_window_new win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Window on desktop', style ) ... Call dw_window_destroy( win )

DW_window_capture dw_window_capture( Win ) Captures the mouse pointer to the specified window. Win - the window identifier returned from various functions that return a window identifier No return result. DW_window_release Only 1 window can capture the mouse pointer at any point in time. Call dw_window_capture( win )

DW_window_click_default dw_window_click_default( Win, NextWin ) Defines the next window; NextWin to receive focus when the ENTER key is pressed in Win. Win - the window identifier returned from various functions that return a window identifier used as the source of the ENTER key NextWin - the window identifier returned from various functions that return a window identifier which receives focus No return result. Call dw_window_click_default( win, nextwin )

DW_window_default dw_window_default( Win, DefaultWin ) Sets the default focus item; DefaultWin for the specified window. Win - the window identifier returned from various functions that return a window identifier containing DefaultWin DefaultWin - the window identifier returned from various functions that return a window identifier which receives default focus No return result. Call dw_window_default( win, mywin )

DW_window_enable dw_window_enable( Win ) Disables a window. Win - the window identifier returned from various functions that return a window identifier No return result. DW_window_disable win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Window on desktop', style ) ... Call dw_window_disable( win ) ... Call dw_window_enable( win )

DW_window_disable dw_window_disable( Win ) Disables a window. Win - the window identifier returned from various functions that return a window identifier No return result. DW_window_enable win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Window on desktop', style ) ... Call dw_window_disable( win )

DW_window_from_id win = dw_window_from_id( Win, Id ) Returns the window identifier from a widget within Win with the given Id. Win - the window identifier returned from various functions that return a window identifier Id - the window id provided by the user in various function calls The window identifier. For this function to work, all Ids for widgets packed into the one window must be unique. box = dw_box_new( !REXXDW.!DW_VERT, 0 ) bitmap = dw_bitmap_new( 100 ) Call dw_box_pack_start box, bitmap, 10, 10, !REXXDW.!DW_DONT_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0 button = dw_button_new( "Quit", 10 ) Call dw_box_pack_start box, button, 10, 10, !REXXDW.!DW_DONT_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0 ... Say 'Id' dw_window_from_id( box, 100 ) 'should be the same as' bitmap

DW_window_show rc = dw_window_show( Win ) Makes the specified window visible. Win - the window identifier returned from various functions that return a window identifier 0 if function succeeds, error for any other value DW_window_hide win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle ) ... Call dw_window_show( win )

DW_window_hide dw_window_hide( Win ) Makes the specified window invisible. Win - the window identifier returned from various functions that return a window identifier No return result. DW_window_show win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle ) ... Call dw_window_hide( win )

DW_window_lower dw_window_lower( Win ) Makes the specified window appear behind all others. Win - the window identifier returned from various functions that return a window identifier No return result. DW_window_raise win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle ) ... Call dw_window_lower( win )

DW_window_minimize dw_window_minimize( Win ) Minimises the specified window. Win - the window identifier returned from various functions that return a window identifier No return result. DW_window_maximize; but there isn't one!! win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle ) ... Call dw_window_minimize( win )

DW_window_raise dw_window_raise( Win ) Makes the specified window appear in front of all others. Win - the window identifier returned from various functions that return a window identifier No return result. DW_window_lower win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle ) ... Call dw_window_raise( win )

DW_window_redraw dw_window_redraw( Win ) Redraws the specified window and all of widgets contained within it. This should be called after re-packing any widgets within the window. Win - the window identifier returned from various functions that return a window identifier No return result. DW_window_show win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle ) ... Call dw_window_redraw( win )

DW_window_release dw_window_release( ) Releases the captured mouse pointer from a previous call to DW_window_captture(). None No return result. DW_window_capture Only 1 window can capture the mouse pointer at any point in time. Call dw_window_capture( win ) ... Call dw_window_release( )

DW_window_reparent dw_window_reparent( Win, ParentWin ) Changes the parent window; ParentWin of the specified Win. Win - the window identifier returned from various functions that return a window identifier to be reparented ParentWin - the window identifier returned from various functions that return a window to becoem the new parent. May also be DW_DESKTOP No return result. mdi = dw_mdi_new( 100 ) win = dw_window_new( mdi, 'Edit User Preferences', windowstyle ) ... Call dw_window_reparent( win, !REXXDW.!DW_DESKTOP ) ... box1 = dw_box_new( !REXXDW.!DW_VERT, 0 ) Call dw_box_pack_start win, box1, 10, 10, !REXXDW.!DW_DONT_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0 button = dw_button_new( "Quit", 10 ) Call dw_box_pack_start box1, button, 10, 10, !REXXDW.!DW_DONT_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0 ... box2 = dw_box_new( !REXXDW.!DW_VERT, 0 ) Call dw_window_reparent box2, button

DW_window_set_bitmap dw_window_set_bitmap( Win, Id, Filename ) Associates the bitmap in Filename with the specified window. Win - the window identifier returned from various functions that return a window identifier Id - a numeric identifier used to identify the window Filename - the name of a file containing a valid bitmap image (.BMP, or .XPM) No return result. DW_bitmap_new_from_file ... bitmap = dw_bitmap_new( 100 ) Call dw_box_pack_start win, bitmap, 10, 10, !REXXDW.!DW_DONT_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0 Call dw_window_set_bitmap bitmap, 0, 'mypicture'

DW_window_set_border dw_window_set_border( Win, Width ) Sets the width of the border for the specified window. Win - the window identifier returned from various functions that return a window identifier Width - the width in pixels of the window's border 0 if successful, any other value is an error This function only works on OS/2. win = dw_window_new( mdi, 'Edit User Preferences', windowstyle ) Call dw_window_set_border win, 20

DW_window_set_pointer dw_window_set_pointer( Win, Pointer ) Changes the mouse pointer to Pointer. Win - the window identifier returned from various functions that return a window identifier Pointer - the new pointer; one of PointerTypes No return result. PointerTypes To ensure that the pointer is changed immediately, call DW_main_sleep() afterwards for a short period, like 10 milliseconds win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle ) ... Call dw_window_set_pointer( win, !REXXDW.!DW_POINTER_CLOCK ) Call dw_main_sleep 10

DW_window_set_color dw_window_set_color( Win, Fore, Back ) Sets the foreground and background colour of the window. Win - the window identifier returned from various functions that return a window identifier Fore - the internal RexxDW colour for the foreground Back - the internal RexxDW colour for the background 0 if successful, any other value is an error Colours, DW_rgb text = dw_text_new( 'File to browse', 0 ) Call dw_window_set_color text, !REXXDW.!DW_CLR_BLACK, !REXXDW.!DW_CLR_YELLOW

DW_window_set_font dw_window_set_font( Win, Fontname ) Sets the text font of the window. Win - the window identifier returned from various functions that return a window identifier Fontname - the font name of the desired font 0 if successful, any other value is an error Fontnames Font names in RexxDW are platform dependent. See Fontnames for details on how to specify fonts on each platform. Parse Source os . prog Select When os = 'OS2' | os = 'OS/2' Then FIXEDFONT = "5.System VIO" When os = 'WIN32' Then FIXEDFONT = "10.Terminal" When !REXXDW.!GTK_MAJOR_VERSION > 1 Then FIXEDFONT = "monospace 10" Otherwise FIXEDFONT = "fixed" End text = dw_text_new( 'File to browse', 0 ) Call dw_window_set_font text, FIXEDFONT

DW_window_set_icon dw_window_set_icon( Win, Icon ) Sets the text font of the window. Win - the window identifier returned from various functions that return a window identifier Icon - the icon identifier returned from DW_icon_load_from_file() No return result. DW_icon_load_from_file rexxdwicon = dw_icon_load_from_file( '/home/mark/rexxdw' ) win = dw_window_new( mdi, 'Edit User Preferences', windowstyle ) Call dw_window_set_icon win, rexxdwicon

DW_window_set_pos dw_window_set_pos( Win, X, Y ) Sets the position of the top left corner of the window relative to the window's parent. Win - the window identifier returned from various functions that return a window identifier X - the x coordinate in pixels of the top left corner Y - the y coordinate in pixels of the top left corner No return result. DW_window_set_pos_size, DW_window_set_size Some window managers (at least under X11) will not respect a request for the position of a window. win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle ) Call dw_window_set_pos win, 50, 90

DW_window_set_size dw_window_set_size( Win, Width, Height ) Sets the size of the window in pixels. Win - the window identifier returned from various functions that return a window identifier Width - the requested width of Window in pixels Height - the requested height of Window in pixels No return result. DW_window_set_pos, DW_window_set_pos_size Some window managers (at least under X11) will not respect a request for the size of a window. win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle ) Call dw_window_set_size win, 640, 480

DW_window_set_pos_size dw_window_set_pos_size( Win, X, Y, Width, Height ) Sets the position of the top left corner of the window relative to the window's parent and the size of the window in pixels. Win - the window identifier returned from various functions that return a window identifier X - the x coordinate in pixels of the top left corner Y - the y coordinate in pixels of the top left corner Width - the requested width of Window in pixels Height - the requested height of Window in pixels No return result. DW_window_set_pos, DW_window_set_size Some window managers (at least under X11) will not respect a request for the position of a window. win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle ) Call dw_window_set_pos_size win, 50, 90, 640, 480

DW_window_get_pos_size X Y Width Height = dw_window_get_pos_size( Win ) Returns the X and Y coordinates of the specified window, and the Width and Height of the window. Win - the window identifier returned from various functions that return a window identifier X, Y, Width and Height are returned as four words. PARSE VALUE is the easiest way to obtain all values. ... win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Edit User Preferences', , windowstyle ) ... Parse Value dw_window_get_pos_size( win ) With x y width height

DW_window_set_style dw_window_set_style( Win, Style, Mask ) Changes the attributes of text within the specified window. Win - the window identifier returned from various functions that return a window identifier Style - Any value specified in TextAttributeFlags ORed together Mask - Any value specified in TextAttributeFlags ORed together No return result. TextAttributeFlags win = dw_text_new( 'Edit User Preferences' ) style = dw_or( !REXXDW.!DW_DT_RIGHT, !REXXDW.!DW_DT_VCENTER ) mask = dw_or( !REXXDW.!DW_DT_RIGHT, !REXXDW.!DW_DT_VCENTER ) Call dw_window_set_style win, style, mask

DW_window_set_text dw_window_set_text( Win, Text ) Sets the text for the specified window. If the window is a top level window and it has a title bar, the title bar text is changed. Win - the window identifier returned from various functions that return a window identifier Text - the value of the text attribute the window is to have No return result. DW_window_get_text Not all window types have a meaningful text attribute. Those that do are: Text DW_text_new StatusText DW_statustext_new Combobox DW_combobox_new() EntryField DW_entryfield_new() EntryFieldPassword DW_entryfield_password_new() entryfield = dw_entryfield_new( "Initial value", 0 ) ... Call dw_window_set_text entryfield, 'Rexx is king'

DW_window_get_text text = dw_window_get_text( Win ) Returns the text attribute from the specified window. Win - the window identifier returned from various functions that return a window identifier The value of the text attribute of the window. DW_window_set_text Not all windows have a meaningful text attribute. Those that do are: Text DW_text_new StatusText DW_statustext_new Combobox DW_combobox_new() EntryField DW_entryfield_new() EntryFieldPassword DW_entryfield_password_new() entryfield = dw_entryfield_new( "Initial value", 0 ) ... Say 'The text is now' dw_window_get_text( entryfield )

DW_window_set_data dw_window_set_data( Win, Name, Value ) Sets the user variable; Name to the specified Value for the specified window. Win - the window identifier returned from various functions that return a window identifier Name - the user variable name Value - the value that Name is to be set to No return result. DW_window_get_data Don't use variable names that start with "_dw"; they are used internally by Dynamic Windows. entryfield = dw_entryfield_new( 'Initial value', 0 ) Call dw_window_set_data entryfield, 'MyVar', 'my useful data' ... Say 'The value of "MyVar" is:' dw_window_get_data( entryfield, 'MyVar' )

DW_window_get_data data = dw_window_get_data( Win, Name ) Returns the user variable data for the window with the given Name created by a call to DW_window_set_data(); Win - the window identifier returned from various functions that return a window identifier Name - the user variable name The value of the user variable Name for the window DW_window_set_data Don't use variable names that start with "_dw"; they are used internally by Dynamic Windows. entryfield = dw_entryfield_new( 'Initial value', 0 ) Call dw_window_set_data entryfield, 'MyVar', 'my useful data' ... Say 'The value of "MyVar" is:' dw_window_get_data( entryfield, 'MyVar' )

There always has to be things that can't be logically grouped together. These are those.

DW_messagebox action = dw_messagebox( Title, Flags, Text ) Displays a modal messagebox in the middle of the desktop. Title - the window title for the messagebox Flags - indicates the buttons to be incorporated into the messagebox and the icon to be displayed Text - the text inside the messagebox Depending on the button clicked, one of the values defined in MessageboxResults MessageboxFlags, MessageboxResults ... action = dw_messagebox( 'Are you sure?', dw_or( !REXXDW.!DW_MB_YESNO, , !REXXDW.!DW_MB_QUESTION ), 'Delete selected files' ) If action = !REXXDW.!DW_MB_RESULT_YES Then Call DeleteFiles

DW_bitmap_new win = dw_bitmap_new( Id ) Creates a new bitmap window used as the container for a bitmap image. Id - a numeric identifier used to identify the window A window identifier. DW_window_set_bitmap, DW_bitmap_new_from_file ... bitmap = dw_bitmap_new( 100 ) Call dw_box_pack_start win, bitmap, 10, 10, !REXXDW.!DW_DONT_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0 Call dw_window_set_bitmap bitmap, 0, 'mypicture'

DW_bitmap_new_from_file win = dw_bitmap_new( Id, Filename ) Creates a new bitmap window including a bitmap image. Id - a numeric identifier used to identify the window Filename - the filename of the bitmap image A window identifier. DW_window_set_bitmap, DW_bitmap_new ... bitmap = dw_bitmap_new_from_file( 100, 'mypicture' ) Call dw_box_pack_start win, bitmap, 10, 10, !REXXDW.!DW_DONT_EXPAND_HORZ, , !REXXDW.!DW_DONT_EXPAND_VERT, 0

DW_icon_load_from_file win = dw_icon_load_from_file( Filename ) Creates a new icon identifier for use in other functions from the file specified in Filename. Supported icon types are Windows icons (.ico), OS/2 icons(.ico) and pixmaps(.xpm) on GTK. Filename - the filename of the icon file An icon identifier. The Filename can contain a path component. For portability, do not specify the file's extension; let dwindows work this out. normalfileicon = dw_icon_load_from_file( '/home/mark/normalfile' )

These functions control the execution of the current process or instigate other processes.

DW_init rc = dw_init( ) Initialises the Rexx/DW interface. This MUST be called before any other Rexx/DW function. None 0 if all OK, non-zero if an error occurred Call dw_init

DW_main dw_main( ) This is the main event dispatcher function for Rexx interpreters which support callbacks. None No return result. This function can only be called if your Rexx interpreter supports the RexxCallback() API. This can be determined by the value of the variable !REXXDW.!HAVE_REXXCALLBACK being 1. DW_main_iteration ... If !REXXDW.!HAVE_REXXCALLBACK Then Call dw_main() Else Do Forever cmd = dw_main_iteration() If cmd \= '' Then Interpret 'Call' cmd End Return 0

DW_main_iteration cmd = dw_main_iteration( ) This is the main event dispatcher function for Rexx interpreters which DO NOT support callbacks. None The Rexx function called back, follwoed by parameters This function is supplied for interpreters that do not support the RexxCallback() API. This can be determined by the value of the variable !REXXDW.!HAVE_REXXCALLBACK being 1. You have to be very careful with any optional data you pass to a callback function as the data could be "interpreted" with syntax errors. DW_main ... If !REXXDW.!HAVE_REXXCALLBACK Then Call dw_main() Else Do Forever cmd = dw_main_iteration() If cmd \= '' Then Interpret 'Call' cmd End Return 0

DW_main_sleep dw_main_sleep( Period ) This function dispatches any events in the event queue for the number of milliseconds specified by Period. Period - the number of milliseconds the event dispatcher runs for No return result. This function is useful to ensure that any outstanding event is executed before continuing execution within the code and not having to wait until control passes back to DW_Main() or DW_main_iteration(). DW_main, DW_main_iteration ... Call dw_window_set_pointer mainwindow, !REXXDW.!DW_POINTER_CLOCK Call dw_main_sleep 10

A Dialog allows the programmer to create an interface with the user that is controlled outside of the normal main message dispatcher. other processes.

DW_dialog_new dialog = dw_dialog_new( ) Creates a new dialog. A dialog is a control widget (as opposed to a display widget) that allows the programmer to create a new toplevel window and have the user interact with the contents of the window, independently of any other toplevel window. None Returns a dialog identifier DW_dialog_dismiss, DW_dialog_wait ... dialog_wait = dw_dialog_new( ) Call dw_signal_connect win, !REXXDW.!DW_DELETE_EVENT, , 'GenericCloseCallback', win, dialog_wait ... result = dw_dialog_wait( dialog_wait ) If result = 'cancel' Then Return 1 ... GenericCloseCallback: Procedure Expose !REXXDW. Parse Arg ., window, dialog Call dw_window_destroy window If dialog \= '' Then Call dw_dialog_dismiss dialog, 'close' Return 0

DW_dialog_dismiss dw_dialog_dismiss( Dialog, ReturnString ) Prepares a dialog window for exiting and returns ReturnString to the waiting DW_dialog_wait(). Dialog - an identifier returned from a call to DW_dialog_new() ReturnString - the string to return to DW_dialog_wait() Always returns 0 DW_dialog_new, DW_dialog_wait ... dialog_wait = dw_dialog_new( ) Call dw_signal_connect win, !REXXDW.!DW_DELETE_EVENT, , 'GenericCloseCallback', win, dialog_wait ... result = dw_dialog_wait( dialog_wait ) If result = 'cancel' Then Return 1 ... GenericCloseCallback: Procedure Expose !REXXDW. Parse Arg ., window, dialog Call dw_window_destroy window If dialog \= '' Then Call dw_dialog_dismiss dialog, 'close' Return 0

DW_dialog_wait returnstring = dw_dialog_wait( Dialog ) Creates a new dialog for handling modal dialogs. Dialog - an identifier returned from a call to DW_dialog_new() Returns the string set by the call to DW_dialog_dismiss() DW_dialog_dismiss, DW_dialog_new ... dialog_wait = dw_dialog_new( ) Call dw_signal_connect win, !REXXDW.!DW_DELETE_EVENT, , 'GenericCloseCallback', win, dialog_wait ... result = dw_dialog_wait( dialog_wait ) If result = 'cancel' Then Return 1 ... GenericCloseCallback: Procedure Expose !REXXDW. Parse Arg ., window, dialog Call dw_window_destroy window If dialog \= '' Then Call dw_dialog_dismiss dialog, 'close' Return 0

These functions manage callbacks in RexxDW.

DW_signal_connect dw_signal_connect( Win, Signal, Function[, UserData1[, UserData2[, ...]]] ) Connects an event to a callback function. Win - the window identifier to which the callback is assigned Signal - the event to be connected Function - the Rexx procedure that is called when the event fires UserData* - optional user supplied data to pass to the Function No return result. DW_signal_disconnect, DW_signal_disconnect_by_window, Callbacks Call dw_signal_connect window, !REXXDW.!DW_CONFIGURE_EVENT, , 'configure_cb', 'fred', 'mary'

DW_signal_disconnect dw_signal_disconnect( Win, Signal ) Disconnects a specific event callback. Win - the window identifier that has the callback assigned Signal - the event to be disconnected No return result. DW_signal_connect, DW_signal_disconnect_by_window, Callbacks Call dw_signal_connect window, !REXXDW.!DW_CONFIGURE_EVENT, , 'configure_cb', 'fred', 'mary' ... Call dw_signal_disconnect window, !REXXDW.!DW_CONFIGURE_EVENT

DW_signal_disconnect_by_window dw_signal_disconnect_by_window( Win ) Disconnects all signals for a window. Win - the window identifier that has the callbacks assigned No return result. DW_signal_connect, DW_signal_disconnect, Callbacks Call dw_signal_connect window, !REXXDW.!DW_CONFIGURE_EVENT, , 'configure_cb', 'fred', 'mary' ... Call dw_signal_disconnect_by_window window

DW_timer_connect timer = dw_timer_connect( Interval, Function[, UserData1[, UserData2[, ...]]] ) Creates a new timer callback. A timer callback will fire after the specified Interval and call the Rexx procedure Function with the optional arguments. Interval - the interval in milliseconds that the timer will fire Function - the Rexx procedure that is called when the timer fires UserData* - optional user supplied data to pass to the Function A timer identifier. DW_timer_disconnect, Callbacks There are two ways to stop a timer from firing. One is explicitly by calling DW_timer_disconnect() using the timer identifier returned from this function. The other way is to return 0 from the callback connected to the timer. Returning 1 from the callback will re-arm the timer. timer = dw_timer_connect( 5000, 'timer_cb', 'fred', 'mary' )

DW_timer_disconnect dw_timer_disconnect( Timer ) Terminates the timer so the timer no longer files. Timer - the timer identifier returned from a call to DW_timer_connect() No return result. DW_timer_connect, Callbacks timer = dw_timer_connect( 5000, 'timer_cb', 'fred', 'mary' ) ... Call dw_timer_disconnect timer

These functions provide browsing capabilties.

DW_browse rc = dw_browse( URL ) Starts up the default Web browser as a new process with the specified URL. When using GTK, the browser started is "netscape". To use another browser set the environment variable DW_BROWSER to the executable to run. URL - the Uniform Resource Locatr to open Padding - The number of pixels of padding to add around all sides of BoxToPack The return code from the attempt to execute the browser. Usually 0 indicates success and any other value an error. ... rc = dw_browse( "http://rexxdw.sf.net" )

DW_file_browse filename = dw_file_browse( Title, DefaultDir, Extension, Flag ) Creates a file open/save or directory browser dialog. Title - the title of the dialog DefaultDir - the directory in which the dialog starts Ext - a file extension to filter the files displayed, or the file extension to save. Ignored for directory browser. Flag - indicates if the browse dialog is for a file open, file save or directory browse. One of !REXXDW.!DW_DIRECTORY_OPEN, !REXXDW.!DW_FILE_OPEN or !REXXDW.!DW_FILE_SAVE The fully qualified selected file/directory or blank if the dialog is cancelled. FileDialogFlags On some platforms the current directory is changed when this function is called. ... here = Directory() dir = dw_file_browse( "Select Directory", "/home/mark", , , !REXXDW.!DW_DIRECTORY_OPEN ) Say "Directory selected was:" dir Call Directory( here )

These functions allow colours to be manipulated.

DW_color_depth_get depth = dw_color_depth_get() Returns the colour depth of the current screen. None The colour depth. ... Say 'Colour depth is:' dw_color_depth_get()

DW_rgb colour = dw_rgb( Red, Green, Blue ) Mixes shades of red, green and blue to make an internal RexxDW colour. Red - the amount of Red to use (0 to 255 ) Green - the amount of Green to use (0 to 255 ) Blue - the amount of Blue to use (0 to 255 ) An internal RexxDW colour. DW_red_value, DW_green_value, DW_red_value ... colour = dw_rgb( 45, 134, 200 )

DW_red_value red = dw_red_value( Colour ) Obtains the red component from a RexxDW colour. Colour - the internal RexxDW colour containing a red component The red component of the colour. DW_green_value, DW_blue_value, DW_rgb ... Say 'The red component of DARKCYAN is:' , dw_red_value( !REXXDW.!DW_CLR_DARKCYAN )

DW_green_value green = dw_green_value( Colour ) Obtains the green component from a RexxDW colour. Colour - the internal RexxDW colour containing a green component The green component of the colour. DW_red_value, DW_blue_value, DW_rgb ... Say 'The green component of DARKCYAN is:' , dw_green_value( !REXXDW.!DW_CLR_DARKCYAN )

DW_blue_value blue = dw_blue_value( Colour ) Obtains the blue component from a RexxDW colour. Colour - the internal RexxDW colour containing a blue component The blue component of the colour. DW_red_value, DW_green_value, DW_rgb ... Say 'The blue component of DARKCYAN is:' , dw_blue_value( !REXXDW.!DW_CLR_DARKCYAN )

DW_color_background_set dw_color_background_set( Colour ) Sets the background colour of the specified window. Only applicable to render??? windows. Colour - either one of the pre-defined colour constatnts, or a colour returned from a call to DW_rgb() No return result. Colours, DW_color_foreground_set, DW_rgb ... Call dw_color_background_set( renderbox, dw_rgb( 10, 45, 123 ) )

DW_color_foreground_set dw_color_foreground_set( Colour ) Sets the foreground colour of the specified window. Only applicable to render??? windows. Colour - either one of the pre-defined colour constatnts, or a colour returned from a call to DW_rgb() No return result. Colours, DW_color_background_set, DW_rgb ... Call dw_color_foreground_set( renderbox, dw_rgb( 10, 45, 123 ) )

DW_color_choose color = dw_color_choose( InitialColour ) Displays a system dialog for selecting a color. InitialColour - either one of the pre-defined colour constatnts, or a colour returned from a call to DW_rgb() The selected color, or the same value as InitialColor if the user cancels. Colours, DW_color_background_set, DW_rgb ... newcolor = dw_color_choose( dw_rgb( 10, 45, 123 )

These functions support the loading and unloading of modules in DLLs. Not applicable to RexxDW.

These functions support the processing of semaphores. Not applicable to RexxDW.

These functions support events. Not applicable to RexxDW.

These functions support threads. Not applicable to RexxDW.

These functions allow positioning of the mouse pointer.

DW_pointer_set_pos dw_pointer_set_pos( X, Y ) Moves the mouse pointer to the specified X and Y coordinates. X - the X coordinate of the mouse pointer Y - the Y coordinate of the mouse pointer No return result. DW_pointer_get_pos The coordinates are absolute screen positions, with 0/0 being the the top left corner of the screen. (Windows!!) ... Call dw_pointer_set_pos 100, 130

DW_pointer_get_pos X Y = dw_pointer_get_pos( ) Returns the X and Y coordinates of the mouse pointer. None X and Y are returned as two words. PARSE VALUE is the easiest way to obtain both values. DW_pointer_set_pos The coordinates are absolute screen positions, with 0/0 being the the top left corner of the screen. (Windows!!) ... Parse Value dw_pointer_get_pos( ) With x y Say 'The mouse pointer is at' x'/'y

These functions are grouped together becasue they don't fit into any other group.

DW_beep dw_beep( Frequency, Duration ) Makes a sound of the given Frequency for the given Duration. Frequency - the frequency of the sound Duration - the duration of the sound in milliseconds No return result. ... Call dw_beep(5000, 1000)

DW_environment_query dw_environment_query( Stem ) Returns lots of information about the platform and Dynamic Windows in an array. Stem - stem (with trailing period) to place the results No return result. Value of array items: - Stem.0 - 10 (number of items in array) - Stem.1 - Operating System Name - Stem.2 - Operating System Build Date - Stem.3 - Operating System Build Time - Stem.4 - Operating System Major Version - Stem.5 - Operating System Minor Version - Stem.6 - Operating System Major Build Number - Stem.7 - Operating System Minor Build Number - Stem.8 - Dynamic Windows Major Version - Stem.9 - Dynamic Windows Minor Version - Stem.10 - Dynamic Windows Sub Version Call dw_environment_query( 'stem.' ) Say 'OS name is:' stem.1

DW_user_dir dir = dw_user_dir( ) Returns the user's "home" directory. If the environment variable HOME is set, this is returned, otherwise "C:\" is returned. None The user's home directory. Say 'home is' dw_user_dir()

DW_screen_height height = dw_screen_height( ) Returns the height of the physical screen in pixels. None The screen height DW_screen_width Say 'The height of the screen is' dw_screen_height()

DW_screen_width width = dw_screen_width( ) Returns the width of the physical screen in pixels. None The screen width DW_screen_height Say 'The width of the screen is' dw_screen_width()

DW_font_text_extents_get Width Height = dw_font_text_extents_get( Win, Pixmap, Text ) Returns the width and height of the Text in the current font. Win - the window identifier returned from DW_container_new() Pixmap - the pixmap identifier returned from DW_pixmap_new() Text - the string to measure the font width and height Width and Height are returned as two words. PARSE VALUE is the easiest way to obtain both values. When calculating the size of the maximum width and height of a font, use a value like 'g(' for Text to ensure the maximum height of the Text can be calculated. Only one of Win or Pixmap is required. The other argument should be set to 0. win = dw_render_new( 0 ) Call dw_window_set_font win, myfont Parse Value dw_font_text_extents_get( win, 0, 'g(' ) With width height

DW_or val = dw_or( Val1, Val2[,Val3...]]) Logically "or" multiple values together. Val1 - value of first numeric value to logically "or" Val2 - value of second numeric value to logically "or" ... - optional other numeric values to logically "or" The combined value of all arguments logically "or"ed together. DW_and ... style = dw_or( !REXXDW.!DW_FCF_SYSMENU, !REXXDW.!DW_FCF_TITLEBAR, , !REXXDW.!DW_FCF_SHELLPOSITION, !REXXDW.!DW_FCF_TASKLIST, , !REXXDW.!DW_FCF_DLGBORDER, !REXXDW.!DW_FCF_SIZEBORDER, , !REXXDW.!DW_FCF_MINMAX ) win = dw_window_new( !REXXDW.!DW_DESKTOP, 'Window on desktop', style )

DW_and val = dw_and( Val1, Val2[,Val3...]]) Logically "and" multiple values together. Val1 - value of first numeric value to logically "and" Val2 - value of second numeric value to logically "and" ... - optional other numeric values to logically "and" The combined value of all arguments logically "and"ed together. DW_or ... val = dw_and(10, 512345)

DW_flush dw_flush() Ensures that any changes drawn to the screen are immediately visible. None No return result. ... Call dw_pixmap_bitblt win, , 0, 0, width, height, , pixmap, x, 0 Call dw_flush()

These functions are common to most Rexx external function packages.

DW_loadfuncs rcode = dw_loadfuncs() Loads all other RexxDW external functions None 0 in all cases DW_dropfuncs Under OS/2, DW_loadfuncs() will set the current process to a PM application to allow interaction with the OS/2 message queue. DW_dropfuncs() sets the process back to the type of application it was started as. If you run a Rexx/DW program as a .CMD file from a CMD.EXE window, and DO NOT call DW_dropfuncs(), your CMD.EXE window will be unusable!

DW_dropfuncs rcode = dw_dropfuncs(["UNLOAD"]) Cleans up RexxDW environment and optionally will drop the external functions. UNLOAD - causes the external functions to be dropped. 0 in all cases DW_loadfuncs Under OS/2, DW_loadfuncs() will set the current process to a PM application to allow interaction with the OS/2 message queue. DW_dropfuncs() sets the process back to the type of application it was started as. If you run a Rexx/DW program as a .CMD file from a CMD.EXE window, and DO NOT call DW_dropfuncs(), your CMD.EXE window will be unusable!

DW_variable rcode = dw_variable(Variable [,NewValue]) Get or set an internal RexxDW variable. Variable - name of the variable to get or set. See NOTES for NewValue - the new value of "Variable", if the variable is settable When setting a variable, then 0 if success, any other value is an error When getting a variable, then the value of the variable is returned. The "Variable" argument can be one of: DEBUG (settable) 0 - no debugging 1 - all Rexx variables set by RexxDW are displayed as they are set 2 - all RexxDW functions are traced on entry with argument values and on exit with the return value 4 - all internal RexxDW functions are traced with their arguments (really only useful for developers) The values can be added together for a combination of the above details. DEBUGFILE (settable) Where any debugging output is written. By default this goes to the system's error stream; usually 'stderr'. CONSTANTPREFIX (settable) The variable name prefix for all RexxDW constants. By default this is '!REXXDW.!'. If you change this, it is useful to make the prefix result in stemmed variables; this makes it far easier to EXPOSE these constants. VERSION (readonly) The full version details of RexxDW in the format: package version version_date Where: package - the string 'rexxdw' version - package version in n.n format; eg 1.0 version_date - date package was released in DATE('N') format ... Say 'We are running at debug level:' dw_variable( 'DEBUG' )

DW_QueryFunction rcode = dw_QueryFunction(FunctionName|ResultArray[, Option]) Populates an array of all functions supplied by this package depending on Option FunctionName - the name of a function to query (no trailing period) ResultArray - the stem (trailing period) in which the list of functions is returned Option - one of 'R' (the default) for "registered" functions or 'A' for "available" functions 0 if successful or 1 if the FunctionName is not found To determine if a FunctionName can be executed in your code, pass the function name as the first argument, and 'R' as the second. If the function can be called the function returns 0, otherwise it returns 1