vitasdk
Documentation of the vitasdk
Functions | Typedefs | Macros
User
Dialog » Ime Dialog Library

Detailed Description

Exports for User.

Using this library in your project

Include the header file in your project:

#include <psp2/ime_dialog.h>
ime_dialog.h


Link the library to the executable:

SceIme_stub


Load the required module:

sceSysmoduleLoadModule(SCE_SYSMODULE_IME);
sceSysmoduleLoadModule
int sceSysmoduleLoadModule(SceSysmoduleModuleId id)
Load a module.
SCE_SYSMODULE_IME
@ SCE_SYSMODULE_IME
Ime module.
Definition: sysmodule.h:44


Using this library in your project

Include the header file in your project:

#include <psp2/libime.h>


Link the library to the executable:

SceIme_stub


Load the required module:

sceSysmoduleLoadModule(SCE_SYSMODULE_IME);


Functions

 VITASDK_BUILD_ASSERT_EQ (0xA8, SceImeDialogParam)
 
 VITASDK_BUILD_ASSERT_EQ (0x24, SceImeDialogResult)
 
SceInt32 sceImeDialogInit (const SceImeDialogParam *param)
 
SceCommonDialogStatus sceImeDialogGetStatus (void)
 
SceInt32 sceImeDialogAbort (void)
 
SceInt32 sceImeDialogGetResult (SceImeDialogResult *result)
 
SceInt32 sceImeDialogTerm (void)
 
 VITASDK_BUILD_ASSERT_EQ (0x10, SceImeRect)
 
 VITASDK_BUILD_ASSERT_EQ (0x18, SceImeEditText)
 
 VITASDK_BUILD_ASSERT_EQ (0x28, SceImeEventParam)
 
 VITASDK_BUILD_ASSERT_EQ (0x2C, SceImeEventData)
 
 VITASDK_BUILD_ASSERT_EQ (0x10, SceImeCaret)
 
 VITASDK_BUILD_ASSERT_EQ (0xC, SceImePreeditGeometry)
 
 VITASDK_BUILD_ASSERT_EQ (0x40, SceImeParam)
 
SceInt32 sceImeOpen (const SceImeParam *param)
 
SceInt32 sceImeUpdate (void)
 
SceInt32 sceImeSetText (const SceWChar16 *text, SceUInt32 length)
 
SceInt32 sceImeSetCaret (const SceImeCaret *caret)
 
SceInt32 sceImeSetPreeditGeometry (const SceImePreeditGeometry *preedit)
 
SceInt32 sceImeClose (void)
 

Typedefs

typedef SceInt32(* SceImeTextFilter) (SceWChar16 *outText, SceUInt32 *outTextLength, const SceWChar16 *srcText, SceUInt32 srcTextLength)
 
typedef void(* SceImeEventHandler) (void *arg, const SceImeEventData *e)
 

Macros

#define SCE_IME_DIALOG_MAX_TITLE_LENGTH   (128)
 
#define SCE_IME_DIALOG_MAX_TEXT_LENGTH   (2048)
 
#define SCE_IME_WORK_BUFFER_SIZE   (20*1024)
 
#define SCE_IME_MAX_PREEDIT_LENGTH   (30)
 
#define SCE_IME_MAX_TEXT_LENGTH   (2048)
 

Data Structure Documentation

◆ SceImeDialogParam

struct SceImeDialogParam
Data Fields
SceUInt32 sdkVersion
SceUInt32 inputMethod
SceUInt64 supportedLanguages Dialog languages (One or more SceImeLanguage)
SceBool languagesForced
SceUInt32 type Dialog type (One of SceImeType)
SceUInt32 option Dialog options (One or more SceImeOption)
SceImeTextFilter filter
SceUInt32 dialogMode Dialog mode (One of SceImeDialogDialogMode)
SceUInt32 textBoxMode Textbox mode (One of SceImeDialogTextboxMode)
const SceWChar16 * title
SceUInt32 maxTextLength
SceWChar16 * initialText
SceWChar16 * inputTextBuffer
SceCommonDialogParam commonParam
SceUChar8 enterLabel
SceChar8 reserved[35]

◆ SceImeDialogResult

struct SceImeDialogResult
Data Fields
SceInt32 result
SceInt32 button
SceChar8 reserved[28]

◆ SceImeRect

struct SceImeRect
Data Fields
SceUInt32 x
SceUInt32 y
SceUInt32 width
SceUInt32 height

◆ SceImeEditText

struct SceImeEditText
Data Fields
SceUInt32 preeditIndex
SceUInt32 preeditLength
SceUInt32 caretIndex
SceWChar16 * str
SceUInt32 editIndex
SceInt32 editLengthChange

◆ SceImeEventParam

union SceImeEventParam
Data Fields
SceImeRect rect
SceImeEditText text
SceUInt32 caretIndex
SceUChar8 reserved[40]

◆ SceImeEventData

struct SceImeEventData
Data Fields
SceUInt32 id
SceImeEventParam param

◆ SceImeCaret

struct SceImeCaret
Data Fields
SceUInt32 x
SceUInt32 y
SceUInt32 height
SceUInt32 index

◆ SceImePreeditGeometry

struct SceImePreeditGeometry
Data Fields
SceUInt32 x
SceUInt32 y
SceUInt32 height

◆ SceImeParam

struct SceImeParam
Data Fields
SceUInt32 sdkVersion
SceUInt32 inputMethod
SceUInt64 supportedLanguages Dialog languages (One or more SceImeLanguage)
SceBool languagesForced
SceUInt32 type Dialog type (One of SceImeType)
SceUInt32 option Dialog options (One or more SceImeOption)
void * work
void * arg
SceImeEventHandler handler
SceImeTextFilter filter
SceWChar16 * initialText
SceUInt32 maxTextLength
SceWChar16 * inputTextBuffer
SceUChar8 enterLabel
SceUChar8 reserved[7]

Macro Definition Documentation

◆ SCE_IME_DIALOG_MAX_TITLE_LENGTH

#define SCE_IME_DIALOG_MAX_TITLE_LENGTH   (128)

◆ SCE_IME_DIALOG_MAX_TEXT_LENGTH

#define SCE_IME_DIALOG_MAX_TEXT_LENGTH   (2048)

◆ SCE_IME_WORK_BUFFER_SIZE

#define SCE_IME_WORK_BUFFER_SIZE   (20*1024)

◆ SCE_IME_MAX_PREEDIT_LENGTH

#define SCE_IME_MAX_PREEDIT_LENGTH   (30)

◆ SCE_IME_MAX_TEXT_LENGTH

#define SCE_IME_MAX_TEXT_LENGTH   (2048)

Typedef Documentation

◆ SceImeTextFilter

typedef SceInt32(* SceImeTextFilter) (SceWChar16 *outText, SceUInt32 *outTextLength, const SceWChar16 *srcText, SceUInt32 srcTextLength)

◆ SceImeEventHandler

typedef void(* SceImeEventHandler) (void *arg, const SceImeEventData *e)

Enumeration Type Documentation

◆ SceImeDialogError

enum SceImeDialogError
Enumerator
SCE_IME_DIALOG_ERROR_PARAM 
SCE_IME_DIALOG_ERROR_INTERNAL 
SCE_IME_DIALOG_ERROR_INVALID_DIALOG_MODE 
SCE_IME_DIALOG_ERROR_INVALID_TEXT_BOX_MODE 
SCE_IME_DIALOG_ERROR_INVALID_TITLE 

◆ SceImeDialogDialogMode

enum SceImeDialogDialogMode
Enumerator
SCE_IME_DIALOG_DIALOG_MODE_DEFAULT 
SCE_IME_DIALOG_DIALOG_MODE_WITH_CANCEL 

◆ SceImeDialogTextboxMode

enum SceImeDialogTextboxMode
Enumerator
SCE_IME_DIALOG_TEXTBOX_MODE_DEFAULT 
SCE_IME_DIALOG_TEXTBOX_MODE_PASSWORD 
SCE_IME_DIALOG_TEXTBOX_MODE_WITH_CLEAR 

◆ SceImeDialogButton

enum SceImeDialogButton
Enumerator
SCE_IME_DIALOG_BUTTON_NONE 
SCE_IME_DIALOG_BUTTON_CLOSE 
SCE_IME_DIALOG_BUTTON_ENTER 

◆ SceImeErrorCode

enum SceImeErrorCode
Enumerator
SCE_IME_ERROR_ALREADY_OPENED 
SCE_IME_ERROR_NOT_OPENED 
SCE_IME_ERROR_INVALID_POINTER 
SCE_IME_ERROR_INVALID_PARAM 
SCE_IME_ERROR_NO_MEMORY 
SCE_IME_ERROR_CONNECTION_FAILED 
SCE_IME_ERROR_INVALID_TEXT 
SCE_IME_ERROR_TOO_MANY_REQUESTS 
SCE_IME_ERROR_INVALID_SIZE 
SCE_IME_ERROR_INVALID_INPUT_METHOD 
SCE_IME_ERROR_INVALID_SUPPORTED_LANGUAGES 
SCE_IME_ERROR_INVALID_TYPE 
SCE_IME_ERROR_INVALID_OPTION 
SCE_IME_ERROR_INVALID_WORK 
SCE_IME_ERROR_INVALID_ARG 
SCE_IME_ERROR_INVALID_HANDLER 
SCE_IME_ERROR_INVALID_MAX_TEXT_LENGTH 
SCE_IME_ERROR_INVALID_INPUT_TEXT_BUFFER 
SCE_IME_ERROR_INVALID_RESERVED 
SCE_IME_ERROR_INVALID_ENTER_LABEL 
SCE_IME_ERROR_INTERNAL 

◆ SceImeLanguage

enum SceImeLanguage
Enumerator
SCE_IME_LANGUAGE_DANISH 
SCE_IME_LANGUAGE_GERMAN 
SCE_IME_LANGUAGE_ENGLISH 
SCE_IME_LANGUAGE_SPANISH 
SCE_IME_LANGUAGE_FRENCH 
SCE_IME_LANGUAGE_ITALIAN 
SCE_IME_LANGUAGE_DUTCH 
SCE_IME_LANGUAGE_NORWEGIAN 
SCE_IME_LANGUAGE_POLISH 
SCE_IME_LANGUAGE_PORTUGUESE 
SCE_IME_LANGUAGE_RUSSIAN 
SCE_IME_LANGUAGE_FINNISH 
SCE_IME_LANGUAGE_SWEDISH 
SCE_IME_LANGUAGE_JAPANESE 
SCE_IME_LANGUAGE_KOREAN 
SCE_IME_LANGUAGE_SIMPLIFIED_CHINESE 
SCE_IME_LANGUAGE_TRADITIONAL_CHINESE 
SCE_IME_LANGUAGE_PORTUGUESE_BR 
SCE_IME_LANGUAGE_ENGLISH_GB 
SCE_IME_LANGUAGE_TURKISH 

◆ SceImeType

enum SceImeType
Enumerator
SCE_IME_TYPE_DEFAULT 
SCE_IME_TYPE_BASIC_LATIN 
SCE_IME_TYPE_NUMBER 
SCE_IME_TYPE_EXTENDED_NUMBER 
SCE_IME_TYPE_URL 
SCE_IME_TYPE_MAIL 

◆ SceImeEnterLabel

enum SceImeEnterLabel
Enumerator
SCE_IME_ENTER_LABEL_DEFAULT 
SCE_IME_ENTER_LABEL_SEND 
SCE_IME_ENTER_LABEL_SEARCH 
SCE_IME_ENTER_LABEL_GO 

◆ SceImeOption

enum SceImeOption
Enumerator
SCE_IME_OPTION_MULTILINE 
SCE_IME_OPTION_NO_AUTO_CAPITALIZATION 
SCE_IME_OPTION_NO_ASSISTANCE 

◆ SceImeEvent

enum SceImeEvent
Enumerator
SCE_IME_EVENT_OPEN 
SCE_IME_EVENT_UPDATE_TEXT 
SCE_IME_EVENT_UPDATE_CARET 
SCE_IME_EVENT_CHANGE_SIZE 
SCE_IME_EVENT_PRESS_CLOSE 
SCE_IME_EVENT_PRESS_ENTER 

Function Documentation

◆ VITASDK_BUILD_ASSERT_EQ() [1/9]

VITASDK_BUILD_ASSERT_EQ ( 0xA8  ,
SceImeDialogParam   
)

◆ VITASDK_BUILD_ASSERT_EQ() [2/9]

VITASDK_BUILD_ASSERT_EQ ( 0x24  ,
SceImeDialogResult   
)

◆ sceImeDialogInit()

SceInt32 sceImeDialogInit ( const SceImeDialogParam *  param)

◆ sceImeDialogGetStatus()

SceCommonDialogStatus sceImeDialogGetStatus ( void  )

◆ sceImeDialogAbort()

SceInt32 sceImeDialogAbort ( void  )

◆ sceImeDialogGetResult()

SceInt32 sceImeDialogGetResult ( SceImeDialogResult *  result)

◆ sceImeDialogTerm()

SceInt32 sceImeDialogTerm ( void  )

◆ VITASDK_BUILD_ASSERT_EQ() [3/9]

VITASDK_BUILD_ASSERT_EQ ( 0x10  ,
SceImeRect   
)

◆ VITASDK_BUILD_ASSERT_EQ() [4/9]

VITASDK_BUILD_ASSERT_EQ ( 0x18  ,
SceImeEditText   
)

◆ VITASDK_BUILD_ASSERT_EQ() [5/9]

VITASDK_BUILD_ASSERT_EQ ( 0x28  ,
SceImeEventParam   
)

◆ VITASDK_BUILD_ASSERT_EQ() [6/9]

VITASDK_BUILD_ASSERT_EQ ( 0x2C  ,
SceImeEventData   
)

◆ VITASDK_BUILD_ASSERT_EQ() [7/9]

VITASDK_BUILD_ASSERT_EQ ( 0x10  ,
SceImeCaret   
)

◆ VITASDK_BUILD_ASSERT_EQ() [8/9]

VITASDK_BUILD_ASSERT_EQ ( 0xC  ,
SceImePreeditGeometry   
)

◆ VITASDK_BUILD_ASSERT_EQ() [9/9]

VITASDK_BUILD_ASSERT_EQ ( 0x40  ,
SceImeParam   
)

◆ sceImeOpen()

SceInt32 sceImeOpen ( const SceImeParam *  param)

◆ sceImeUpdate()

SceInt32 sceImeUpdate ( void  )

◆ sceImeSetText()

SceInt32 sceImeSetText ( const SceWChar16 *  text,
SceUInt32  length 
)

◆ sceImeSetCaret()

SceInt32 sceImeSetCaret ( const SceImeCaret *  caret)

◆ sceImeSetPreeditGeometry()

SceInt32 sceImeSetPreeditGeometry ( const SceImePreeditGeometry *  preedit)

◆ sceImeClose()

SceInt32 sceImeClose ( void  )