PSPSDK 2024-10-31
Loading...
Searching...
No Matches
psputility_osk.h File Reference
#include <psptypes.h>
Include dependency graph for psputility_osk.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _SceUtilityOskData
 OSK Field data. More...
 
struct  _SceUtilityOskParams
 OSK parameters. More...
 

Typedefs

typedef struct _SceUtilityOskData SceUtilityOskData
 OSK Field data.
 
typedef struct _SceUtilityOskParams SceUtilityOskParams
 OSK parameters.
 

Enumerations

enum  SceUtilityOskInputLanguage {
  PSP_UTILITY_OSK_LANGUAGE_DEFAULT = 0x00 , PSP_UTILITY_OSK_LANGUAGE_JAPANESE = 0x01 , PSP_UTILITY_OSK_LANGUAGE_ENGLISH = 0x02 , PSP_UTILITY_OSK_LANGUAGE_FRENCH = 0x03 ,
  PSP_UTILITY_OSK_LANGUAGE_SPANISH = 0x04 , PSP_UTILITY_OSK_LANGUAGE_GERMAN = 0x05 , PSP_UTILITY_OSK_LANGUAGE_ITALIAN = 0x06 , PSP_UTILITY_OSK_LANGUAGE_DUTCH = 0x07 ,
  PSP_UTILITY_OSK_LANGUAGE_PORTUGESE = 0x08 , PSP_UTILITY_OSK_LANGUAGE_RUSSIAN = 0x09 , PSP_UTILITY_OSK_LANGUAGE_KOREAN = 0x0a
}
 Enumeration for input language. More...
 
enum  SceUtilityOskState {
  PSP_UTILITY_OSK_DIALOG_NONE = 0 , PSP_UTILITY_OSK_DIALOG_INITING , PSP_UTILITY_OSK_DIALOG_INITED , PSP_UTILITY_OSK_DIALOG_VISIBLE ,
  PSP_UTILITY_OSK_DIALOG_QUIT , PSP_UTILITY_OSK_DIALOG_FINISHED
}
 Enumeration for OSK internal state. More...
 
enum  SceUtilityOskResult { PSP_UTILITY_OSK_RESULT_UNCHANGED = 0 , PSP_UTILITY_OSK_RESULT_CANCELLED , PSP_UTILITY_OSK_RESULT_CHANGED }
 Enumeration for OSK field results. More...
 
enum  SceUtilityOskInputType {
  PSP_UTILITY_OSK_INPUTTYPE_ALL = 0x00000000 , PSP_UTILITY_OSK_INPUTTYPE_LATIN_DIGIT = 0x00000001 , PSP_UTILITY_OSK_INPUTTYPE_LATIN_SYMBOL = 0x00000002 , PSP_UTILITY_OSK_INPUTTYPE_LATIN_LOWERCASE = 0x00000004 ,
  PSP_UTILITY_OSK_INPUTTYPE_LATIN_UPPERCASE = 0x00000008 , PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_DIGIT = 0x00000100 , PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_SYMBOL = 0x00000200 , PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_LOWERCASE = 0x00000400 ,
  PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_UPPERCASE = 0x00000800 , PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_HIRAGANA = 0x00001000 , PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_HALF_KATAKANA = 0x00002000 , PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_KATAKANA = 0x00004000 ,
  PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_KANJI = 0x00008000 , PSP_UTILITY_OSK_INPUTTYPE_RUSSIAN_LOWERCASE = 0x00010000 , PSP_UTILITY_OSK_INPUTTYPE_RUSSIAN_UPPERCASE = 0x00020000 , PSP_UTILITY_OSK_INPUTTYPE_KOREAN = 0x00040000 ,
  PSP_UTILITY_OSK_INPUTTYPE_URL = 0x00080000
}
 Enumeration for input types (these are limited by initial choice of language) More...
 

Functions

int sceUtilityOskInitStart (SceUtilityOskParams *params)
 Create an on-screen keyboard.
 
int sceUtilityOskShutdownStart (void)
 Remove a currently active keyboard.
 
int sceUtilityOskUpdate (int n)
 Refresh the GUI for a keyboard currently active.
 
int sceUtilityOskGetStatus (void)
 Get the status of a on-screen keyboard currently active.
 

Typedef Documentation

◆ SceUtilityOskData

◆ SceUtilityOskParams

Enumeration Type Documentation

◆ SceUtilityOskInputLanguage

Enumeration for input language.

Enumerator
PSP_UTILITY_OSK_LANGUAGE_DEFAULT 
PSP_UTILITY_OSK_LANGUAGE_JAPANESE 
PSP_UTILITY_OSK_LANGUAGE_ENGLISH 
PSP_UTILITY_OSK_LANGUAGE_FRENCH 
PSP_UTILITY_OSK_LANGUAGE_SPANISH 
PSP_UTILITY_OSK_LANGUAGE_GERMAN 
PSP_UTILITY_OSK_LANGUAGE_ITALIAN 
PSP_UTILITY_OSK_LANGUAGE_DUTCH 
PSP_UTILITY_OSK_LANGUAGE_PORTUGESE 
PSP_UTILITY_OSK_LANGUAGE_RUSSIAN 
PSP_UTILITY_OSK_LANGUAGE_KOREAN 

◆ SceUtilityOskInputType

Enumeration for input types (these are limited by initial choice of language)

Enumerator
PSP_UTILITY_OSK_INPUTTYPE_ALL 
PSP_UTILITY_OSK_INPUTTYPE_LATIN_DIGIT 
PSP_UTILITY_OSK_INPUTTYPE_LATIN_SYMBOL 
PSP_UTILITY_OSK_INPUTTYPE_LATIN_LOWERCASE 
PSP_UTILITY_OSK_INPUTTYPE_LATIN_UPPERCASE 
PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_DIGIT 
PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_SYMBOL 
PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_LOWERCASE 
PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_UPPERCASE 
PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_HIRAGANA 
PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_HALF_KATAKANA 
PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_KATAKANA 
PSP_UTILITY_OSK_INPUTTYPE_JAPANESE_KANJI 
PSP_UTILITY_OSK_INPUTTYPE_RUSSIAN_LOWERCASE 
PSP_UTILITY_OSK_INPUTTYPE_RUSSIAN_UPPERCASE 
PSP_UTILITY_OSK_INPUTTYPE_KOREAN 
PSP_UTILITY_OSK_INPUTTYPE_URL 

◆ SceUtilityOskResult

Enumeration for OSK field results.

Enumerator
PSP_UTILITY_OSK_RESULT_UNCHANGED 
PSP_UTILITY_OSK_RESULT_CANCELLED 
PSP_UTILITY_OSK_RESULT_CHANGED 

◆ SceUtilityOskState

Enumeration for OSK internal state.

Enumerator
PSP_UTILITY_OSK_DIALOG_NONE 

No OSK is currently active.

PSP_UTILITY_OSK_DIALOG_INITING 

The OSK is currently being initialized.

PSP_UTILITY_OSK_DIALOG_INITED 

The OSK is initialised.

PSP_UTILITY_OSK_DIALOG_VISIBLE 

The OSK is visible and ready for use.

PSP_UTILITY_OSK_DIALOG_QUIT 

The OSK has been cancelled and should be shut down.

PSP_UTILITY_OSK_DIALOG_FINISHED 

The OSK has successfully shut down.

Function Documentation

◆ sceUtilityOskGetStatus()

int sceUtilityOskGetStatus ( void  )

Get the status of a on-screen keyboard currently active.

Returns
the current status of the keyboard. See pspUtilityDialogState for details.

◆ sceUtilityOskInitStart()

int sceUtilityOskInitStart ( SceUtilityOskParams params)

Create an on-screen keyboard.

Parameters
params- OSK parameters.
Returns
< 0 on error.

◆ sceUtilityOskShutdownStart()

int sceUtilityOskShutdownStart ( void  )

Remove a currently active keyboard.

After calling this function you must

poll sceUtilityOskGetStatus() until it returns PSP_UTILITY_DIALOG_NONE.

Returns
< 0 on error.

◆ sceUtilityOskUpdate()

int sceUtilityOskUpdate ( int  n)

Refresh the GUI for a keyboard currently active.

Parameters
n- Unknown, pass 1.
Returns
< 0 on error.