Utility Library


Defines

#define PGE_UTILS_NET_DIALOG_ADHOC_CONNECT   2
#define PGE_UTILS_NET_DIALOG_ADHOC_CREATE   4
#define PGE_UTILS_NET_DIALOG_ADHOC_JOIN   5
#define PGE_UTILS_ADHOC_GAMESHARE_NAME   "GameShar"
#define PGE_UTILS_MSG_DIALOG_NO_OPTIONS   0x00000000
#define PGE_UTILS_MSG_DIALOG_YESNO_BUTTONS   0x00000010
#define PGE_UTILS_MSG_DIALOG_DEFAULT_BUTTON_NO   0x00000100
#define PGE_UTILS_MSG_DIALOG_RESULT_YES   1
#define PGE_UTILS_MSG_DIALOG_RESULT_NO   2
#define PGE_UTILS_MSG_DIALOG_RESULT_BACK   3
#define PGE_UTILS_SAVEDATA_TYPE_AUTOLOAD   0
#define PGE_UTILS_SAVEDATA_TYPE_AUTOSAVE   1
#define PGE_UTILS_SAVEDATA_TYPE_LISTLOAD   4
#define PGE_UTILS_SAVEDATA_TYPE_LISTSAVE   5
#define PGE_UTILS_SAVEDATA_TYPE_LISTDELETE   7
#define PGE_UTILS_DIALOG_RUNNING   -1

Functions

int pgeUtilsSavedataInit (int type, void *data, unsigned int datasize, const char *gamename, const char *key, const char *title, const char *subtitle, const char *detail)
int pgeUtilsSavedataUpdate (void)
int pgeUtilsBrowserInit (int memorysize, const char *url)
int pgeUtilsBrowserUpdate (void)
int pgeUtilsNetDialogInit (void)
int pgeUtilsNetDialogUpdate (void)
int pgeUtilsAdhocDialogInit (int type, char *name)
int pgeUtilsAdhocDialogUpdate (void)
int pgeUtilsGameShareInit (const char *filepath, const char *name)
int pgeUtilsGameShareUpdate (void)
int pgeUtilsMsgDialogInit (int options, const char *text,...)
int pgeUtilsMsgDialogErrorInit (unsigned int error)
int pgeUtilsMsgDialogUpdate (void)
int pgeUtilsMsgDialogAbort (void)
int pgeUtilsOskInit (char *description, char *initialtext)
int pgeUtilsOskUpdate (char *outtext)

Define Documentation

#define PGE_UTILS_ADHOC_GAMESHARE_NAME   "GameShar"

#define PGE_UTILS_DIALOG_RUNNING   -1

#define PGE_UTILS_MSG_DIALOG_DEFAULT_BUTTON_NO   0x00000100

#define PGE_UTILS_MSG_DIALOG_NO_OPTIONS   0x00000000

#define PGE_UTILS_MSG_DIALOG_RESULT_BACK   3

#define PGE_UTILS_MSG_DIALOG_RESULT_NO   2

#define PGE_UTILS_MSG_DIALOG_RESULT_YES   1

#define PGE_UTILS_MSG_DIALOG_YESNO_BUTTONS   0x00000010

#define PGE_UTILS_NET_DIALOG_ADHOC_CONNECT   2

#define PGE_UTILS_NET_DIALOG_ADHOC_CREATE   4

#define PGE_UTILS_NET_DIALOG_ADHOC_JOIN   5

#define PGE_UTILS_SAVEDATA_TYPE_AUTOLOAD   0

#define PGE_UTILS_SAVEDATA_TYPE_AUTOSAVE   1

#define PGE_UTILS_SAVEDATA_TYPE_LISTDELETE   7

#define PGE_UTILS_SAVEDATA_TYPE_LISTLOAD   4

#define PGE_UTILS_SAVEDATA_TYPE_LISTSAVE   5


Function Documentation

int pgeUtilsAdhocDialogInit ( int  type,
char *  name 
)

Init adhoc dialog

Parameters:
type - Either PGE_UTILS_NET_DIALOG_ADHOC_CONNECT, PGE_UTILS_NET_DIALOG_ADHOC_CREATE or PGE_UTILS_NET_DIALOG_ADHOC_JOIN
name - Either PGE_UTILS_ADHOC_GAMESHARE_NAME for gamesharing or an 8 character string for the group name
Returns:
1 on success, 0 on error.

int pgeUtilsAdhocDialogUpdate ( void   ) 

Update adhoc dialog

Returns:
-1 if dialog is still running, 0 on success, 1 if user cancelled.

int pgeUtilsBrowserInit ( int  memorysize,
const char *  url 
)

Init browser dialog

Parameters:
memory - The amount of memory to use for the browser (in bytes)
url - The initial URL to open on launch
Returns:
1 on success, 0 on error.

int pgeUtilsBrowserUpdate ( void   ) 

Update browser dialog

Returns:
-1 if dialog is still running, 0 on success, 1 if user cancelled.

int pgeUtilsGameShareInit ( const char *  filepath,
const char *  name 
)

Init gameshare dialog

Parameters:
filepath - Path to the EBOOT to share
name - Name of the program (that will be displayed to the receiver)
Returns:
1 on success, 0 on error.

int pgeUtilsGameShareUpdate ( void   ) 

Update gameshare dialog

Returns:
-1 if dialog is still running, 0 on success, 1 if user cancelled.

int pgeUtilsMsgDialogAbort ( void   ) 

Abort a running message dialog

Returns:
1 on success, < 0 on error.

int pgeUtilsMsgDialogErrorInit ( unsigned int  error  ) 

Init message dialog (error)

Parameters:
error - Error number to display
Returns:
1 on success, 0 on error.

int pgeUtilsMsgDialogInit ( int  options,
const char *  text,
  ... 
)

Init message dialog

Parameters:
options - One or more of PGE_UTILS_MSG_DIALOG_NO_OPTIONS, PGE_UTILS_MSG_DIALOG_YESNO_BUTTONS, PGE_UTILS_MSG_DIALOG_DEFAULT_BUTTON_NO
text - Text that is displayed in the dialog
Returns:
1 on success, 0 on error.

int pgeUtilsMsgDialogUpdate ( void   ) 

Update gameshare dialog

Returns:
-1 if dialog is still running, PGE_UTILS_MSG_DIALOG_RESULT_YES, PGE_UTILS_MSG_DIALOG_RESULT_NO or PGE_UTILS_MSG_DIALOG_RESULT_BACK if button pressed.

int pgeUtilsNetDialogInit ( void   ) 

Init net dialog

Returns:
1 on success, 0 on error.

int pgeUtilsNetDialogUpdate ( void   ) 

Update net dialog

Returns:
-1 if dialog is still running, 0 on success, 1 if user cancelled.

int pgeUtilsOskInit ( char *  description,
char *  initialtext 
)

Init OSK dialog

Parameters:
description - Description that is displayed to the user (pass NULL for none)
initialtext - Initial text in the entry field (pass NULL for none)
Returns:
1 on success, 0 on error.

int pgeUtilsOskUpdate ( char *  outtext  ) 

Update OSK dialog

Parameters:
outtext - Pointer to a buffer to store the text that has been input.
Returns:
-1 if dialog is still running, 0 if the text is unchanged, 1 if cancelled or 2 if the text has been changed.

int pgeUtilsSavedataInit ( int  type,
void *  data,
unsigned int  datasize,
const char *  gamename,
const char *  key,
const char *  title,
const char *  subtitle,
const char *  detail 
)

Save or load savedata dialog

Parameters:
type - PGE_UTILS_SAVEDATA_TYPE_AUTOLOAD, PGE_UTILS_SAVEDATA_TYPE_LISTSAVE etc.
data - The data to save, or a buffer to load the data into.
datasize - Size of the data.
gamename - The game name to save under (must be 9 characters long).
key - The unique key (password) for the save (must be 16 characters long).
title - The game title that is seen on the save/load/VSH screen (max 128 characters).
subtitle - The second title that is seen on the save/load/VSH screen (max 128 characters).
detail - The detail that is seen on the save/load/VSH screen (max 1024 characters).
Returns:
1 on success, 0 on error.

int pgeUtilsSavedataUpdate ( void   ) 

Update savedata dialog

Returns:
-1 if dialog is still running, 0 on success, 1 if user cancelled.


Generated on Mon Sep 22 16:58:14 2008 for Phoenix Game Engine by  doxygen 1.5.5