1 /*---------------------------------------------------------------------------* 2 3 Copyright (C) 2012 Nintendo. All rights reserved. 4 5 These coded instructions, statements, and computer programs contain 6 proprietary information of Nintendo of America Inc. and/or Nintendo 7 Company Ltd., and are protected by Federal copyright law. They may 8 not be disclosed to third parties or copied or duplicated in any form, 9 in whole or in part, without the prior written consent of Nintendo. 10 11 *---------------------------------------------------------------------------*/ 12 13 //------------------------------------------------------------------------------ 14 /** @file erreula_Types.h 15 * @brief Error viewer definitions. 16 */ 17 //------------------------------------------------------------------------------ 18 #ifndef NN_ERREULA_TYPES_H_ 19 #define NN_ERREULA_TYPES_H_ 20 21 /** @namespace nn::erreula 22 * The namespace for <tt>erreula</tt>. 23 */ 24 namespace nn { 25 //------------------------------------------------------------------------------ 26 namespace erreula { 27 //------------------------------------------------------------------------------ 28 ///@defgroup enum Enumerated Types 29 ///@{ 30 31 /// Display screen. (Specification for the screen to display the error viewer on.) 32 enum ScreenType 33 { 34 cScreenType_Tv ///< Television. 35 , cScreenType_Drc ///< Wii U GamePad controller. 36 , cScreenType_Dual ///< Both screens (TV and Wii U GamePad). 37 , cScreenType_Max 38 }; 39 40 /// Error type. (Specifications for display in the error viewer.) 41 enum ErrorType 42 { 43 cErrorType_Code ///< Code specification. (Message and buttons are determined based on the error code.) 44 , cErrorType_Text ///< Free text. (Buttons are not displayed.) 45 , cErrorType_TextBtn ///< Free text. (One button is displayed.) 46 , cErrorType_Text2Btn ///< Free text. (Two buttons are displayed.) 47 , cErrorType_Max 48 }; 49 50 /// The type of Wii Remote. (Specifies the controller that operates the error viewer.) 51 enum ControllerType 52 { 53 cControllerType_Remo0 ///< Wii Remote 0. 54 , cControllerType_Remo1 ///< Wii Remote 1. 55 , cControllerType_Remo2 ///< Wii Remote 2. 56 , cControllerType_Remo3 ///< Wii Remote 3. 57 , cControllerType_None ///< Not used. 58 , cControllerType_Max 59 }; 60 61 /// How the Wii Remote is held. 62 enum RemoCtrlHoldType 63 { 64 cRemoCtrlHoldType_Normal ///< Held vertically. 65 , cRemoCtrlHoldType_Side ///< Held horizontally. 66 , cRemoCtrlHoldType_Max 67 }; 68 69 /// Region type. 70 enum RegionType 71 { 72 cRegionType_Jp ///< Japan. 73 , cRegionType_Us ///< North America. 74 , cRegionType_Eu ///< Europe. 75 , cRegionType_Cn ///< China. 76 , cRegionType_Kr ///< Korea. 77 , cRegionType_Tw ///< Taiwan. 78 , cRegionType_Max 79 }; 80 81 /// The language type. (The language in which messages and other text are displayed during code specification.) 82 enum LangType 83 { 84 cLangType_Ja ///< Japanese language. 85 , cLangType_En ///< English. 86 , cLangType_Fr ///< French. 87 , cLangType_Ge ///< German. 88 , cLangType_It ///< Italian. 89 , cLangType_Sp ///< Spanish. 90 , cLangType_Cn ///< Chinese. 91 , cLangType_Kr ///< Korean language. 92 , cLangType_Du ///< Dutch. 93 , cLangType_Po ///< Portuguese. 94 , cLangType_Ru ///< Russian. 95 , cLangType_Tw ///< Traditional Chinese. 96 , cLangType_Max 97 }; 98 99 /// Displays the state of the error viewer. (Transitions from Hidden → Appearing → Displayed → Disappearing → Hidden.) 100 enum State 101 { 102 cState_Blank ///< Hidden. 103 , cState_Appear ///< Appearing. (The error viewer has come into view.) 104 , cState_Display ///< Displayed. 105 , cState_Disappear ///< Disappearing. (The error viewer is disappearing from view.) 106 , cState_Max 107 }; 108 109 /// The action for the error viewer to take next, based on user input. 110 enum ResultType 111 { 112 cResultType_Non ///< None. (Undefined state.) 113 , cResultType_Finish ///< The user has checked the message. Hide the error viewer and proceed with the processing of the application. Do not use a result code. 114 , cResultType_Next ///< A message is displayed continuously. Display the error viewer again, using the result code obtained with the <tt>nn::erreula::GetResultCode</tt> function as the error code. 115 , cResultType_Jump ///< The user has selected to make an application jump. Close the error viewer, call the <tt>nn::erreula::Jump</tt> function, and then execute the application jump. The <tt>nn::erreula::Jump</tt> function looks at the result code and either jumps to the appropriate application or restarts the application. 116 , cResultType_PinCode ///< Execute the PIN unlock sequence. Do not use a result code. 117 , cResultType_Max 118 }; 119 ///@} 120 121 //------------------------------------------------------------------------------ 122 } // namespace erreula 123 //------------------------------------------------------------------------------ 124 } // namespace nn 125 126 #endif // NN_ERREULA_TYPES_H_ 127 128