home *** CD-ROM | disk | FTP | other *** search
/ PC World 2000 August / PCWorld_2000-08_cd.bin / Software / TemaCD / xbasic / xbpro.exe / xb / pde.hlp < prev    next >
Text File  |  2000-01-15  |  57KB  |  2,053 lines
  1. :Environment
  2. The program development environment.
  3.  
  4. For more information, request help on individual
  5. grids in the main window, or in accessory windows.
  6.  
  7. :FileNew
  8. Delete the existing program or text file
  9. and prepare to enter a new program or text
  10. file.  The existing file is lost.
  11.  
  12. :FileBox
  13. Select a disk file.  To select a particular file,
  14. enter the name in the TextLine grid at the top of
  15. the window, then press the Enter key or click on
  16. the Enter button.  You can double click a filename
  17. in the right hand List grid to enter that filename
  18. into the TextLine.  You can navigate other drives
  19. and directories with the DriveBox and DirectoryList
  20. grids on the left.
  21.  
  22. :SelectFile
  23. Select a file.
  24.  
  25. :FileTextLoad
  26. Load a text file.  The entire file is
  27. loaded into the lower text area where
  28. it can be edited and potentially saved.
  29.  
  30. :FileLoad
  31. Load a program file.  The program is
  32. loaded, then broken into a PROLOG and
  33. one or more functions.
  34.  
  35. The PROLOG is initially displayed in
  36. the lower text area.
  37.  
  38. :FileSave
  39. Save the currently loaded text or program file.
  40.  
  41. :FileMode
  42. Switch back and forth between text mode
  43. and program mode.
  44.  
  45. :FileRename
  46. Rename the currently loaded file.  The
  47. new name becomes the new default load
  48. and save filename.
  49.  
  50. :EditFind
  51. Find a text string in the loaded file.
  52.  
  53. :EditRead
  54. Read a text file from disk and insert
  55. it at the current text cursor location
  56. in the lower text area.
  57.  
  58. :EditWrite
  59. Write the selected text in the lower
  60. text area to a file.
  61.  
  62. :EditAbandon
  63. Abandon edits to the current function.
  64. All changes made since the last time
  65. the function was displayed in the lower
  66. text area are lost.
  67.  
  68. :ViewFunction
  69. View a function by loading it into
  70. the lower text area.
  71.  
  72. :ViewNew
  73. Create and view a new function having
  74. any valid function name that is not
  75. currently defined.
  76.  
  77. :ViewDelete
  78. Delete any existing function.
  79.  
  80. :ViewRename
  81. Rename the function currently loaded
  82. into the lower text area.
  83.  
  84. :ViewClone
  85. Create and view a new function with
  86. contents identical to the currently
  87. displayed function.
  88.  
  89. :OptionCompile
  90. OptionCompile.
  91.  
  92. :OptionTabs
  93. OptionTabs
  94.  
  95. :DebugMemory
  96. DebugMemory
  97.  
  98. :DebugAssembly
  99. DebugAssembly
  100.  
  101. :DebugRegisters
  102. DebugRegisters.
  103.  
  104. :WizardCompileErrors
  105. WizardCompileErrors.
  106.  
  107. :WizardRuntimeErrors
  108. WizardRuntimeErrors.
  109.  
  110. :WizardProfiler
  111. WizardProfiler.
  112.  
  113. :Variables
  114. Variables.
  115.  
  116. :Array
  117. Array.
  118.  
  119. :String
  120. String.
  121.  
  122. :Composite
  123. Composite.
  124.  
  125. :Frames
  126. Frames.
  127.  
  128. :Warning3
  129. Warning3.
  130.  
  131. :Warning4
  132. Warning4.
  133.  
  134. :MenuBar
  135. The main MenuBar contains catagories of program
  136. development environment commands.  When you
  137. select a MenuBar heading (File, Edit...), a
  138. PullDown menu appears below the heading.
  139.  
  140. Select any entry in the PullDown to
  141. perform the indicated action, or click
  142. elsewhere to disable the PullDown.
  143.  
  144. :FileLabel
  145. The name of the currently loaded file.
  146.  
  147. :StatusLabel
  148. The current status of the program development
  149. environment.  The defined states include:
  150.  
  151.   initializing
  152.   loading
  153.   loaded
  154.   parsing
  155.   compiling
  156.   compiled
  157.   running
  158.   paused
  159.   errors
  160.  
  161. :Function
  162. Names the function currently displayed in the
  163. lower TextArea.  Click the function name to
  164. display a list of all functions in the program.
  165. Click any function in the list to display that
  166. function in the lower TextArea.
  167.  
  168. :Command
  169. This is the command entry portion of the
  170. program development environment main window.
  171. Status information is printed here, and you
  172. can enter a variety of dot commands here also.
  173.  
  174. You can toggle the insert cursor between the upper
  175. and lower text areas by pressing the escape key.
  176.  
  177. You can enter "dot commands" in the upper text
  178. area to perform various program development tasks,
  179. including any operation you can select from the
  180. main pulldown menus.
  181.  
  182. DOT COMMAND SYNTAX =  .<command>[<space><argument>]
  183.  
  184.   Commands:  all menu bar commands are executed using their 2-letter mnemonic
  185.   Examples:  .fn = FileNew [filetype] (t | p | g)
  186.              .ft = FileTextLoad [filename]
  187.              .fl = FileLoad [filename]
  188.              .fs = FileSave [filename]
  189.              .fm = FileMode
  190.              .fr = FileRename [filename]
  191.              .fq = FileQuit
  192.              .ec = EditCut  (selected text)
  193.              .eg = EditGrab (selected text)
  194.              .ep = EditPaste (at insert cursor)
  195.   ... etc ...
  196.  
  197.   accept filename argument : ft  fl  fs  fr  er  ew
  198.   accept function name     : vv  vp  vn  vd  vr  vc
  199.  
  200. *****  SPECIAL DOT COMMANDS  *****
  201.  
  202.   .f        find text string  (see below)
  203.   .r        replace text string  (see below)
  204.   .c        clear command area
  205.   .s#       set tag (a-z)
  206.   .j#       jump to tag
  207.   .         cursor line/character
  208.   .#        move cursor to line #
  209.   .v        view next function
  210.   .v-       view previous function
  211.   .v0       view PROLOG
  212.   .a        again (repeat last command)
  213.   .h        help (print dot command summary)
  214.  
  215. FIND SYNTAX
  216.   .[*|<#>][f|r][-][<space><find text>[<tab><replace text>]]
  217.    [*|<#>]  = repetitions  (* = all instances, default = 1)
  218.    [f|r]    = find | replace
  219.    [-]      = reverse
  220.    [<space>find text] = a single space delimits the find text
  221.                          (optional: if not specified, last find text is used)
  222.    [<tab>replace text] = a single tab (NOT     ) delimits the replace text
  223.                           (optional: if not specified, last replace text is used)
  224.  
  225. Example: .*r recieve    receive  (replace all instances)
  226.             |       |                 (forward)
  227.           space    tab
  228.  
  229.  
  230. :TextLower
  231. The lower TextArea is where text files and
  232. programs are displayed.  You can edit your
  233. text and programs here in conventional ways.
  234.  
  235. Press the escape key to toggle the text
  236. cursor between the upper and lower TextArea.
  237.  
  238. In Program or GuiProgram mode, only one
  239. function is displayed in the lower TextArea
  240. at a time.  Select ViewFunction from the
  241. MenuBar to display another function.
  242.  
  243. In Text mode, the whole file is displayed.
  244.  
  245. :HotProlog
  246. Display program PROLOG.
  247.  
  248. :HotNew
  249. Create a new text-file or program or GuiProgram
  250. and display it in the lower TextArea.
  251.  
  252.  * New TextFile clears the lower TextArea.
  253.  
  254.  * New Program creates a complete minimal
  255.    program with PROLOG and Entry() function.
  256.  
  257.  * New GuiProgram creates a complete minimal
  258.    GuiDesigner program with PROLOG, Entry(),
  259.    and other GuiDesigner-specific functions.
  260.    You need to layout a GuiDesigner window
  261.    with the toolkit and convert it into two
  262.    new functions in the program by selecting
  263.    "Window ToFunction" in the toolkit menu.
  264.  
  265. :HotLoad
  266. Load a program or text-file.
  267.  
  268. :HotSave
  269. Save current program or text-file.
  270.  
  271. :HotSavePlus
  272. Save current program or text-file.
  273. This capability will be enhanced
  274. someday to automatically save the
  275. file with version number suffixes.
  276.  
  277. :HotCut
  278. Cut selected text from lower TextArea
  279. and put a copy in the system clipboard.
  280.  
  281. :HotCopy
  282. Copy selected text from lower TextArea
  283. and put a copy in the system clipboard.
  284.  
  285. :HotPaste
  286. Paste the text in the system clipboard
  287. into the lower TextArea at the current
  288. text cursor position.
  289.  
  290. :HotGui
  291. Display / Hide the GuiDesigner toolkit window.
  292.  
  293. :HotAbort
  294. Abort the operation in progress:
  295.  
  296.   loading a program or text file
  297.   parsing a program
  298.   compiling a program
  299.   searching for a "find" string
  300.  
  301. :HotFind
  302. Find the most recent find string.
  303.  
  304.  shift-key down = search reverse
  305.  
  306. An F11 keystroke also executes HotFind.
  307.  
  308. :HotReplace
  309. Find the most recent find string and replace
  310. it with the most recent replace string.
  311.  
  312.  shift-key down = search reverse
  313.  
  314. An F12 keystroke also executes HotReplace.
  315.  
  316. :HotBack
  317. Display the function before this one.
  318. The order of functions corresponds to
  319. function declarations in the PROLOG.
  320.  
  321. :HotNext
  322. Display the function after this one.
  323. The order of functions corresponds to
  324. function declarations in the PROLOG.
  325.  
  326. :HotPrevious
  327. Display the previously displayed function.
  328.  
  329. :HotStart
  330. Start executing the program.  If changes to
  331. the program require that part or all of the
  332. program be recompiled, this will take place
  333. before execution.
  334.  
  335. An F1 keystroke also executes HotStart.
  336.  
  337. :HotContinue
  338. Continue program execution at the point it
  339. left off, if possible.
  340.  
  341. An F2 keystroke also executes HotContinue.
  342.  
  343. :HotPause
  344. Pause program execution.
  345.  
  346. An F3 keystroke also executes HotPause.
  347.  
  348. :HotKill
  349. Kill program execution.  Execution cannot
  350. pick up where it was terminated, but it can
  351. be restarted.
  352.  
  353. An F4 keystroke also executes HotKill.
  354.  
  355. :HotToCursor
  356. Place an invisible breakpoint at the cursor
  357. line and continue program execution until it
  358. hits any breakpoint.
  359.  
  360. The invisible breakpoint is removed when the
  361. program is paused, killed, or hits a breakpoint.
  362.  
  363. An F5 keystroke also executes HotToCursor.
  364.  
  365. :HotStepLocal
  366. Execute one program line.  If a function is
  367. called on the line, do not display execution
  368. in that function, just step to the next line
  369. in the current function.
  370.  
  371. StepLocal places breakpoints on every line in
  372. the displayed function, then continues.  If
  373. the function calls itself, StepLocal will step
  374. to the first executable line in the function.
  375.  
  376. An F6 keystroke also executes HotStepLocal.
  377.  
  378. :HotStepGlobal
  379. Execute one program line.  If a function in
  380. the current program is called on the line,
  381. display, step to the first executable line
  382. in that function.
  383.  
  384. StepGlobal places breakpoints on every line
  385. in the program, then continues running.
  386.  
  387. An F7 keystroke also executes HotStepGlobal.
  388.  
  389. :HotToggleBreakpoint
  390. Toggle breakpoint on cursor line on/off.
  391.  
  392. :HotClearBreakpoints
  393. Clear all breakpoints in the program.
  394.  
  395. :HotVariables
  396. The HotVariables button displays the values of
  397. all variables accessed by a function.  Programs
  398. must be paused for HotVariables to work.
  399.  
  400. When programs enter a paused state, the function
  401. executing when paused is displayed in the lower
  402. text area, and HotVariables displays its variables.
  403. Click the HotFrames button to display the series
  404. of functions that called the executing function,
  405. and select any function to examine its variables.
  406.  
  407. An F8 keystroke also executes HotVariables.
  408.  
  409. :HotFrames
  410. Display the stack of functions that have
  411. led to the current location in the program.
  412. The currently executing function is at the
  413. bottom of the list.
  414.  
  415. To learn the exact line in each function
  416. that called the next lower function, double
  417. click on the function name in the list.
  418.  
  419. An F9 keystroke also executes HotFrames.
  420.  
  421. :HotAssembly
  422. Disassemble the binary machine code for the
  423. program line containing the insert cursor and
  424. display the results.  The address, hexadecimal,
  425. and assembly for each machine instructions are
  426. displayed.
  427.  
  428. An F10 keystroke also executes HotAssembly.
  429.  
  430. :HotRegisters
  431. Display the contents of the CPU registers.
  432. The values are valid only when the program
  433. is paused because the program encountered
  434. a breakpoint or HotPause was selected.
  435.  
  436. :HotMemory
  437. Display a window that can display the contents
  438. of any valid memory locations in hexadecimal
  439. form or as disassembly.  Enter "m" in the
  440. TextLine at the bottom to see where valid
  441. memory regions are.  Trying to display any
  442. other regions may crash the whole environment!
  443.  
  444. :HelpWindow
  445. The HelpWindow is built into all programs developed
  446. with GuiDesigner.  Its purpose is to display helpful
  447. information, usually about the operation of the
  448. currently executing program.  Help text is displayed
  449. in the HelpWindow in response to user requests, or
  450. as directed by executing programs.
  451.  
  452. To request help, place the mouse cursor over any
  453. component of the user interface and press the right
  454. mouse button, which is called the "HelpButton".
  455. The help text for that component is displayed in
  456. the TextArea of the HelpWindow.
  457.  
  458. Help text is usually taken from a help file that
  459. contains all the help text for a single program.
  460. Such is the case when the HelpLabel above the help
  461. text contains a filename and entry name like the
  462. "pde.hlp:HelpWindow" at label at the top of
  463. the HelpWindow now.
  464.  
  465. "pde.hlp" is a file on disk that contains one
  466. or more help entries.  ":HelpWindow" is one of the
  467. entries in file "pde.hlp".  Entry names begin
  468. with a ":" and start at the first character position
  469. on the line.  All lines to the next entry name is
  470. the help text for the entry.
  471.  
  472. Text in the HelpWindow can be edited like any other
  473. text area.  Text is entered with the keyboard, and
  474. deleted by the "delete" and "backspace" keys.
  475. Sections of text deleted (or copied) from other
  476. windows are inserted at the cursor position
  477. by an "insert" keystroke.  Sections of the help
  478. text can be highlighted and deleted (or copied),
  479. and inserted into other text areas if desired.
  480.  
  481. When the "Update" button is pressed, the text in
  482. "filename.hlp:entry" is replaced by the current
  483. contents of the HelpWindow.
  484.  
  485. Sometimes help text is supplied directly by an
  486. executing program.  In this case the HelpLabel
  487. contains a title between square brackets, as in
  488. [CurrentTitle], or nothing at all.  In this case,
  489. the "Update" button has no effect.
  490.  
  491. The HelpWindow is hidden when the "Cancel" button
  492. is pressed, or forced to stay visible when the
  493. "POST" button is pressed.
  494.  
  495. :HelpLabel
  496. This label displays the "file:entry" name
  497. where the help information displayed below
  498. was found.  If the information is not from
  499. a text file, but supplied directly by a grid
  500. or an executing program, this label displays
  501. a [ Help Title ] in square brackets.
  502.  
  503. :HelpText
  504. This TextArea grid contains the help text for the
  505. grid whose name is displayed in the Label grid just
  506. above.  You can perform normal edit operations like
  507. cut/grab/paste on the contents of this TextArea grid,
  508. so you can extract useful information and change the
  509. help text.  If you change the contents of this grid
  510. and press the "Update" button below it, the help text
  511. for the named grid is updated, and further requests
  512. for help on the grid will show the modified help text.
  513. If you do not press the "Update" button, the help text
  514. in the help file is not updated.
  515.  
  516. :HelpPostHide
  517. Post or Hide the HelpWindow.  Press this button
  518. when it says "POST" to keep the HelpWindow from
  519. being hidden between help requests.  Press this
  520. button when it says "HIDE" to make the HelpWindow
  521. disappear.  The HelpWindow will display again the
  522. next time you press the right mouse button over a
  523. grid in your program for which there is help text.
  524.  
  525.  
  526. :HelpUpdate
  527. Update the help entry currently displayed in
  528. the HelpWindow.  The text in the HelpWindow is
  529. written to the "filename:entry" displayed above
  530. the text.  If "filename:entry" already exists,
  531. the new text replaces it.  The first time a help
  532. file is updated the original file is backed up
  533. as "filename.hhh" before "filename:entry" is
  534. changed and saved as "filename.hlp".  Original
  535. help filenames should end in ".hlp", not ".hhh"
  536. because no backup of the original would be left.
  537.  
  538. :HelpCancel
  539. Cancel the InstantHelp window, which hides it from
  540. sight.  It is displayed again the next time you press
  541. the HelpButton over another grid or otherwise request
  542. help from an application (via the main menu).
  543.  
  544.  
  545. :Toolkit
  546. With the GuiDesigner toolkit you can create, delete,
  547. and configure design windows, choose grids to layout
  548. in the design windows, check and set the appearance
  549. properties of the grids, and display the behavior of
  550. the grids (see how messages are processed).
  551.  
  552. *****
  553.  
  554. The "TestMode" CheckBox selects the operating mode
  555. of the displayed design window.  When in "TestMode",
  556. grids in the design window operate as they will in
  557. running programs.  When in "DesignMode", MouseDown
  558. and MouseDrag select/move/resize grids.
  559.  
  560. *****
  561.  
  562. The "_Window _Grid" MenuBar lets you select Window
  563. or Grid pulldown menus to operate on design windows,
  564. or grids in the displayed design window:
  565.  
  566. Window
  567.  New:           Create a new design window.
  568.  Hide:          Hide displayed design window.
  569.  Load:          Load a design window from disk.
  570.  Save:          Save design window to disk.
  571.  Delete:        Delete displayed design window.
  572.  ToFunction:    Create function from design window.
  573.  FromFunction:  Create design window from function.
  574.  HideToolkit:   Hide toolkit from view.
  575.  n: (name)...:  Display any existing design window.
  576.  
  577. Grid
  578.  Appearance:    Set appearance of selected grid.
  579.  Behavior:      See how grid messages are processed.
  580.  Delete:        Delete selected grid.
  581.  
  582. *****
  583.  
  584. The "DesignWindowName" TextLine lets you give a name
  585. to each design window.  Choose a valid symbol name,
  586. because the function created by WindowToFunction is
  587. given the same name as the design window from which
  588. it's created.
  589.  
  590. *****
  591.  
  592. The "Another" button lets you create another grid
  593. of the same type as the last selected grid.  Since
  594. every grid is created in the selected state, you
  595. can create a row or column of grids easily - just
  596. position the first grid, then click "Another" as
  597. many times as necessary to create subsequent grids.
  598.  
  599. *****
  600.  
  601. The rest of the PushButtons in the toolkit create
  602. grids of the types named on the buttons.  To create
  603. a "Label" grid, for example, click on the "Label"
  604. PushButton in the toolkit.
  605.  
  606. *****
  607.  
  608. For more detailed help on each element in the
  609. toolkit, point at them and click the right mouse
  610. button (the HelpButton).
  611.  
  612. :ToolkitMainMenu
  613. The "Window" pulldown menu lets you operate
  614. on design windows.
  615.  
  616. The "Grid" pulldown menu lets you operate on
  617. the selected grid in the displayed design
  618. window.
  619.  
  620. Window
  621.  New:           Create a new design window.
  622.  Hide:          Hide displayed design window.
  623.  Load:          Load a design window from disk.
  624.  Save:          Save design window to disk.
  625.  Delete:        Delete displayed design window.
  626.  ToFunction:    Create function from design window.
  627.  FromFunction:  Create design window from function.
  628.  HideToolkit:   Hide toolkit from view.
  629.  n: (name)...:  Display any existing design window.
  630.  
  631. Grid
  632.  Appearance:    Set appearance of selected grid.
  633.  Behavior:      See how grid messages are processed.
  634.  Delete:        Delete selected grid.
  635.  
  636.  
  637. :ToolkitMenuWindow
  638. New:          Create/Display a new design window.
  639. Hide:         Hide the displayed design window.
  640. Load:         Load a design window from disk.
  641. Save:         Save a design window to disk.
  642. Delete:       Delete the visible design window.
  643. ToFunction:   Convert design window to function.
  644. FromFunction: Make design window from function.
  645.  
  646. :ToolkitMenuGrid
  647. Appearance: Change appearance of selected grid.
  648. Behavior:   Check behavior of selected grid.
  649. Delete:     Delete the selected grid.
  650.  
  651. :ToolkitWindowDelete
  652. Delete the design window that is currently
  653. displayed.  The window and all grids in the
  654. window are destroyed and permanently lost.
  655.  
  656. :ToolkitWindowToFunction
  657. Generate a new grid function that creates
  658. a new type of grid from the contents of the
  659. currently displayed design window.
  660.  
  661. :ToolkitWindowFromFunction
  662. Create and display a design window, then
  663. fill it with grids like those defined in
  664. the "SUB Create" portion of the grid
  665. function currently displayed in the
  666. lower text area of the environment.
  667.  
  668. :ToolkitGridAppearance
  669. Display an "appearances window" that lets
  670. you set the appearance attributes of the
  671. selected grid.  When you change attributes
  672. in the appearance window, the selected grid
  673. changes appearance accordingly.
  674.  
  675. If no grid is selected, nothing happens.
  676.  
  677. :ToolkitGridBehavior
  678. GridBehavior displays a BehaviorWindow that
  679. displays the messages recognized by the grid
  680. most recently selected in a design window.
  681.  
  682. In the left column are the recognized messages.
  683. To its right is the message processing function
  684. or message processing subroutine executed by the
  685. grid function responsible for the grid when it
  686. receives the message.
  687.  
  688. If both a message processing function and a
  689. message processing subroutine exist for a grid,
  690. the message appears twice in the list.  The
  691. message processing function is executed first
  692. in most cases.  Functions called by message
  693. processing subroutines are not displayed.
  694.  
  695. The message processing functions and subroutines
  696. are executed by two lines at the beginning of
  697. grid functions as generated by GuiDesigner:
  698.  
  699.   XuiProcessMessage (grid, message, ... )
  700.   IF (message < upperMessage) THEN GOSUB @sub[message]
  701.  
  702. :ToolkitGridDelete
  703. Delete the selected grid from the active
  704. design window.
  705.  
  706. :ToolkitDesignWindowLabel
  707. Enter the name of the visible design window in
  708. the XuiTextLine grid below this label.
  709.  
  710. Design window names must be a valid symbols
  711. composed solely of alphabetic characters and
  712. no whitespace.  Grid functions generated from
  713. design windows are given the same name as the
  714. design window, so choose descriptive names!!!
  715.  
  716. :ToolkitDesignWindowName
  717. Enter the name of the active (displayed) design
  718. window in this TextLine grid.
  719.  
  720. The design window name must be a valid symbol
  721. name because the grid function created from the
  722. design window (by WindowToFunction) is given the
  723. same name as the design window.
  724.  
  725. Also make sure that no two design windows have
  726. the same name.  You can see the names of all
  727. design windows at the bottom of the "Window"
  728. pulldown menu in the toolkit.
  729.  
  730. :ToolkitAnother
  731. Create another grid of the same grid type
  732. as the most recently selected grid.
  733.  
  734. The created grid is the same size as the
  735. previously selected grid.  If there is
  736. room in the design window, the new grid
  737. is positioned relative to the previously
  738. selected grid in the following manner:
  739.  
  740. CntlKey  ShiftKey   
  741.   UP        UP      To right of previous.
  742.   UP       DOWN     Below previous.
  743.  DOWN       UP      To left of previous.
  744.  DOWN      DOWN     Above previous.
  745.  
  746. :ToolkitXuiArea
  747. Create an "XuiArea" grid in the design window.
  748.  
  749. Area grids send callback messages in response
  750. to all mouse messages except MouseMove.  Your
  751. program can put XuiArea grids in design windows
  752. wherever it needs to receive the following
  753. basic mouse messages:
  754.  
  755. MouseDown MouseDrag MouseEnter MouseExit MouseUp
  756.  
  757.   v0 = xWin of mouse cursor
  758.   v1 = yWin of mouse cursor
  759.   v2 = state (see GraphicsDesigner doc)
  760.   v3 = time  (see GraphicsDesigner doc)
  761.  
  762. :ToolkitXuiCheckBox
  763. Create an "XuiCheckBox" grid in the design window.
  764.  
  765. A XuiCheckBox toggles between checked and unchecked
  766. on MouseDown.  It is not checked when created.
  767.  
  768. When a XuiCheckBox enters the unchecked state, it
  769. sends a Selection callback message with v0 = 0.
  770.  
  771. When a XuiCheckBox enters the checked state, it
  772. sends a Selection callback message with v0 != 0.
  773.  
  774. :ToolkitXuiColor
  775. Create an "XuiColor" grid in the design window.
  776.  
  777. XuiColor grids are fixed-size rectangular areas
  778. containing small rectangular color samples of
  779. the 125 standard color numbers.
  780.  
  781. When MouseDown events occur on any color, an
  782. XuiColor grid sends a Selection callback with:
  783.  
  784.   v0 = standard color number (0 to 124)
  785.   v1 = red intensity (0 to 65535)
  786.   v2 = green intensity (0 to 65535)
  787.   v3 = blue intensity (0 to 65535)
  788.  
  789.   65535 = 0x0000FFFF  (maximum 16-bit value)
  790.  
  791. :ToolkitXuiDialog1B
  792. Create an "XuiDialog1B" grid in the design window.
  793.  
  794. XuiDialog1B grids contain:
  795.  
  796.   kid 0 = XuiDialog2B (appears as the frame)
  797.   kid 1 = Label       (across the top)
  798.   kid 2 = TextLine    (across the middle)
  799.   kid 3 = PushButton  ("Cancel" button)
  800.  
  801. XuiDialog1B grids send Selection callback messages:
  802.  
  803.   kid 2 : EnterKey or EscapeKey Down (v0 = state)
  804.   kid 3 : CancelButton selected
  805.  
  806. XuiDialog1B grids send TextEvent callback messages
  807. whenever any key is depressed (v0 = state).
  808.  
  809. The "state" argument is described in the
  810. HelpMessage section of the main menu.
  811.  
  812. :ToolkitXuiDialog2B
  813. Create an "XuiDialog2B" grid in the design window.
  814.  
  815. XuiDialog2B grids contain:
  816.  
  817.   kid 0 = XuiDialog2B (appears as the frame)
  818.   kid 1 = Label       (across the top)
  819.   kid 2 = TextLine    (across the middle)
  820.   kid 3 = PushButton  ("Enter" button)
  821.   kid 4 = PushButton  ("Cancel" button)
  822.  
  823. XuiDialog2B grids send Selection callback messages:
  824.  
  825.   kid 2 : EnterKey or EscapeKey Down (v0 = state)
  826.   kid 3 : EnterButton selected
  827.   kid 4 : CancelButton selected
  828.  
  829. XuiDialog2B grids send TextEvent callback messages
  830. whenever any key is depressed (v0 = state).
  831.  
  832. The "state" argument is described in the
  833. HelpMessages section of the main menu.
  834.  
  835. :ToolkitXuiDialog3B
  836. Create an "XuiDialog3B" grid in the design window.
  837.  
  838. XuiDialog3B grids contain:
  839.  
  840.   kid 0 = XuiDialog3B (appears as the frame)
  841.   kid 1 = Label       (across the top)
  842.   kid 2 = TextLine    (across the middle)
  843.   kid 3 = PushButton  ("Enter" button)
  844.   kid 4 = PushButton  ("Retry" button)
  845.   kid 5 = PushButton  ("Cancel" button)
  846.  
  847. XuiDialog3B grids send Selection callback messages:
  848.  
  849.   kid 2 : EnterKey or EscapeKey Down (v0 = state)
  850.   kid 3 : EnterButton selected
  851.   kid 4 : RetryButton selected
  852.   kid 5 : CancelButton selected
  853.  
  854. XuiDialog3B grids send TextEvent callback messages
  855. whenever any key is depressed (v0 = state).
  856.  
  857. The (r0 = kid) argument in the callback message
  858. identifies the kid that initiated the callback.
  859.  
  860. The "state" argument is described in the
  861. HelpMessages section of the main menu.
  862.  
  863. :ToolkitXuiDialog4B
  864. Create an "XuiDialog4B" grid in the design window.
  865.  
  866. XuiDialog4B grids contain:
  867.  
  868.   kid 0 = XuiDialog4B (appears as the frame)
  869.   kid 1 = Label       (across the top)
  870.   kid 2 = TextLine    (across the middle)
  871.   kid 3 = PushButton  ("Enter" button)
  872.   kid 4 = PushButton  ("Update" button)
  873.   kid 5 = PushButton  ("Retry" button)
  874.   kid 6 = PushButton  ("Cancel" button)
  875.  
  876. XuiDialog4B grids send Selection callback messages:
  877.  
  878.   kid 2 : EnterKey or EscapeKey Down (v0 = state)
  879.   kid 3 : EnterButton selected
  880.   kid 4 : UpdateButton selected
  881.   kid 5 : RetryButton selected
  882.   kid 6 : CancelButton selected
  883.  
  884. XuiDialog4B grids send TextEvent callback messages
  885. whenever any key is depressed (v0 = state).
  886.  
  887. The (r0 = kid) argument in the callback message
  888. identifies the kid that initiated the callback.
  889.  
  890. The "state" argument is described in the
  891. HelpMessages section of the main menu.
  892.  
  893. :ToolkitXuiFile
  894. Create an "XuiFile" grid in the design window.
  895.  
  896. Files grids contain:
  897.  
  898.   TextLine     - file names can be entered here
  899.   DriveBox     - select a system drive
  900.   DirectoryBox - select a subdirectory
  901.   FileBox      - select a file
  902.   EnterButton  - select the file in TextLine
  903.   CancelButton - select nothing, cancel request
  904.  
  905. XuiFile grids send Selection callbacks when a
  906. double click selects a file in the FileBox,
  907. and when an EnterKey is entered in the TextLine.
  908.  
  909. :ToolkitXuiFont
  910. Create an "XuiFont" grid in the design window.
  911.  
  912. XuiFont grids contain:
  913.     XuiLabel      - FontName label
  914.   XuiListBox    - FontName list
  915.     XuiLabel      - FontSize label
  916.     XuiDropBox    - FontSize drop down list
  917.     XuiLabel      - FontWeight label
  918.     XuiDropBox    - FontWeight drop down list
  919.     XuiLabel      - FontItalic label
  920.     XuiDropBox    - FontItalic drop down list
  921.   XuiLabel      - font samples drawn here
  922.   XuiPushButton - Enter  (select the font)
  923.   XuiPushButton - View  (view sample of the font)
  924.   XuiPushButton - Cancel  (cancel/hide font box)
  925.  
  926. :ToolkitXuiGraph
  927. Create an "XuiGraph" grid in the design window.
  928.  
  929. :ToolkitXuiLabel
  930. Create an "XuiLabel" grid in the design window.
  931.  
  932. XuiLabel grids display text strings and text arrays,
  933. but produce no callbacks.  They can also be used
  934. to draw graphics onto and as simple style areas.
  935.  
  936. Text strings with newline characters (\n) are
  937. displayed on multiple lines, as are the strings
  938. in the text array.  To print "\n" on a label,
  939. an extra backslash is required, as in "\\n".
  940.  
  941. :ToolkitXuiList
  942. Create an "XuiList" grid in the design window.
  943.  
  944. XuiList grids are scrollable lists of text entries.
  945.  
  946. XuiList grids send a Selection callback whenever an
  947. entry is double clicked or an EnterKey is pressed.
  948. The selected entry is drawn in the accent color.
  949. The UpArrow and DownArrow keys move the selected
  950. entry up and down.  The top entry in the list is
  951. entry number 0.
  952.  
  953. :ToolkitXuiDropButton
  954. Create an "XuiDropButton" grid in the design window.
  955. XuiListButton looks like a solitary button.
  956.  
  957. Select the button to hide and display an XuiPullDown
  958. grid below the button.  If the button has keyboard
  959. focus, Alt+UpArrow and Alt+DownArrow hide / display
  960. the "XuiPullDown" grid.
  961.  
  962. MouseUp on any "XuiPullDown" entry selects it.
  963. Or choose an entry with UpArrow / DownArrow keys,
  964. then select the entry with an Enter keystroke.
  965.  
  966. :ToolkitXuiDropBox
  967. Create an "XuiDropBox" grid in the design window.
  968.  
  969. :ToolkitXuiListBox
  970. Create an "XuiListBox" grid in the design window.
  971.  
  972. XuiListBox grids contain:
  973.  
  974.   TextLine  - shows selected item, can be edited
  975.   Button    - toggles PullDown list up and down
  976.   PullDown  - displays entries, supports selection
  977.  
  978. style bit 0 - TextLine editable/not-editable (0/1)
  979. style bit 1 - PullDown toggles/stays down (0/1)
  980.  
  981. The list box is under development.  The style bits
  982. will change in the next release with more choices.
  983.  
  984. :ToolkitXuiListButton
  985. Create an "XuiListButton" grid in the design window.
  986.  
  987. XuiListButton looks like a solitary button.
  988.  
  989. Select the button to hide and display an "XuiList"
  990. grid below the button.  If the button has keyboard
  991. focus, Alt+UpArrow and Alt+DownArrow hide / display
  992. the "XuiList" grid.
  993.  
  994. Double click any "XuiList" entry to select it.
  995. Or choose an entry with a single mouse click
  996. or the UpArrow / DownArrow keys, then select
  997. the highlighted entry with an Enter keystroke.
  998.  
  999. :ToolkitXuiListDialog2B
  1000. Create an "XuiListDialog2B" grid in the design window.
  1001.  
  1002. :ToolkitXuiMenu
  1003. Create an "XuiMenu" grid in the design window.
  1004.  
  1005. XuiMenu grids create a horizontal MenuBar and
  1006. as many XuiPullDown lists as there are headings
  1007. in the MenuBar.  To configure the MenuBar and
  1008. XuiPullDown menus, set the XuiMenu TextArray
  1009. property as follows:
  1010.  
  1011.   1. MenuBar entries start in first column.
  1012.   2. XuiPullDown entries follow, indented.
  1013.  
  1014.   Example:
  1015.  
  1016. _File  
  1017.  _Load
  1018.  _Save
  1019.  _Quit
  1020. _Edit  
  1021.  _Cut
  1022.  _Grab
  1023.  _Paste
  1024. _Help
  1025.  _Index
  1026.  _Summary
  1027.  _Contents
  1028.  
  1029. The _ characters cause an _ to be drawn under
  1030. the following character.  Underlined characters
  1031. in the menu bar can be selected by pressing
  1032. Alt+Key.  Pulldown list entries can be selected
  1033. by pressing Key.  (Key = underlined character).
  1034.  
  1035. To configure an XuiMenu in a design window, select
  1036. the XuiMenu grid, double click it to display the
  1037. AppearanceWindow, then click the TextArray button
  1038. to display the TextArray Window.
  1039.  
  1040. Enter the XuiMenu data in the TextArray window as
  1041. described above.
  1042.  
  1043. XuiMenu grids send a callback message when a menu
  1044. entry is selected.  v0 = -1 for cancel (no entry):
  1045.  
  1046.   v0 = MenuBar entry (1,2,3,4,5,6...)
  1047.   v1 = XuiPullDown entry (0,1,2,3,4...)
  1048.  
  1049. For example, if you select HelpSummary, the
  1050. Selection callback arguments will be:
  1051.  
  1052.   v0 = 3   Help       (File,Edit,Help)
  1053.   v1 = 1   Summary    (Index,Summary,Contents)
  1054.  
  1055. Two space characters are automatically appended
  1056. to MenuBar entries that do not already end with
  1057. a space character.  To specify more or less space
  1058. following each MenuBar entry, simply append space
  1059. characters to the end of the MenuBar entry names
  1060. in the TextArray property.
  1061.  
  1062. :ToolkitXuiMenuBar
  1063. Create an "XuiMenuBar" grid in the design window.
  1064.  
  1065. XuiMenuBar grids display a horizontal row of
  1066. headings, each of which can have a "HotKey"
  1067. (the character following an _underline).
  1068.  
  1069. XuiMenuBar grids send Selection callback messages
  1070. when a heading is selected by AltKey + HotKey,
  1071. or by MouseDown or MouseDrag in the heading.
  1072.  
  1073. :ToolkitXuiMessage1B
  1074. Create an "XuiMessage1B" grid in the design window.
  1075.  
  1076. XuiMessage1B grids contain:
  1077.  
  1078.   kid 0 = XuiMessage1B  (appears as the frame)
  1079.   kid 1 = Label         (across the top)
  1080.   kid 2 = PushButton    ("Cancel" button)
  1081.  
  1082. XuiMessage1B grids send Selection callback messages:
  1083.  
  1084.   kid 0 : v0 = 0/-1 on EnterKey / EscapeKey
  1085.   kid 2 : CancelButton selected
  1086.  
  1087. :ToolkitXuiMessage2B
  1088. Create an "XuiMessage2B" grid in the design window.
  1089.  
  1090. XuiMessage2B grids contain:
  1091.  
  1092.   kid 0 = XuiMessage2B  (appears as the frame)
  1093.   kid 1 = Label         (across the top)
  1094.   kid 2 = PushButton    ("Enter" button)
  1095.   kid 3 = PushButton    ("Cancel" button)
  1096.  
  1097. XuiMessage2B grids send Selection callback messages:
  1098.  
  1099.   kid 0 : v0 = 0/-1 on EnterKey / EscapeKey
  1100.   kid 2 : EnterButton selected
  1101.   kid 3 : CancelButton selected
  1102.  
  1103. :ToolkitXuiMessage3B
  1104. Create an "XuiMessage3B" grid in the design window.
  1105.  
  1106. XuiMessage3B grids contain:
  1107.  
  1108.   kid 0 = XuiMessage3B  (appears as the frame)
  1109.   kid 1 = Label         (across the top)
  1110.   kid 2 = PushButton    ("Enter" button)
  1111.   kid 3 = PushButton    ("Retry" button)
  1112.   kid 4 = PushButton    ("Cancel" button)
  1113.  
  1114. XuiMessage3B grids send Selection callback messages:
  1115.  
  1116.   kid 0 : v0 = 0/-1 on EnterKey / EscapeKey
  1117.   kid 2 : Left Button selected
  1118.   kid 3 : Center Button selected
  1119.   kid 4 : Right Button selected
  1120.  
  1121. :ToolkitXuiMessage4B
  1122. Create an "XuiMessage4B" grid in the design window.
  1123.  
  1124. XuiMessage4B grids contain:
  1125.  
  1126.   kid 0 = XuiMessage4B  (appears as the frame)
  1127.   kid 1 = Label         (across the top)
  1128.   kid 2 = PushButton    ("Enter" button)
  1129.   kid 3 = PushButton    ("Option1" button)
  1130.   kid 4 = PushButton    ("Option2" button)
  1131.   kid 5 = PushButton    ("Cancel" button)
  1132.  
  1133. Message4B grids send Selection callback messages:
  1134.  
  1135.   kid 0 : v0 = 0/-1 on EnterKey / EscapeKey
  1136.   kid 2 : Enter Button selected
  1137.   kid 3 : Option1 Button selected
  1138.   kid 4 : Option2 Button selected
  1139.   kid 5 : Cancel Button selected
  1140.  
  1141. :ToolkitXuiPressButton
  1142. Create an "XuiPressButton" grid in the design window.
  1143.  
  1144. XuiPressButton grids immediately generate Selection
  1145. callback messages in response to a MouseDown events.
  1146. In contrast, XuiPushButton grids generate Selection
  1147. callback messages in response to MouseDown+MouseUp.
  1148.  
  1149. :ToolkitXuiProgress
  1150. Create an "XuiProgress" grid in the design window.
  1151.  
  1152. :ToolkitXuiPrompt4B
  1153. Create an "XuiPrompt4B" grid in the design window.
  1154.  
  1155. :ToolkitXuiPullDown
  1156. Create an "XuiPullDown" grid in the design window.
  1157.  
  1158. XuiPullDown grids contain a list of text entries.
  1159. The top entry is entry number 0.
  1160.  
  1161. XuiPullDown grids send Selection callback messages
  1162. when an entry is selected by a MouseUp over the
  1163. entry.  v0 = entry #, where the top entry = 0.
  1164.  
  1165. XuiPullDown grids will not resize smaller than is
  1166. necessary to display the entries they contain.
  1167.  
  1168. :ToolkitXuiPushButton
  1169. Create an "XuiPushButton" grid in the design window.
  1170.  
  1171. PushButton grids are selected by mouse events:
  1172.  
  1173.   style = 0  - MouseDown/MouseUp in the same grid
  1174.   style = 1  - MouseDown
  1175.   style = 2  - same as style 0 but with "flat" look
  1176.  
  1177. XuiPushButton grids send a Selection callback when
  1178. selected, with v0/v1 = xWin,yWin of mouse cursor.
  1179.  
  1180. :ToolkitXuiRadioBox
  1181. Create an "XuiRadioBox" grid in the design window.
  1182.  
  1183. XuiRadioBox grids are selected by MouseDown:
  1184.  
  1185. Every XuiRadioBox with the same parent (enclosing)
  1186. grid is a member of that XuiRadioBox group.  Only
  1187. one XuiRadioBox in a group is selected at a time.
  1188. When a XuiRadioBox is selected, it first deselects
  1189. any currently selected XuiRadioBox in the group.
  1190.  
  1191. XuiRadioBox grids send a Selection callback when
  1192. deselected/selected with v0 = -1/0.
  1193.  
  1194. :ToolkitXuiRadioButton
  1195. Create an "XuiRadioButton" grid in the design window.
  1196.  
  1197. XuiRadioButton grids are selected by MouseDown:
  1198.  
  1199. Every XuiRadioButton with the same parent (enclosing)
  1200. grid is a member of that XuiRadioButton group.  Only
  1201. one XuiRadioButton in a group is selected at a time.
  1202. When a XuiRadioButton is selected, it first deselects
  1203. any currently selected XuiRadioButton in the group.
  1204.  
  1205. XuiRadioButton grids send a Selection callback when
  1206. deselected/selected with v0 = -1/0.
  1207.  
  1208. :ToolkitXuiRange
  1209. Create an "XuiRange" grid in the design window.
  1210.  
  1211. :ToolkitXuiScrollBarH
  1212. Create an "XuiScrollBarH" grid in the design window.
  1213.  
  1214. XuiScrollBarH grids are horizontal position controls
  1215. with no kids, but the following components:
  1216.  
  1217.   LeftButton  - Left end of XuiScrollBarH
  1218.   RightButton - Right end of XuiScrollBarH
  1219.   Trough      - Extends from left to right button
  1220.   Slider      - Moves left right in the trough
  1221.  
  1222. XuiScrollBarH grids send callback messages as follows:
  1223.  
  1224.   OneLess     - MouseDown on LeftButton
  1225.   OneMore     - MouseDown on RightButton
  1226.   SomeLess    - MouseDown in trough left of slider
  1227.   SomeMore    - MouseDown in trough right of slider
  1228.   Change      - MouseDrag slider left or right
  1229.                 v0 = zero  (left end of trough)
  1230.                 v1 = low   (left end of slider)
  1231.                 v2 = high  (right end of slider)
  1232.                 v3 = top   (right end of trough)
  1233.  
  1234. Send SetPosition to XuiScrollBarH to position the
  1235. slider in the trough.  The v0 to v3 arguments are
  1236. the same as above, except they can be in any units,
  1237. not necessarily pixels (as reported by Change).
  1238.  
  1239. XuiScrollBarH will draw left:right arrows in the
  1240. left:right buttons if style bits 1:0 are set.
  1241.  
  1242. :ToolkitXuiScrollBarV
  1243. Create an "XuiScrollBarV" grid in the design window.
  1244.  
  1245. XuiScrollBarV grids are vertical position controls
  1246. with no kids, but the following components:
  1247.  
  1248.   TopButton    - Top of XuiScrollBarV
  1249.   BottomButton - Bottom of XuiScrollBarV
  1250.   Trough       - Extends from top to bottom button
  1251.   Slider       - Moves up/down in the trough
  1252.  
  1253. XuiScrollBarV grids send callback messages as follows:
  1254.  
  1255.   OneLess     - MouseDown on Top Button
  1256.   OneMore     - MouseDown on Bottom Button
  1257.   SomeLess    - MouseDown in trough above slider
  1258.   SomeMore    - MouseDown in trough below slider
  1259.   Change      - MouseDrag slider up or down
  1260.                 v0 = zero  (top end of trough)
  1261.                 v1 = low   (top end of slider)
  1262.                 v2 = high  (bottom end of slider)
  1263.                 v3 = top   (bottom end of trough)
  1264.  
  1265. Send SetPosition to XuiScrollBarV to position the
  1266. slider in the trough.  The v0 to v3 arguments are
  1267. the same as above, except they can be in any units,
  1268. not necessarily pixels (as reported by Change).
  1269.  
  1270. XuiScrollBarV will draw up:down arrows in the
  1271. top:bottom buttons if style bits 1:0 are set.
  1272.  
  1273. :ToolkitXuiSpin
  1274. Create an "XuiSpin" grid in the design window.
  1275.  
  1276. :ToolkitXuiTextArea
  1277. Create an "XuiTextArea" grid in the design window.
  1278.  
  1279. XuiTextArea grids are multi-line editable scrollable
  1280. text fields.  They have basic edit abilities like
  1281. selection, cut/grab/paste : delete/buffer/insert.
  1282. Cursor control keys are supported.
  1283.  
  1284.   kid 0  - XuiTextArea
  1285.   kid 1  - TextField      - 0 & 1 merged currently
  1286.   kid 2  - ScrollBarH
  1287.   kid 3  - ScrollBarV
  1288.  
  1289. XuiTextArea grids send a TextEvent callback every time
  1290. a character is pressed.  If the callback function
  1291. returns r0 = -1, the keystroke is canceled and the
  1292. text does not change.
  1293.  
  1294. GetTextArray gets a copy of the text array.
  1295. SetTextArray sets a copy of a text array in the grid.
  1296. GrabTextArray removes the text array from the grid,
  1297.   leaving the grid with an empty array.
  1298. PokeTextArray installs a text array in the grid,
  1299.   returning an empty array.
  1300.  
  1301. :ToolkitXuiTextArea3B
  1302. Create an "XuiTextArea3B" grid in the design window.
  1303.  
  1304. XuiTextArea3B grids contain:
  1305.  
  1306.   kid 0 - XuiTextArea3B - the outer frame
  1307.   kid 1 - Label         - across top
  1308.   kid 2 - TextArea      - multi-line text editor
  1309.   kid 3 - PushButton    - left button
  1310.   kid 4 - PushButton    - center button
  1311.   kid 5 - PushButton    - right button
  1312.  
  1313. :ToolkitXuiTextArea4B
  1314. Create an "XuiTextArea4B" grid in the design window.
  1315.  
  1316. XuiTextArea4B grids contain:
  1317.  
  1318.   kid 0 - XuiTextArea4B - the outer frame
  1319.   kid 1 - Label         - across top
  1320.   kid 2 - TextArea      - multi-line text editor
  1321.   kid 3 - PushButton    - left button
  1322.   kid 4 - PushButton    - left-center button
  1323.   kid 5 - PushButton    - right-center button
  1324.   kid 6 - PushButton    - right button
  1325.  
  1326. :ToolkitXuiTextLine
  1327. Create an "XuiTextLine" grid in the design window.
  1328.  
  1329. XuiTextLine grids are single line editable text fields.
  1330.  
  1331.   kid 0 - outer border
  1332.   kid 1 - single line text field  (merged with 0)
  1333.  
  1334. XuiTextLine grids send a TextEvent callback whenever a
  1335. keystroke occurs.  If the callback function returns
  1336. r0 = -1, the keystroke is canceled.
  1337.  
  1338. XuiTextLine grids send a Selection callback whenever
  1339. an EnterKey is pressed.
  1340.  
  1341. :ToolkitXuiToggleButton
  1342. Create an "XuiToggleButton" grid in the design window.
  1343.  
  1344. :AppearanceWindow
  1345. Set the appearance properties of a grid
  1346. in the displayed design window.
  1347.  
  1348. :AppearanceMenu
  1349. Select a kid of the most recently selected grid
  1350. to view and set the appearance properties of.
  1351. Simple grids do not have kid grids and the Kids
  1352. pulldown menu only contains the base grid.
  1353.  
  1354. Select a kid from the pulldown to display the
  1355. appearance properties for that kid.  You can
  1356. modify them just like the main grid.
  1357.  
  1358. :AppearanceGridTypeLabel
  1359. The GridType label indicates that the text to its
  1360. right is the GridType name of the selected grid.
  1361.  
  1362. The name of the GridType and GridFunction must be
  1363. the same.
  1364.  
  1365. :AppearanceGridTypeText
  1366. The "GridType" of the selected grid.
  1367.  
  1368. :AppearanceGridFuncLabel
  1369. This label indicates that the label
  1370. to its right contains the name of the
  1371. GridFunction of the selected grid.
  1372.  
  1373. :AppearanceGridFuncText
  1374. The "GridFunction" of the selected grid.
  1375.  
  1376. :AppearanceGridNameLabel
  1377. This label indicates that the label
  1378. to its right contains the name of the
  1379. selected grid.
  1380.  
  1381. :AppearanceGridNameText
  1382. The name of the selected grid.
  1383.  
  1384. A default name is created for every
  1385. grid, but you should replace it with
  1386. a more descriptive name.  The variable
  1387. that contains the grid number of the
  1388. selected grid is given this name.
  1389. The help string also defaults to this
  1390. name unless an explicit help string
  1391. name is entered.
  1392.  
  1393. :AppearanceHintStringLabel
  1394. This label indicates that the TextLine grid
  1395. to the right contains the hint string for
  1396. the selected grid.
  1397.  
  1398. :AppearanceHintStringText
  1399. This is the hint string for the selected grid.
  1400.  
  1401. :AppearanceHelpStringLabel
  1402. This label indicates that the TextLine
  1403. grid to its right contains the name of
  1404. the help string for the selected grid.
  1405.  
  1406. :AppearanceHelpStringText
  1407. The name of the help string for the
  1408. selected grid.  If this is an empty
  1409. string, the help string defaults to
  1410. the grid name.
  1411.  
  1412. If an explicit help string name is
  1413. entered, make sure you enter a valid
  1414. help string name, such as:
  1415.  
  1416.   helpfile.hlp:entryname
  1417.   :entryname
  1418.   [heading]\nHelp text line\n...or lines.
  1419.   Help text line\n... or lines
  1420.  
  1421. :AppearanceBackgroundColorButton
  1422. Click this button before you set the
  1423. Background color of the selected grid.
  1424.  
  1425. Then click on colors in the color
  1426. palette to change the Background
  1427. color of the selected grid.
  1428.  
  1429. The Background color is the color grids
  1430. are cleared to before other elements
  1431. like borders and text are drawn.
  1432.  
  1433. :AppearanceBackgroundColor
  1434. The Background color of the selected grid.
  1435.  
  1436. :AppearanceDrawingColorButton
  1437. Click this button before you set the
  1438. Drawing color of the selected grid.
  1439.  
  1440. Then click on colors in the color
  1441. palette to change the Drawing color
  1442. of the selected grid.
  1443.  
  1444. The Drawing color is the color in
  1445. which normal (non-textured) text
  1446. is drawn.
  1447.  
  1448. :AppearanceDrawingColor
  1449. The Drawing color of the selected grid.
  1450.  
  1451. :AppearanceLowlightColorButton
  1452. Click this button before you set the
  1453. Lowlight color of the selected grid.
  1454.  
  1455. Then click on colors in the color
  1456. palette to change the Lowlight color
  1457. of the selected grid.
  1458.  
  1459. The Lowlight color is the darker
  1460. color in 3D and other borders.
  1461.  
  1462. :AppearanceLowlightColor
  1463. The Lowlight color of the selected grid.
  1464.  
  1465. :AppearanceHightlightColorButton
  1466. Click this button before you set the
  1467. Highlight color of the selected grid.
  1468.  
  1469. Then click on colors in the color
  1470. palette to change the Highlight color
  1471. of the selected grid.
  1472.  
  1473. The Highlight color is the lighter
  1474. color in 3D and other borders.
  1475.  
  1476. :AppearanceHighlightColor
  1477. The Highlight color of the selected grid.
  1478.  
  1479. :AppearanceDullColorButton
  1480. Click this button before you set the
  1481. Dull color of the selected grid.
  1482.  
  1483. Then click on colors in the color
  1484. palette to change the Dull color
  1485. of the selected grid.
  1486.  
  1487. The Dull color is the color in which
  1488. text and other features of disabled
  1489. choices are displayed.
  1490.  
  1491. :AppearanceDullColor
  1492. The Dull color of the selected grid.
  1493.  
  1494. :AppearanceAccentColorButton
  1495. Click this button before you set the
  1496. Accent color of the selected grid.
  1497.  
  1498. Then click on colors in the color
  1499. palette to change the Accent color
  1500. of the selected grid.
  1501.  
  1502. The Accent color is the color in which
  1503. selected text and other features are
  1504. displayed (as in pulldown entries).
  1505.  
  1506. :AppearanceAccentColor
  1507. The Accent color of the selected grid.
  1508.  
  1509. :AppearanceLowtextColorButton
  1510. Click this button before you set the
  1511. Lowtext color of the selected grid.
  1512.  
  1513. Then click on colors in the color
  1514. palette to change the Lowtext color
  1515. of the selected grid.
  1516.  
  1517. The Lowtext color is the darker
  1518. "shadow" color of textured text.
  1519. (Textured text = raised or inset).
  1520.  
  1521. :AppearanceLowtextColor
  1522. The Lowtext color of the selected grid.
  1523.  
  1524. :AppearanceHightextColorButton
  1525. Click this button before you set the
  1526. Hightext color of the selected grid.
  1527.  
  1528. Then click on colors in the color
  1529. palette to change the Hightext color
  1530. of the selected grid.
  1531.  
  1532. The Hightext color is the lighter
  1533. "highlight" color of textured text.
  1534. (Textured text = raised or inset).
  1535.  
  1536. :AppearanceHightextColor
  1537. The Hightext color of the selected grid.
  1538.  
  1539. :AppearanceColorPalette
  1540. Click on any color in the standard
  1541. color palette to assign that color
  1542. to the previously designated color
  1543. attribute of the selected grid.
  1544.  
  1545. Be sure to press the desired color
  1546. attribute button before you select
  1547. colors.  Selected colors appear in
  1548. the samples squares to the right of
  1549. the color attribute buttons.
  1550.  
  1551. The color attribute buttons are
  1552. Background, Drawing, Lowlight,
  1553. Highlight, Dull, Accent, Lowtext,
  1554. and Hightext.
  1555.  
  1556. :AppearanceSolidColor
  1557. Click on any color in the solid
  1558. color palette to assign that color
  1559. to the designated color attribute
  1560. of the selected grid.
  1561.  
  1562. The 16 colors in this solid color
  1563. palette are the 16 colors that are
  1564. displayed without dithering on most
  1565. systems that display only 16 colors.
  1566.  
  1567. Be sure to press the desired color
  1568. attribute button before you select
  1569. colors.  Selected colors appear in
  1570. the samples squares to the right of
  1571. the color attribute buttons.
  1572.  
  1573. The color attribute buttons are
  1574. Background, Drawing, Lowlight,
  1575. Highlight, Dull, Accent, Lowtext,
  1576. and Hightext.
  1577.  
  1578. :AppearanceBorders
  1579. In this rectangle are a number of
  1580. border style samples.  Click on any
  1581. of them to change the "up" border
  1582. style of the selected grid.  Hold
  1583. the "Shift" key down to change the
  1584. "down" border style.
  1585.  
  1586. :AppearanceBorderNone
  1587. Border style = no border drawn
  1588. Border color = none
  1589. Border name  = $$XuiNone
  1590. Border width = 0
  1591.  
  1592. :AppearanceBorderFlat1
  1593. Border style = 1 pixel wide flat
  1594. Border color = Background color
  1595. Border name  = $$XuiFlat1
  1596. Border width = 1
  1597.  
  1598. :AppearanceBorderFlat2
  1599. Border style = 2 pixel wide flat
  1600. Border color = Background color
  1601. Border name  = $$XuiFlat2
  1602. Border width = 2
  1603.  
  1604. :AppearanceBorderFlat4
  1605. Border style = 4 pixel wide flat
  1606. Border color = Background color
  1607. Border name  = $$XuiFlat4
  1608. Border width = 4
  1609.  
  1610. :AppearanceBorderHiLine1
  1611. Border style = 1 pixel wide line
  1612. Border color = Highlight color
  1613. Border name  = $$XuiHiLine1
  1614. Border width = 1
  1615.  
  1616. :AppearanceBorderHiLine2
  1617. Border style = 2 pixel wide line
  1618. Border color = Highlight color
  1619. Border name  = $$XuiHiLine2
  1620. Border width = 2
  1621.  
  1622. :AppearanceBorderHiLine4
  1623. Border style = 4 pixel wide line
  1624. Border color = Highlight color
  1625. Border name  = $$XuiHiLine4
  1626. Border width = 4
  1627.  
  1628. :AppearanceBorderRaise1
  1629. Border style = raised 1 pixel
  1630. Border color = Highlight and Lowlight
  1631. Border name  = $$XuiRaise1
  1632. Border width = 1
  1633.  
  1634. :AppearanceBorderRaise2
  1635. Border style = raised 2 pixel
  1636. Border color = Highlight and Lowlight
  1637. Border name  = $$XuiRaise2
  1638. Border width = 2
  1639.  
  1640. :AppearanceBorderRaise4
  1641. Border style = raised 4 pixel
  1642. Border color = Highlight and Lowlight
  1643. Border name  = $$XuiRaise4
  1644. Border width = 4
  1645.  
  1646. :AppearanceBorderRidge
  1647. Border style = 1 pixel high ridge
  1648. Border color = Highlight and Lowlight
  1649. Border name  = $$XuiRidge
  1650. Border width = 2
  1651.  
  1652. :AppearanceBorderValley
  1653. Border style = 1 pixel deep valley
  1654. Border color = Highlight and Lowlight
  1655. Border name  = $$XuiValley
  1656. Border width = 2
  1657.  
  1658. :AppearanceBorderFrame
  1659. Border style = 1 pixel high frame
  1660. Border color = Highlight and Lowlight
  1661. Border name  = $$XuiFrame
  1662. Border width = 4
  1663.  
  1664. :AppearanceBorderDrain
  1665. Border style = 1 pixel deep drain
  1666. Border color = Highlight and Lowlight
  1667. Border name  = $$XuiDrain
  1668. Border width = 4
  1669.  
  1670. :AppearanceBorderLoLine1
  1671. Border style = 1 pixel wide dark line
  1672. Border color = Lowlight color
  1673. Border name  = $$XuiLoLine1
  1674. Border width = 1
  1675.  
  1676. :AppearanceBorderLoLine2
  1677. Border style = 2 pixel wide dark line
  1678. Border color = Lowlight color
  1679. Border name  = $$XuiLoLine2
  1680. Border width = 2
  1681.  
  1682. :AppearanceBorderLoLine4
  1683. Border style = 4 pixel wide dark line
  1684. Border color = Lowlight color
  1685. Border name  = $$XuiLoLine4
  1686. Border width = 4
  1687.  
  1688. :AppearanceBorderLower1
  1689. Border style = lowered 1 pixel
  1690. Border color = Highlight and Lowlight
  1691. Border name  = $$XuiLower1
  1692. Border width = 1
  1693.  
  1694. :AppearanceBorderLower2
  1695. Border style = lowered 2 pixel
  1696. Border color = Highlight and Lowlight
  1697. Border name  = $$XuiLower2
  1698. Border width = 2
  1699.  
  1700. :AppearanceBorderLower4
  1701. Border style = lowered 4 pixel
  1702. Border color = Highlight and Lowlight
  1703. Border name  = $$XuiLower4
  1704. Border width = 4
  1705.  
  1706. :AppearanceTextStringLabel
  1707. This label indicates that the text line
  1708. to its right contains the name of the
  1709. text string for the selected grid.
  1710.  
  1711. :AppearanceTextStringText
  1712. The text string for the selected grid.
  1713.  
  1714. :AppearanceTextTextureLabel
  1715. This label indicates that the buttons to
  1716. the right control the texture appearance
  1717. of text in grids that support text texture.
  1718.  
  1719. Flat    - Drawing color
  1720. Lower   - Lowtext color with Hightext shadow
  1721. Raise   - Hightext color with Lowtext shadow
  1722. Shadow  - Hightext color with Lowtext shadow
  1723.  
  1724. :AppearanceFlatButton
  1725. Display text with flat appearance.
  1726. Text is drawn in Drawing color.
  1727.  
  1728. :AppearanceLowerButton
  1729. Display text with depressed appearance.
  1730. Text is drawn in Lowtext color with
  1731. a highlight in Hightext color.
  1732.  
  1733. :AppearanceRaiseButton
  1734. Display text with raised appearance.
  1735. Text is drawn in Hightext color with
  1736. a highlight in Lowtext color.
  1737.  
  1738. :AppearanceShadowButton
  1739. Display text with shadow appearance.
  1740. Text is drawn in Hightext color with a
  1741. shadow in Lowtext color offset 4 pixels.
  1742.  
  1743. :AppearanceJustifyLabel
  1744. Text justification for text in the selected grid
  1745. is set by the four buttons to the right to:
  1746.  
  1747.   JustifyLeft
  1748.   JustifyCenter
  1749.   JustifyRight
  1750.   JustifyBoth
  1751.  
  1752. Not all grids support all these selections.
  1753.  
  1754. :AppearanceJustifyLeftButton
  1755. Left justify text in the selected grid.
  1756.  
  1757. :AppearanceJustifyCenterButton
  1758. Center justify text in the selected grid.
  1759.  
  1760. :AppearanceJustifyRightButton
  1761. Right justify text in the selected grid.
  1762.  
  1763. :AppearanceJustifyBothButton
  1764. Left and Right justify text in the selected grid.
  1765.  
  1766. :AppearanceAlignUpperLeftButton
  1767. Display text in upper left corner of selected grid.
  1768.  
  1769. :AppearanceAlignUpperCenterButton
  1770. Display text in upper center part of selected grid.
  1771.  
  1772. :AppearanceAlignUpperRightButton
  1773. Display text in upper right corner of selected grid.
  1774.  
  1775. :AppearanceAlignMiddleLeftButton
  1776. Display text in middle left side of selected grid.
  1777.  
  1778. :AppearanceAlignMiddleCenterButton
  1779. Display text in middle center of selected grid.
  1780.  
  1781. :AppearanceAlignMiddleRightButton
  1782. Display text in middle right side of selected grid.
  1783.  
  1784. :AppearanceAlignLowerLeftButton
  1785. Display text in lower left corner of selected grid.
  1786.  
  1787. :AppearanceAlignLowerCenterButton
  1788. Display text in lower center part of selected grid.
  1789.  
  1790. :AppearanceAlignLowerRightButton
  1791. Display text in lower right corner of selected grid.
  1792.  
  1793. :AppearanceIndentLeftRange
  1794. The IndentLeft property of the selected grid is
  1795. displayed in and can be set with this Range grid.
  1796.  
  1797. :AppearanceIndentRightRange
  1798. The IndentRight property of the selected grid is
  1799. displayed in and can be set with this Range grid.
  1800.  
  1801. :AppearanceIndentTopRange
  1802. The IndentTop property of the selected grid is
  1803. displayed in and can be set with this Range grid.
  1804.  
  1805. :AppearanceIndentBottomRange
  1806. The IndentBottom property of the selected grid is
  1807. displayed in and can be set with this Range grid.
  1808.  
  1809. :AppearanceStyleLabel
  1810. The style number of the selected grid is displayed
  1811. in and set by the XuiRange grid next to this label.
  1812.  
  1813. :AppearanceTimerLabel
  1814. The msec timer of the selected grid is displayed
  1815. in and set by the XuiRange grid next to this label.
  1816.  
  1817. :AppearanceStyleRange
  1818. The style number of the selected grid is displayed here.
  1819. You can slewed the style number up/down to change it.
  1820. A style of 0 is the default style for all grid types.
  1821.  
  1822. :AppearanceTimerRange
  1823. The millisecond timer value of the selected grid is
  1824. displayed here.  You can slew the timer value up/down
  1825. to change it.  A value of 0 disables the timer.
  1826.  
  1827. :AppearanceFontButton
  1828. Display / Hide the XuiFont grid that lets you see and
  1829. change the Font property of the selected grid.
  1830.  
  1831. :AppearanceTextArrayButton
  1832. Display / Hide the XuiTextArea grid that lets you see
  1833. and change the TextArray property of the selected grid.
  1834.  
  1835. :AppearanceImageButton
  1836. Display / Hide the File grid that lets you see
  1837. and change the filename of the image property
  1838. of the selected grid.
  1839.  
  1840. :AppearanceEnterButton
  1841. Assign contents of the appearance window
  1842. to the grid properties.  This assures the
  1843. current state of the properties in the
  1844. appearance window are assigned to the
  1845. selected grid.  
  1846.  
  1847. :AppearanceRestoreButton
  1848. Restore the appearance properties of
  1849. the selected grid to the values it had
  1850. before the current session started in
  1851. the appearance window.
  1852.  
  1853. :AppearanceDefaultsButton
  1854. Set the appearance properties of the
  1855. selected grid to the default values
  1856. of that grid type.  These are the
  1857. properties the grid type has just
  1858. after it is created, before any
  1859. appearance properties are changed.
  1860.  
  1861. :AppearanceCancelButton
  1862. Remove the appearance window from the display.
  1863.  
  1864. The appearance window can be displayed again in two ways.
  1865. You must be in "DesignMode" (not "TestMode"), and have a
  1866. a grid in the design window selected.  Then...
  1867.  
  1868. 1.  Double-click the selected grid in the design window.
  1869. 2.  Select GridAppearances entry in the toolkit MenuBar.
  1870.  
  1871. :AppearanceTextArray
  1872. Enter text for the TextArray property of
  1873. the selected grid.
  1874.  
  1875. This window is displayed by clicking on
  1876. the "TextArray" button in the Appearance
  1877. Window.  To update the TextArray property
  1878. of the selected grid, edit the TextArray,
  1879. then click on the "TextArray" button again.
  1880.  
  1881.  
  1882.  
  1883. :DesignWindowBackground
  1884. This "GraphGrid" is not part of the design window,
  1885. and does not appear in the grid or window created
  1886. by SaveGrid or SaveWindow.
  1887.  
  1888. :ToolkitTestMode
  1889. The "TestMode" CheckBox selects the operating mode
  1890. of the displayed design window.
  1891.  
  1892. TestMode   : CheckBox is checked.
  1893. DesignMode : CheckBox is not checked.
  1894.  
  1895. *****  TestMode  *****
  1896.  
  1897. When in test mode, grids in the design window
  1898. operate pretty much the same as in running
  1899. programs.  When an event occurs that would
  1900. generate a callback in a running program, a
  1901. callback message is printed in the console.
  1902.  
  1903. *****  DesignMode  *****
  1904.  
  1905. When in design mode, MouseDown and MouseDrag
  1906. select/move/resize grids.  In design mode you
  1907. select grids from the toolkit and lay them
  1908. out in the design window.
  1909.  
  1910. :Console
  1911. The console window is where conventional
  1912. input and output of text occurs.
  1913.  
  1914. INPUT:   a$ = INLINE$("Enter here ===>>")
  1915.  
  1916. OUTPUT:  PRINT a$
  1917.  
  1918. :Behavior
  1919. The BehaviorWindow displays the message processing
  1920. functions and subroutines for the most recently
  1921. selected grid.
  1922.  
  1923. Message processing functions and subroutines are
  1924. executed by grid functions in response to messages
  1925. they receive for one of their grids.  Any message
  1926. not listed in the left column is ignored.  Some
  1927. messages are processed by a message processing
  1928. function and message processing subroutine and
  1929. the message appears on two consecutive lines.
  1930.  
  1931. Both Enter and Cancel hide the BehaviorWindow.
  1932.  
  1933. :BehaviorList
  1934. This is a list of the messages processing functions
  1935. and message processing subroutines for all messages
  1936. the grid function responsible for the most recently
  1937. selected grid will respond.
  1938.  
  1939. :BehaviorText
  1940. Enter a message in this XuiTextLine grid to bring
  1941. the message into view in the list.  The list is
  1942. updated with every keystroke, so you don't usually
  1943. have to type the whole message name to bring it
  1944. into the visible portion of the XuiList grid.
  1945.  
  1946. :BehaviorEnter
  1947. Hide the BehaviorWindow.
  1948.  
  1949. :BehaviorCancel
  1950. Hide the BehaviorWindow.
  1951.  
  1952. :Report
  1953. Call XuiReportMessage() to display the normal GuiDesigner
  1954. message arguments for inspection.  XuiReportMessages() is
  1955. called in grid functions and callback functions generated
  1956. by GuiDesigner, though they may be commented out either or
  1957. both functions.  The XuiReportMessage() arguments are:
  1958.  
  1959. XuiReportMessage (grid, message, v0, v1, v2, v3, r0, r1)
  1960.  
  1961. :gridLabel
  1962. The grid number or window number argument
  1963. is displayed to the right of this label.
  1964.  
  1965. :gridNumber
  1966. grid number = 1st message argument
  1967.  
  1968. :gridTypeName
  1969. grid type name of specified grid
  1970.  
  1971. :messageLabel
  1972. The message number is displayed to the
  1973. right of this label.
  1974.  
  1975. :messageNumber
  1976. message number = 2nd message argument
  1977.  
  1978. :messageName
  1979. message name of specified message number
  1980.  
  1981. :v0Label
  1982. The v0 argument is displayed to the right
  1983. of this label.
  1984.  
  1985. :v0Number
  1986. v0 = 3rd argument (decimal)
  1987.  
  1988. :v0Hex
  1989. v0 = 3rd argument (hexadecimal)
  1990.  
  1991. :v1Label
  1992. The v1 argument is displayed to the right
  1993. of this label.
  1994.  
  1995. :v1Number
  1996. v1 = 4th argument (decimal)
  1997.  
  1998. :v1Hex
  1999. v1 = 4th argument (hexadecimal)
  2000.  
  2001. :v2Label
  2002. The v2 argument is displayed to the right
  2003. of this label.
  2004.  
  2005. :v2Number
  2006. v2 = 5th argument (decimal)
  2007.  
  2008. :v2Hex
  2009. v2 = 5th argument (hexadecimal)
  2010.  
  2011. :v3Label
  2012. The v3 argument is displayed to the right
  2013. of this label.
  2014.  
  2015. :v3Number
  2016. v3 = 6th argument (decimal)
  2017.  
  2018. :v3Hex
  2019. v3 = 6th argument (hexadecimal)
  2020.  
  2021. :r0Label
  2022. The kid or r0 argument is displayed to the
  2023. right of this label.
  2024.  
  2025. :r0Number
  2026. kid = r0 = 7th argument (decimal)
  2027.  
  2028. :r0Hex
  2029. kid = r0 = 7th argument (hexadecimal)
  2030.  
  2031. :r1Label
  2032. The r1 argument is displayed to the right
  2033. of this label.
  2034.  
  2035. :r1Number
  2036. r1 = 8th argument (decimal)
  2037.  
  2038. :r1Info
  2039. r1 = 8th argument (hex, message, string)
  2040.  
  2041. :ReportCancel
  2042. Hide the ReportMessage window from view.
  2043.  
  2044. :HelpScrollBarH
  2045. :HelpScrollBarH
  2046. Graph the ACOS function.
  2047.  
  2048.  
  2049.  
  2050.  
  2051.  
  2052.  
  2053.