ps4_keyboard_options table reference

Description

Provides keyboard settings for a call to stingray.PS4ImeDialog.show().

You can create a table, set it up with any of the fields defined here, and pass it to stingray.PS4ImeDialog.show(). Any fields you omit will use the specified default values.

The color values accepted by this table all expect an ARGB value stored in an stingray.Quaternion, with each component ranging from 0-255. You can create such a value by calling stingray.Color(), passing three arguments for an RGB value or four for an ARGB value. To draw a bright yellow line, for example, you would use Color(255, 255, 0).

If you specify any custom color value, you will probably want to specify custom values for all the colors.

Other related reference items

	stingray.PS4ImeDialog.show()
	PlayStation 4

Data Members

color_base : stingray.Quaternion Base color.

color_button_default : stingray.Quaternion Default button color.

color_button_function : stingray.Quaternion Function button color.

color_button_symbol : stingray.Quaternion Symbol button color.

color_line : stingray.Quaternion Line color.

color_preedit : stingray.Quaternion Pre-edit color.

color_special : stingray.Quaternion Special color.

color_text : stingray.Quaternion Text color.

color_text_field : stingray.Quaternion Text field color.

enter_label : integer The label that is shown on the Enter button of the keyboard.

May be any of the PS4ImeDialog enter label constants.

If omitted, the default value of stingray.PS4ImeDialog.ENTER_LABEL_DEFAULT is used.

horizontal_alignment : integer Determines how the dialog will be aligned with respect to the x coordinate value.

May be any of the PS4ImeDialog horizontal alignment constants.

If omitted, the default value of stingray.PS4ImeDialog.HALIGN_LEFT is used.

max_length : integer The maximum length of the text that a user can input.

If omitted, the default of 2048 is used.

option : integer Sets other options for the keyboard.

This value must be a mask composed of one or more of the PS4ImeDialog option flag values.

The default value of 0 means that none of these options are requested.

placeholder : string The placeholder text to show when the text box is empty.

If omitted, no placeholder text is shown.

supported_languages : integer Defines the languages that are supported in the IME.

This value must be a mask composed of one or more of the PS4ImeDialog language flag values.

The default value of 0 means that all languages are supported.

text : string The text that should be already filled in when the dialog is opened.

If omitted, no default text is shown.

title : string The title of the dialog box.

If omitted, no placeholder text is shown.

type : integer The type of the keyboard dialog.

May be any of the PS4ImeDialog keyboard type constants.

If omitted, the default value of stingray.PS4ImeDialog.TYPE_DEFAULT is used.

user_id : integer The user ID for whom the dialog box must be shown.

If omitted, the default value is the user who launched the application (see stingray.PS4.initial_user_id()).

vertical_alignment : integer Determines how the dialog will be aligned with respect to the y coordinate value.

May be any of the PS4ImeDialog vertical alignment constants.

If omitted, the default value of stingray.PS4ImeDialog.VALIGN_TOP is used.

x : number The position of the dialog on the horizontal X axis.

If omitted, the default of 0 is used.

Other related reference items

ps4_keyboard_options.horizontal_alignment

y : number The position of the dialog on the vertical Y axis.

If omitted, the default of 0 is used.

Other related reference items

ps4_keyboard_options.vertical_alignment