diff options
Diffstat (limited to 'ui.h')
| -rw-r--r-- | ui.h | 68 |
1 files changed, 30 insertions, 38 deletions
@@ -30,14 +30,14 @@ class RecoveryUI { virtual ~RecoveryUI() {} - // Initialize the object; called before anything else. UI texts will be - // initialized according to the given locale. Returns true on success. + // Initializes the object; called before anything else. UI texts will be initialized according to + // the given locale. Returns true on success. virtual bool Init(const std::string& locale); - // Show a stage indicator. Call immediately after Init(). + // Shows a stage indicator. Called immediately after Init(). virtual void SetStage(int current, int max) = 0; - // Set the overall recovery state ("background image"). + // Sets the overall recovery state ("background image"). enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR }; virtual void SetBackground(Icon icon) = 0; virtual void SetSystemUpdateText(bool security_update) = 0; @@ -46,13 +46,13 @@ class RecoveryUI { enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE }; virtual void SetProgressType(ProgressType determinate) = 0; - // Show a progress bar and define the scope of the next operation: + // Shows a progress bar and define the scope of the next operation: // portion - fraction of the progress bar the next operation will use // seconds - expected time interval (progress bar moves at this minimum rate) virtual void ShowProgress(float portion, float seconds) = 0; - // Set progress bar position (0.0 - 1.0 within the scope defined - // by the last call to ShowProgress). + // Sets progress bar position (0.0 - 1.0 within the scope defined by the last call to + // ShowProgress). virtual void SetProgress(float fraction) = 0; // --- text log --- @@ -63,9 +63,8 @@ class RecoveryUI { virtual bool WasTextEverVisible() = 0; - // Write a message to the on-screen log (shown if the user has - // toggled on the text display). Print() will also dump the message - // to stdout / log file, while PrintOnScreenOnly() not. + // Writes a message to the on-screen log (shown if the user has toggled on the text display). + // Print() will also dump the message to stdout / log file, while PrintOnScreenOnly() not. virtual void Print(const char* fmt, ...) __printflike(2, 3) = 0; virtual void PrintOnScreenOnly(const char* fmt, ...) __printflike(2, 3) = 0; @@ -73,54 +72,48 @@ class RecoveryUI { // --- key handling --- - // Wait for a key and return it. May return -1 after timeout. + // Waits for a key and return it. May return -1 after timeout. virtual int WaitKey(); virtual bool IsKeyPressed(int key); virtual bool IsLongPress(); - // Returns true if you have the volume up/down and power trio typical - // of phones and tablets, false otherwise. + // Returns true if you have the volume up/down and power trio typical of phones and tablets, false + // otherwise. virtual bool HasThreeButtons(); - // Erase any queued-up keys. + // Erases any queued-up keys. virtual void FlushKeys(); - // Called on each key press, even while operations are in progress. - // Return value indicates whether an immediate operation should be - // triggered (toggling the display, rebooting the device), or if + // Called on each key press, even while operations are in progress. Return value indicates whether + // an immediate operation should be triggered (toggling the display, rebooting the device), or if // the key should be enqueued for use by the main thread. enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE }; virtual KeyAction CheckKey(int key, bool is_long_press); - // Called when a key is held down long enough to have been a - // long-press (but before the key is released). This means that - // if the key is eventually registered (released without any other - // keys being pressed in the meantime), CheckKey will be called with - // 'is_long_press' true. + // Called when a key is held down long enough to have been a long-press (but before the key is + // released). This means that if the key is eventually registered (released without any other keys + // being pressed in the meantime), CheckKey will be called with 'is_long_press' true. virtual void KeyLongPress(int key); - // Normally in recovery there's a key sequence that triggers - // immediate reboot of the device, regardless of what recovery is - // doing (with the default CheckKey implementation, it's pressing - // the power button 7 times in row). Call this to enable or - // disable that feature. It is enabled by default. + // Normally in recovery there's a key sequence that triggers immediate reboot of the device, + // regardless of what recovery is doing (with the default CheckKey implementation, it's pressing + // the power button 7 times in row). Call this to enable or disable that feature. It is enabled by + // default. virtual void SetEnableReboot(bool enabled); // --- menu display --- - // Display some header text followed by a menu of items, which appears - // at the top of the screen (in place of any scrolling ui_print() - // output, if necessary). + // Display some header text followed by a menu of items, which appears at the top of the screen + // (in place of any scrolling ui_print() output, if necessary). virtual void StartMenu(const char* const* headers, const char* const* items, int initial_selection) = 0; - // Set the menu highlight to the given index, wrapping if necessary. - // Returns the actual item selected. + // Sets the menu highlight to the given index, wrapping if necessary. Returns the actual item + // selected. virtual int SelectMenu(int sel) = 0; - // End menu mode, resetting the text overlay so that ui_print() - // statements will be displayed. + // Ends menu mode, resetting the text overlay so that ui_print() statements will be displayed. virtual void EndMenu() = 0; protected: @@ -130,10 +123,9 @@ class RecoveryUI { std::string locale_; bool rtl_locale_; - // The normal and dimmed brightness percentages (default: 50 and 25, which means 50% and 25% - // of the max_brightness). Because the absolute values may vary across devices. These two - // values can be configured via subclassing. Setting brightness_normal_ to 0 to disable - // screensaver. + // The normal and dimmed brightness percentages (default: 50 and 25, which means 50% and 25% of + // the max_brightness). Because the absolute values may vary across devices. These two values can + // be configured via subclassing. Setting brightness_normal_ to 0 to disable screensaver. unsigned int brightness_normal_; unsigned int brightness_dimmed_; |