StringScreenGadget()

Syntax

Result = StringScreenGadget(#ScreenGadget, x, y, Width, Height, Content$ [, Flags])

Creates a String gadget in the current GadgetList. This gadget accepts only one line of text. To get multi-line input, use the EditorScreenGadget() function.

Parameters

#ScreenGadget	A number to identify the new gadget. #PB_Any can be used to auto-generate this number.
x, y, Width, Height	The position and dimensions of the new gadget.
Content$	The initial text content.
Flags (optional)	It can be a combination of the following values: #PB_String_ReadOnly : Read-only mode. No text can be entered.

Return value

Nonzero on success, zero otherwise. If #PB_Any was used as the #ScreenGadget parameter then the return-value is the auto-generated gadget number on success.

Remarks

Later the content can be changed with SetScreenGadgetText() and received with GetScreenGadgetText().

The following events are supported through ScreenEventType():

  #PB_ScreenEventType_Change    : The text has been modified by the user.
  #PB_ScreenEventType_Focus     : The StringGadget got the focus.
  #PB_ScreenEventType_LostFocus : The StringGadget lost the focus.

To add a 'mini help' to this gadget, use ScreenGadgetToolTip().

Supported OS

All