vitasdk
Documentation of the vitasdk
Functions | Macros
User
Dialog » Message Dialog Library

Detailed Description

Exports for User.

Using this library in your project

Include the header file in your project:

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


Link the library to the executable:

SceCommonDialog_stub


Functions

 VITASDK_BUILD_ASSERT_EQ (0x38, SceMsgDialogButtonsParam)
 
 VITASDK_BUILD_ASSERT_EQ (0x28, SceMsgDialogUserMessageParam)
 
 VITASDK_BUILD_ASSERT_EQ (0x28, SceMsgDialogSystemMessageParam)
 
 VITASDK_BUILD_ASSERT_EQ (0x24, SceMsgDialogErrorCodeParam)
 
 VITASDK_BUILD_ASSERT_EQ (0x50, SceMsgDialogProgressBarParam)
 
 VITASDK_BUILD_ASSERT_EQ (0x88, SceMsgDialogParam)
 
 VITASDK_BUILD_ASSERT_EQ (0x2C, SceMsgDialogResult)
 
int sceMsgDialogInit (const SceMsgDialogParam *param)
 
SceCommonDialogStatus sceMsgDialogGetStatus (void)
 
int sceMsgDialogAbort (void)
 
int sceMsgDialogGetResult (SceMsgDialogResult *result)
 
int sceMsgDialogTerm (void)
 
int sceMsgDialogClose (void)
 
int sceMsgDialogProgressBarInc (SceMsgDialogProgressBarTarget target, SceUInt32 delta)
 Increases the rate of the progress bar in the message dialog. More...
 
int sceMsgDialogProgressBarSetValue (SceMsgDialogProgressBarTarget target, SceUInt32 rate)
 Set the progress rate of the progress bar in the message dialog immediately. More...
 
int sceMsgDialogProgressBarSetMsg (SceMsgDialogProgressBarTarget target, const SceChar8 *barMsg)
 Set the string displayed in the progress bar of the message dialog immediately. More...
 

Macros

#define SCE_MSG_DIALOG_USER_MSG_SIZE   512
 Max length of a user message. More...
 

Data Structure Documentation

◆ SceMsgDialogButtonsParam

struct SceMsgDialogButtonsParam
Data Fields
const char * msg1 Text of the first button.
SceInt32 fontSize1 Font size of the first button (one of SceMsgDialogFontSize)
const char * msg2 Text of the second button.
SceInt32 fontSize2 Font size of the second button (one of SceMsgDialogFontSize)
const char * msg3 Text of the third button.
SceInt32 fontSize3 Font size of the third button (one of SceMsgDialogFontSize)
SceChar8 reserved[32] Reserved range.

◆ SceMsgDialogUserMessageParam

struct SceMsgDialogUserMessageParam
Data Fields
SceInt32 buttonType Type of button set (one of SceMsgDialogButtonType)
const SceChar8 * msg Displayed message.
SceMsgDialogButtonsParam * buttonParam Buttons parameters.
SceChar8 reserved[28] Reserved range.

◆ SceMsgDialogSystemMessageParam

struct SceMsgDialogSystemMessageParam
Data Fields
SceInt32 sysMsgType System message type (one of SceMsgDialogSystemMessageType)
SceInt32 value Additional value.
SceChar8 reserved[32] Reserved range.

◆ SceMsgDialogErrorCodeParam

struct SceMsgDialogErrorCodeParam
Data Fields
SceInt32 errorCode Displayed error code.
SceChar8 reserved[32] Reserved range.

◆ SceMsgDialogProgressBarParam

struct SceMsgDialogProgressBarParam
Data Fields
SceInt32 barType Progress bar type (one of SceMsgDialogProgressBarType)
SceMsgDialogSystemMessageParam sysMsgParam Displayed system message.
const SceChar8 * msg Displayed user message.
SceInt32 reserved[8] Reserved range.

◆ SceMsgDialogParam

struct SceMsgDialogParam
Data Fields
SceUInt32 sdkVersion Required to use MsgDialog. Just use NULL.
SceCommonDialogParam commonParam Common parameter.
SceInt32 mode Mode of function (one of SceMsgDialogMode)
SceMsgDialogUserMessageParam * userMsgParam Parameter for user message.
SceMsgDialogSystemMessageParam * sysMsgParam Parameter for system prepared message.
SceMsgDialogErrorCodeParam * errorCodeParam Parameter for display error code.
SceMsgDialogProgressBarParam * progBarParam Parameter for progress bar.
SceInt32 flag Settings for dialog environment (one of SceMsgDialogEnvFlag)
SceChar8 reserved[32] Reserved range.

◆ SceMsgDialogResult

struct SceMsgDialogResult
Data Fields
SceInt32 mode Mode of function (one of SceMsgDialogMode)
SceInt32 result Result of executing function.
SceInt32 buttonId Id of button user selected (one of SceMsgDialogButtonId)
SceChar8 reserved[32] Reserved range.

Macro Definition Documentation

◆ SCE_MSG_DIALOG_USER_MSG_SIZE

#define SCE_MSG_DIALOG_USER_MSG_SIZE   512

Max length of a user message.

Enumeration Type Documentation

◆ SceMsgDialogErrorCode

enum SceMsgDialogErrorCode
Enumerator
SCE_MSG_DIALOG_ERROR_PARAM 

Illegal parameter.

◆ SceMsgDialogMode

enum SceMsgDialogMode
Enumerator
SCE_MSG_DIALOG_MODE_INVALID 
SCE_MSG_DIALOG_MODE_USER_MSG 
SCE_MSG_DIALOG_MODE_SYSTEM_MSG 
SCE_MSG_DIALOG_MODE_ERROR_CODE 
SCE_MSG_DIALOG_MODE_PROGRESS_BAR 

◆ SceMsgDialogSystemMessageType

enum SceMsgDialogSystemMessageType
Enumerator
SCE_MSG_DIALOG_SYSMSG_TYPE_INVALID 
SCE_MSG_DIALOG_SYSMSG_TYPE_WAIT 

Displays "Please wait.".

SCE_MSG_DIALOG_SYSMSG_TYPE_NOSPACE 

Displays "There is not enough free space on the memory card.".

SCE_MSG_DIALOG_SYSMSG_TYPE_MAGNETIC_CALIBRATION 

Displays "Move away from the source of interference, or adjust the compass by moving your PS Vita system as shown below.".

SCE_MSG_DIALOG_SYSMSG_TYPE_WAIT_SMALL 

Displays "Please wait." in a small message dialog.

SCE_MSG_DIALOG_SYSMSG_TYPE_WAIT_CANCEL 

Displays "Please wait..." with a cancel button.

SCE_MSG_DIALOG_SYSMSG_TYPE_NEED_MC_CONTINUE 

Displays "Cannot continue the application. No memory card is inserted.".

SCE_MSG_DIALOG_SYSMSG_TYPE_NEED_MC_OPERATION 

Displays "Cannot perform this operation. No memory card is inserted.".

SCE_MSG_DIALOG_SYSMSG_TYPE_TRC_MIC_DISABLED 

Displays "You must enable the microphone.".

SCE_MSG_DIALOG_SYSMSG_TYPE_TRC_WIFI_REQUIRED_OPERATION 

Displays "You must use Wi-Fi to do this.".

SCE_MSG_DIALOG_SYSMSG_TYPE_TRC_WIFI_REQUIRED_APPLICATION 

Displays "You must use Wi-Fi to use this application.".

SCE_MSG_DIALOG_SYSMSG_TYPE_TRC_EMPTY_STORE 

Displays "No content is available yet.".

◆ SceMsgDialogButtonType

enum SceMsgDialogButtonType
Enumerator
SCE_MSG_DIALOG_BUTTON_TYPE_OK 
SCE_MSG_DIALOG_BUTTON_TYPE_YESNO 
SCE_MSG_DIALOG_BUTTON_TYPE_NONE 
SCE_MSG_DIALOG_BUTTON_TYPE_OK_CANCEL 
SCE_MSG_DIALOG_BUTTON_TYPE_CANCEL 
SCE_MSG_DIALOG_BUTTON_TYPE_3BUTTONS 

◆ SceMsgDialogButtonId

enum SceMsgDialogButtonId
Enumerator
SCE_MSG_DIALOG_BUTTON_ID_INVALID 
SCE_MSG_DIALOG_BUTTON_ID_OK 
SCE_MSG_DIALOG_BUTTON_ID_YES 
SCE_MSG_DIALOG_BUTTON_ID_NO 
SCE_MSG_DIALOG_BUTTON_ID_RETRY 
SCE_MSG_DIALOG_BUTTON_ID_BUTTON1 
SCE_MSG_DIALOG_BUTTON_ID_BUTTON2 
SCE_MSG_DIALOG_BUTTON_ID_BUTTON3 

◆ SceMsgDialogProgressBarType

enum SceMsgDialogProgressBarType
Enumerator
SCE_MSG_DIALOG_PROGRESSBAR_TYPE_PERCENTAGE 

◆ SceMsgDialogProgressBarTarget

enum SceMsgDialogProgressBarTarget
Enumerator
SCE_MSG_DIALOG_PROGRESSBAR_TARGET_BAR_DEFAULT 

◆ SceMsgDialogEnvFlag

enum SceMsgDialogEnvFlag
Enumerator
SCE_MSG_DIALOG_ENV_FLAG_DEFAULT 

◆ SceMsgDialogFontSize

enum SceMsgDialogFontSize
Enumerator
SCE_MSG_DIALOG_FONT_SIZE_DEFAULT 
SCE_MSG_DIALOG_FONT_SIZE_SMALL 

Function Documentation

◆ VITASDK_BUILD_ASSERT_EQ() [1/7]

VITASDK_BUILD_ASSERT_EQ ( 0x38  ,
SceMsgDialogButtonsParam   
)

◆ VITASDK_BUILD_ASSERT_EQ() [2/7]

VITASDK_BUILD_ASSERT_EQ ( 0x28  ,
SceMsgDialogUserMessageParam   
)

◆ VITASDK_BUILD_ASSERT_EQ() [3/7]

VITASDK_BUILD_ASSERT_EQ ( 0x28  ,
SceMsgDialogSystemMessageParam   
)

◆ VITASDK_BUILD_ASSERT_EQ() [4/7]

VITASDK_BUILD_ASSERT_EQ ( 0x24  ,
SceMsgDialogErrorCodeParam   
)

◆ VITASDK_BUILD_ASSERT_EQ() [5/7]

VITASDK_BUILD_ASSERT_EQ ( 0x50  ,
SceMsgDialogProgressBarParam   
)

◆ VITASDK_BUILD_ASSERT_EQ() [6/7]

VITASDK_BUILD_ASSERT_EQ ( 0x88  ,
SceMsgDialogParam   
)

◆ VITASDK_BUILD_ASSERT_EQ() [7/7]

VITASDK_BUILD_ASSERT_EQ ( 0x2C  ,
SceMsgDialogResult   
)

◆ sceMsgDialogInit()

int sceMsgDialogInit ( const SceMsgDialogParam *  param)

◆ sceMsgDialogGetStatus()

SceCommonDialogStatus sceMsgDialogGetStatus ( void  )

◆ sceMsgDialogAbort()

int sceMsgDialogAbort ( void  )

◆ sceMsgDialogGetResult()

int sceMsgDialogGetResult ( SceMsgDialogResult *  result)

◆ sceMsgDialogTerm()

int sceMsgDialogTerm ( void  )

◆ sceMsgDialogClose()

int sceMsgDialogClose ( void  )

◆ sceMsgDialogProgressBarInc()

int sceMsgDialogProgressBarInc ( SceMsgDialogProgressBarTarget  target,
SceUInt32  delta 
)

Increases the rate of the progress bar in the message dialog.

Parameters
target- Target progress bar
delta- Progress rate to increase (%)
Returns
0 on success, < 0 on error.
Note
- If NULL is provided as FrameBuf pointer, output is blacked out.

◆ sceMsgDialogProgressBarSetValue()

int sceMsgDialogProgressBarSetValue ( SceMsgDialogProgressBarTarget  target,
SceUInt32  rate 
)

Set the progress rate of the progress bar in the message dialog immediately.

Parameters
target- Target progress bar
delta- Progress rate to increase (%)
Returns
0 on success, < 0 on error.
Note
- If NULL is provided as FrameBuf pointer, output is blacked out.

◆ sceMsgDialogProgressBarSetMsg()

int sceMsgDialogProgressBarSetMsg ( SceMsgDialogProgressBarTarget  target,
const SceChar8 *  barMsg 
)

Set the string displayed in the progress bar of the message dialog immediately.

Parameters
target- Target progress bar
barMsg- The string displayed in the progress bar
Returns
0 on success, < 0 on error.
Note
- If NULL is provided as FrameBuf pointer, output is blacked out.