Unit CastleMessages

Ask user for simple confirmation. This is the simplest "OK" dialog box.

Ask user to input a string. User must give an answer (there is no "Cancel" button), use MessageInputQuery if you want a version with "Cancel" button.

Parameters

AnswerMaxLen

0 (zero) means that there's no maximum answer length.

Ask user to input a string, or cancel. Returns True and sets Answer if user accepted some text. Note that initial Answer value is the answer proposed to the user.

Parameters

AnswerMaxLen

0 (zero) means that there's no maximum answer length.

Ask user to choose one option from many. ButtonCaptions contain a list of button captions.

ButtonChars (must have always the same length as ButtonCaptions) contains the chars that are returned for each corresponding button press. The user can also directly press the given key. ButtonChars is not case sensitive, all letters on this list must be different (not only in case). We always return a lowercase letter corresponding to one of ButtonChars letters.

Example usage:

case MessageChoice(Window, 'Which fruit to you want to eat?',
  ['Apple', 'Banana', 'Cancel'],
  ['a', 'b', CharEscape]) of
  'a': // ... user pressed "Apple" button or "A" key -> likes apples
  'b': // ... user pressed "Banana" button or "B" key -> likes bananas
  CharEscape: // ... user pressed "Cancel" button or "Escape" key -> cancelled
end;

When AllowCancel, user can always press Escape to easily cancel the dialog. Regardless if CharEscape is among ButtonChars. We return CharEscape then.

Ask user to press any key, return this key as Keys.TKey.

Never returns keyNone (which means that keys that cannot be interpreted as Keys.TKey will be ignored, and will not close the dialog box).

Warning: this symbol is deprecated: use the function form of MessageKeyMouse

Ask user to press anything (key or mouse button or mouse wheel), and return it. The natural use for this is to allow user to configure keybindings of your program, like for TInputShortcut.

Warning: this symbol is deprecated: use the function form of MessageKeyMouse

Ask user to input an unsigned integer.

Note that AnswerDefault below may be given as Cardinal or as a string. The latter is useful if you want the default answer to be '', i.e. empty string — no default answer.

Ask user to input a value in hexadecimal. Give MaxWidth = 0 to say that there is no maximum width.

Ask user to input a floating-point number.

If you give non-empty ValueAsString, it will be used to show the initial value for the user. Otherwise, we will just show FloatToStrDot(Value), which sometimes may be too ugly. For example Value = 0.01 cannot be precisely represented as a floating point number, and FloatToStrDot shows that this is really something like 0.0099xxxxx.

Warning: this symbol is deprecated.

Position of text in message dialogs. Deprecated, use THorizontalPosition instead.

Warning: this symbol is deprecated.

Warning: this symbol is deprecated.

Warning: this symbol is deprecated.

Change MessageOK behavior to create TStateDialogOK and push it (using TUIState.Push) and immediately return, without waiting for user confirmation.

Why you may want to use this (or not to use this)?

• This is the only way to make MessageOK working on iOS (where Application.ProcessMessages is not available).

• This looks a little better in case user may resize the window while the MessageOK is running, or when something animates under MessageOK. When this is True, the state underneath redraws properly, so it can adjust to window size and animate. Otherwise, all MessageXxx methods in this unit only show a static screenshot underneath, that is scaled if needed.

• On the other hand, the notification about unhandled exceptions (done by CastleWindow automatically, using MessageOK) is a little safer when this is False. When this is False, there's a greater chance that the problematic code (e.g. the update method of some other TUIState) it disabled during the display of the error messsage.

If you turn this on, then you should organize your whole application into states using TUIState. You can even pause the running game in overridden TUIState.Pause, to make game paused when the message dialog is displayed.

Note that this feature doesn't change other routines in CastleMessages. For example MessageYesNo is still a modal function (it waits for user input), and it simply doesn't work on iOS. If you want to use TUIState to manage all dialogs, then use explicitly states like TStateDialogYesNo from the CastleDialogStates unit.