PS3 on-screen keyboard management. More...

#include <ppu-types.h>

Data Structures
struct	_osk_pnt
	Point structure for on-screen keyboard management. More...

struct	_osk_param
	On-screen keyboard manager parameters. More...

struct	_osk_layout_info
	On-screen keyboard panel layout info data structure. More...

struct	_osk_input_field_info
	On-screen keyboard input field information data structure. More...

struct	_osk_cb_return_param
	On-screen keyboard return parameters data structure. More...

struct	_osk_separate_window_option
	On-screen keyboard separate window options data structure. More...

Macros
#define	OSK_10KEY_PANEL 1

#define	OSK_FULLKEY_PANEL 2

#define	OSK_DEVICE_MASK_PAD 0xff

#define	OSK_LANG_KOREAN 0x00001000

#define	OSK_LANG_DANISH 0x00020000

#define	OSK_LANG_SWEDISH 0x00040000

#define	OSK_LANG_NORWEGIAN 0x00080000

#define	OSK_LANG_FINNISH 0x00100000

#define	OSK_LANG_TRADITIONAL_CHINESE

#define	OSK_LANG_SIMPLIFIED_CHINESE

#define	OSK_PANEL_TYPE_DEFAULT 0x00000000

#define	OSK_PANEL_TYPE_DEFAULT_NO_JAPANESE 0x00000200

#define	OSK_PANEL_TYPE_ALPHABET_FULL_WIDTH 0x00800000

#define	OSK_PANEL_TYPE_ALPHABET 0x01000000

#define	OSK_PANEL_TYPE_NUMERAL_FULL_WIDTH 0x04000000

#define	OSK_PANEL_TYPE_NUMERAL 0x08000000

#define	OSK_PANEL_TYPE_JAPANESE 0x00000100

#define	OSK_PANEL_TYPE_JAPANESE_HIRAGANA 0x00200000

#define	OSK_PANEL_TYPE_JAPANESE_KATAKANA 0x00400000

#define	OSK_PANEL_TYPE_ENGLISH 0x00000002

#define	OSK_PANEL_TYPE_FRENCH 0x00000008

#define	OSK_PANEL_TYPE_SPANISH 0x00000004

#define	OSK_PANEL_TYPE_DUTCH 0x00000020

#define	OSK_PANEL_TYPE_GERMAN 0x00000001

#define	OSK_PANEL_TYPE_RUSSIAN 0x00000080

#define	OSK_PANEL_TYPE_ITALIAN 0x00000010

#define	OSK_PANEL_TYPE_PORTUGUESE 0x00000040

#define	OSK_PANEL_TYPE_KOREAN 0x00001000

#define	OSK_PANEL_TYPE_DANISH 0x00020000

#define	OSK_PANEL_TYPE_SWEDISH 0x00040000

#define	OSK_PANEL_TYPE_NORWEGIAN 0x00080000

#define	OSK_PANEL_TYPE_FINNISH 0x00100000

#define	OSK_PANEL_TYPE_TRADITIONAL_CHINESE 0x00004000

#define	OSK_PANEL_TYPE_SIMPLIFIED_CHINESE 0x00008000

#define	OSK_PANEL_TYPE_LATIN 0x02000000

#define	OSK_PANEL_TYPE_URL 0x10000000

#define	OSK_PANEL_TYPE_PASSWORD 0x20000000

#define	OSK_PROHIBIT_SPACE 0x00000001

#define	OSK_PROHIBIT_RETURN 0x00000002

#define	OSK_PROHIBIT_INPUT_ANALOG 0x00000008

#define	OSK_LAYOUTMODE_HORIZONTAL_ALIGN_RIGHT 0x00000200

#define	OSK_LAYOUTMODE_HORIZONTAL_ALIGN_CENTER 0x00000400

#define	OSK_LAYOUTMODE_HORIZONTAL_ALIGN_LEFT 0x00000800

#define	OSK_LAYOUTMODE_VERTICAL_ALIGN_BOTTOM 0x00001000

#define	OSK_LAYOUTMODE_VERTICAL_ALIGN_CENTER 0x00002000

#define	OSK_LAYOUTMODE_VERTICAL_ALIGN_TOP 0x00004000

Typedefs
typedef struct _osk_pnt	oskPoint
	Point structure for on-screen keyboard management.

typedef struct _osk_param	oskParam
	On-screen keyboard manager parameters.

typedef struct _osk_layout_info	oskLayoutInfo
	On-screen keyboard panel layout info data structure.

typedef struct _osk_input_field_info	oskInputFieldInfo
	On-screen keyboard input field information data structure.

typedef struct _osk_cb_return_param	oskCallbackReturnParam
	On-screen keyboard return parameters data structure.

typedef struct _osk_separate_window_option	oskSeparateWindowOption
	On-screen keyboard separate window options data structure.

Enumerations
enum	oskKeyLayout { OSK_INITIAL_SYSTEM_PANEL, OSK_INITIAL_10KEY_PANEL, OSK_INITIAL_FULLKEY_PANEL }
	On-screen keyboard initial layout values. More...

enum	oskInputFieldResult { OSK_OK, OSK_CANCELED, OSK_ABORT, OSK_NO_TEXT }
	Result of on-screen keyboard input. More...

enum	oskInputDevice { OSK_DEVICE_PAD, OSK_DEVICE_KB }
	On-screen keyboard input device values. More...

enum	oskContinuousMode { OSK_CONTINUOUS_MODE_NONE, OSK_CONTINUOUS_MODE_REMAIN_OPEN, OSK_CONTINUOUS_MODE_HIDE, OSK_CONTINUOUS_MODE_SHOW }
	On-screen keyboard continuous mode setting values. More...

enum	oskType { OSK_SINGLELINE, OSK_MULTILINE, OSK_FULLKB_SINGLELINE, OSK_FULLKB_MULTILINE, OSK_SEPARATE_SINGLELINE_WINDOWED, OSK_SEPARATE_MULTILINE_WINDOWED, OSK_SEPARATE_INPUT_PANEL_WINDOWED, OSK_SEPARATE_FULLKB_INPUT_PANEL_WINDOWED, OSK_SEPARATE_CANDIDATE_WINDOWED }
	On-screen keyboard type values. More...

Functions
s32	oskSetInitialInputDevice (oskInputDevice input)
	Set initial input device. More...

s32	oskGetSize (u16 width, u16 height, oskType type)
	Get size of on-screen keyboard panel. More...

s32	oskUnloadAsync (oskCallbackReturnParam *param)
	Close the on-screen keyboard panel. More...

s32	oskDisableDimmer ()
	Disable the on-screen keyboard panel's background dimmer filter. More...

s32	oskSetKeyLayoutOption (u32 flags)
	Set the on-screen keyboard key layout. More...

s32	oskAbort ()
	Abort the currently opened on-screen keyboard panel. More...

s32	oskSetDeviceMask (u32 mask)
	Set on-screen keyboard device mask. More...

s32	oskSetSeparateWindowOption (oskSeparateWindowOption *option)
	Set on-screen keyboard separate window option. More...

s32	oskGetInputText (oskCallbackReturnParam *info)
	Get on-screen keyboard input text. More...

s32	oskAddSupportLanguage (u32 lang)
	Add a supported language to on-screen keyboard. More...

s32	oskLoadAsync (sys_mem_container_t container, const oskParam param, const oskInputFieldInfo inputInfo)
	Open the on-screen keyboard panel. More...

s32	oskSetInitialKeyLayout (oskKeyLayout layout)
	Set the on-screen keyboard initial key layout. More...

s32	oskSetLayoutMode (s32 mode)
	Set the on-screen keyboard initial layout mode. More...

Detailed Description

PS3 on-screen keyboard management.

Enumeration Type Documentation

◆ oskContinuousMode

enum oskContinuousMode

On-screen keyboard continuous mode setting values.

Enumerator
OSK_CONTINUOUS_MODE_NONE	No continuous mode.
OSK_CONTINUOUS_MODE_REMAIN_OPEN	Keep panel open.
OSK_CONTINUOUS_MODE_HIDE	Hide panel by default.
OSK_CONTINUOUS_MODE_SHOW	Show panel by default.

◆ oskInputDevice

enum oskInputDevice

On-screen keyboard input device values.

Enumerator
OSK_DEVICE_PAD	PS3 Pad/controller.
OSK_DEVICE_KB	Keyboard.

◆ oskInputFieldResult

enum oskInputFieldResult

Result of on-screen keyboard input.

Enumerator
OSK_OK	Input success.
OSK_CANCELED	Input canceled.
OSK_ABORT	Input aborted.
OSK_NO_TEXT	Input empty.

◆ oskKeyLayout

enum oskKeyLayout

On-screen keyboard initial layout values.

Enumerator
OSK_INITIAL_SYSTEM_PANEL	System panel.
OSK_INITIAL_10KEY_PANEL	10-key keypad panel.
OSK_INITIAL_FULLKEY_PANEL	full keyboard panel.

◆ oskType

enum oskType

On-screen keyboard type values.

Enumerator
OSK_SINGLELINE	Single line panel.
OSK_MULTILINE	Multiline panel.
OSK_FULLKB_SINGLELINE	Single line panel with full keyboard.
OSK_FULLKB_MULTILINE	Multiline panel with full keyboard.
OSK_SEPARATE_SINGLELINE_WINDOWED	Separated single line panel.
OSK_SEPARATE_MULTILINE_WINDOWED	Separated multiline panel.
OSK_SEPARATE_INPUT_PANEL_WINDOWED	Separated single line panel with 10-key keypad.
OSK_SEPARATE_FULLKB_INPUT_PANEL_WINDOWED	Separated single line panel with full keyboard.
OSK_SEPARATE_CANDIDATE_WINDOWED	Separated panel with candidate selector (for keyboard input)

Function Documentation

◆ oskAbort()

s32 oskAbort ( )

Abort the currently opened on-screen keyboard panel.

Returns: zero if no error occured, nonzero otherwise.

◆ oskAddSupportLanguage()

s32 oskAddSupportLanguage ( u32 lang )

Add a supported language to on-screen keyboard.

Parameters

[in]

lang

Additional language.
This is one of the following values:

OSK_PANEL_TYPE_DEFAULT
OSK_PANEL_TYPE_DEFAULT_NO_JAPANESE
OSK_PANEL_TYPE_ALPHABET_FULL_WIDTH
OSK_PANEL_TYPE_ALPHABET
OSK_PANEL_TYPE_NUMERAL_FULL_WIDTH
OSK_PANEL_TYPE_NUMERAL
OSK_PANEL_TYPE_JAPANESE
OSK_PANEL_TYPE_JAPANESE_HIRAGANA
OSK_PANEL_TYPE_JAPANESE_KATAKANA
OSK_PANEL_TYPE_ENGLISH
OSK_PANEL_TYPE_FRENCH
OSK_PANEL_TYPE_SPANISH
OSK_PANEL_TYPE_DUTCH
OSK_PANEL_TYPE_GERMAN
OSK_PANEL_TYPE_RUSSIAN
OSK_PANEL_TYPE_ITALIAN
OSK_PANEL_TYPE_PORTUGUESE
OSK_PANEL_TYPE_KOREAN
OSK_PANEL_TYPE_DANISH
OSK_PANEL_TYPE_SWEDISH
OSK_PANEL_TYPE_NORWEGIAN
OSK_PANEL_TYPE_FINNISH
OSK_PANEL_TYPE_TRADITIONAL_CHINESE
OSK_PANEL_TYPE_SIMPLIFIED_CHINESE
OSK_PANEL_TYPE_LATIN
OSK_PANEL_TYPE_URL
OSK_PANEL_TYPE_PASSWORD

Returns: zero if no error occured, nonzero otherwise.

◆ oskDisableDimmer()

s32 oskDisableDimmer ( )

Disable the on-screen keyboard panel's background dimmer filter.

Returns: zero if no error occured, nonzero otherwise.

◆ oskGetInputText()

s32 oskGetInputText ( oskCallbackReturnParam * info )

Get on-screen keyboard input text.

Parameters

[out] info Separate window option.

Returns: zero if no error occured, nonzero otherwise.

◆ oskGetSize()

s32 oskGetSize	(	u16 *	width,
		u16 *	height,
		oskType	type
	)

Get size of on-screen keyboard panel.

Parameters

[out]	width	Width of OSK panel in pixels.
[out]	height	Height of OSK panel in pixels.
[in]	type	OSK type.

Returns: zero if no error occured, nonzero otherwise.

◆ oskLoadAsync()

s32 oskLoadAsync	(	sys_mem_container_t	container,
		const oskParam *	param,
		const oskInputFieldInfo *	inputInfo
	)

Open the on-screen keyboard panel.

Parameters

[in]	container	Memory container id. Typical used sizes are 4 MB.
[in]	param	Parameters.
[in]	inputInfo	Input information.

Returns: zero if no error occured, nonzero otherwise.

◆ oskSetDeviceMask()

s32 oskSetDeviceMask ( u32 mask )

Set on-screen keyboard device mask.

Parameters

[in] mask Devices mask. Either 0 or OSK_DEVICE_MASK_PAD.

Returns: zero if no error occured, nonzero otherwise.

◆ oskSetInitialInputDevice()

s32 oskSetInitialInputDevice ( oskInputDevice input )

Set initial input device.

Parameters

[in] input Initial input device value.

Returns: zero if no error occured, nonzero otherwise.

◆ oskSetInitialKeyLayout()

s32 oskSetInitialKeyLayout ( oskKeyLayout layout )

Set the on-screen keyboard initial key layout.

Parameters

[in] layout Initial key layout.

Returns: zero if no error occured, nonzero otherwise.

◆ oskSetKeyLayoutOption()

s32 oskSetKeyLayoutOption ( u32 flags )

Set the on-screen keyboard key layout.

Parameters

[in]

flags

Key layout. Possible values are:

OSK_10KEY_PANEL
OSK_FULLKEY_PANEL

Returns: zero if no error occured, nonzero otherwise.

◆ oskSetLayoutMode()

s32 oskSetLayoutMode ( s32 mode )

Set the on-screen keyboard initial layout mode.

Parameters

[in]

mode

Layout mode.
This is an OR'ed combination of the following values:

OSK_LAYOUTMODE_HORIZONTAL_ALIGN_LEFT
OSK_LAYOUTMODE_HORIZONTAL_ALIGN_CENTER
OSK_LAYOUTMODE_HORIZONTAL_ALIGN_RIGHT
OSK_LAYOUTMODE_VERTICAL_ALIGN_TOP
OSK_LAYOUTMODE_VERTICAL_ALIGN_CENTER
OSK_LAYOUTMODE_VERTICAL_ALIGN_BOTTOM

Returns: zero if no error occured, nonzero otherwise.

◆ oskSetSeparateWindowOption()

s32 oskSetSeparateWindowOption ( oskSeparateWindowOption * option )

Set on-screen keyboard separate window option.

Parameters

[in] option Separate window option.

Returns: zero if no error occured, nonzero otherwise.

◆ oskUnloadAsync()

s32 oskUnloadAsync ( oskCallbackReturnParam * param )

Close the on-screen keyboard panel.

Parameters

[out] param Return parameters.

Returns: zero if no error occured, nonzero otherwise.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ oskContinuousMode

◆ oskInputDevice

◆ oskInputFieldResult

◆ oskKeyLayout

◆ oskType

Function Documentation

◆ oskAbort()

◆ oskAddSupportLanguage()

◆ oskDisableDimmer()

◆ oskGetInputText()

◆ oskGetSize()

◆ oskLoadAsync()

◆ oskSetDeviceMask()

◆ oskSetInitialInputDevice()

◆ oskSetInitialKeyLayout()

◆ oskSetKeyLayoutOption()

◆ oskSetLayoutMode()

◆ oskSetSeparateWindowOption()

◆ oskUnloadAsync()