stingray.PS4ImeDialog namespace reference

Description

This interface handles the PS4 on-screen keyboard (ImeDialog).

You can show the keyboard by calling show() and passing a table of options for the new keyboard. The input dialog appears and interacts with a user until the user presses OK or Cancel.

You can determine when the user has finished with the keyboard by calling is_finished(). Alternatively, you can force the keyboard to quit from your script by calling abort().

In either case, call is_finished() until it returns true to indicate that the dialog is ready to be closed, then call close() to get the result and dispose of the keyboard.

Note: You must wait for stingray.PS4ImeDialog.is_finished() to return true before calling stingray.PS4ImeDialog.close(), even if you used abort() to forcefully shut down the keyboard.

Other related reference items

PlayStation 4

Functions

abort ( ) Aborts keyboard editing.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

This causes stingray.PS4ImeDialog.is_finished() to return true.

Note: The abort() function is an asynchronous operation. You cannot just call:

    abort()
    close()

You must wait for stingray.PS4ImeDialog.is_finished() to return true before calling stingray.PS4ImeDialog.close().

close ( ) : integer, string Closes the keyboard window.

Parameters

This function does not accept any parameters.

Returns

integer	A status code that indicates the result of the operation. May be any of the end status values.
string	The string entered by the user.

Other related reference items

stingray.PS4ImeDialog.abort() stingray.PS4ImeDialog.is_finished()

is_finished ( ) : boolean Indicates whether or not the user has finished entering data into the ImeDialog.

Parameters

This function does not accept any parameters.

Returns

boolean

Returns true if the user has finished entering data.

If this function returns true, you must call stingray.PS4ImeDialog.close() to close the dialog.

Other related reference items

stingray.PS4ImeDialog.abort()

is_showing ( ) : boolean Indicates whether or not the ImeDialog box is showing.

Parameters

This function does not accept any parameters.

Returns

boolean

Returns true if the ImeDialog box is showing, or false otherwise.

Other related reference items

stingray.PS4ImeDialog.show()

show ( options ) Shows the PlayStation 4 keyboard input dialog.

Parameters

options :

ps4_keyboard_options

A table that specifies the settings for the keyboard.

Returns

This function does not return any values.

Only one keyboard dialog can be shown at a time: you cannot call show() if stingray.PS4ImeDialog.is_showing() returns true.

Other related reference items

ps4_keyboard_options

End status codes

END_STATUS_ABORTED : integer Aborted.

END_STATUS_OK : integer Status OK.

END_STATUS_USER_CANCELED : integer Canceled by the user.

Enter labels

ENTER_LABEL_DEFAULT : integer Default label.

Other related reference items

ps4_keyboard_options.enter_label

ENTER_LABEL_GO : integer Go.

ENTER_LABEL_SEARCH : integer Search.

ENTER_LABEL_SEND : integer Send.

Horizontal alignment

HALIGN_CENTER : integer Center alignment.

HALIGN_LEFT : integer Left alignment.

Other related reference items

ps4_keyboard_options.horizontal_alignment

HALIGN_RIGHT : integer Right alignment.

Language flags

LANGUAGE_DANISH : integer Danish.

LANGUAGE_DUTCH : integer Dutch.

LANGUAGE_ENGLISH_GB : integer UK English.

LANGUAGE_ENGLISH_US : integer US English.

LANGUAGE_FINNISH : integer Finnish.

LANGUAGE_FRENCH : integer French.

LANGUAGE_GERMAN : integer German.

LANGUAGE_ITALIAN : integer Italian.

LANGUAGE_JAPANESE : integer Japanese.

LANGUAGE_KOREAN : integer Korean.

LANGUAGE_NORWEGIAN : integer Norwegian.

LANGUAGE_POLISH : integer Polish.

LANGUAGE_PORTUGUESE_BR : integer Brazilian Portuguese.

LANGUAGE_PORTUGUESE_PT : integer Portuguese.

LANGUAGE_RUSSIAN : integer Russian.

LANGUAGE_SIMPLIFIED_CHINESE : integer Chinese (simplified).

LANGUAGE_SPANISH : integer Spanish.

LANGUAGE_SPANISH_LA : integer LA Spanish.

LANGUAGE_SWEDISH : integer Swedish.

LANGUAGE_TRADITIONAL_CHINESE : integer Chinese (traditional).

LANGUAGE_TURKISH : integer Turkish.

Option flags

OPTION_DISABLE_COPY_PASTE : integer Disable copy and paste.

OPTION_EXT_KEYBOARD : integer External keyboard.

OPTION_FIXED_POSITION : integer Fixed position.

OPTION_LANGUAGES_FORCED : integer Forces language.

OPTION_MULTILINE : integer Multi-line keyboard.

OPTION_NO_AUTO_CAPITALIZATION : integer No auto-capitalization.

OPTION_NO_LEARNING : integer No learning.

OPTION_PASSWORD : integer Hides characters.

Keyboard types

TYPE_BASIC_LATIN : integer Basic Latin keyboard type.

TYPE_DEFAULT : integer Default type.

Other related reference items

ps4_keyboard_options.type

TYPE_MAIL : integer Mail address keyboard type.

TYPE_NUMBER : integer Number keyboard type.

TYPE_URL : integer URL keyboard type.

Vertical alignment

VALIGN_BOTTOM : integer Bottom alignment.

VALIGN_CENTER : integer Center alignment.

VALIGN_TOP : integer Top alignment.

Other related reference items

ps4_keyboard_options.vertical_alignment