Prompt

Key

Unassigned

The Prompt function displays the Text Argument dialog box where you can enter a text argument. You can use this function interactively, but because it is mainly useful in macros, it is not assigned to a key by default. You usually use Lasttext or Arg to directly enter a text argument.

Prompt

Displays the Text Argument dialog box without a title. See: Lasttext

Arg Prompt (ALT+A Unassigned)

Uses the text of the current line from the cursor to the end of the line as the title.

Arg textarg Prompt (ALT+A textarg Unassigned)

Uses textarg as the title.

Arg boxarg | linearg | streamarg Prompt (ALT+A boxarg | linearg | streamarg Unassigned)

Uses the selected text as the title. If the selection spans more than one line, the title is the first line of the selected text.

Returns

TrueTextarg entered; the user chose the OK button.

FalseThe dialog box was canceled.

Example

With the following macro, PWB prompts for a Help topic:

QueryHelp := Arg "Help Topic to Find:" Prompt -> Pwbhelp

QueryHelp : Ctrl+Q

When you press CTRL+Q, PWB displays a dialog box with the string Help Topic to Find: as the title and waits for a response. PWB passes your response to the Pwbhelp function as if the command Arg textarg Pwbhelp had been executed. If you cancel the dialog box, Prompt returns false and the macro conditional -> terminates the macro without executing Pwbhelp.

See

Assign