tcMenu
Classes | Typedefs | Enumerations
BaseDialog.h File Reference

Go to the source code of this file.

Classes

class  BaseDialogController
 
class  BaseDialog
 
class  LocalDialogButtonMenuItem
 
class  MenuBasedDialog
 

Typedefs

typedef void(* CompletedHandlerFn) (ButtonType buttonPressed, void *yourData)
 

Enumerations

enum  ButtonType : uint8_t {
  BTNTYPE_OK, BTNTYPE_ACCEPT, BTNTYPE_CANCEL, BTNTYPE_CLOSE,
  BTNTYPE_NONE, BTNTYPE_CUSTOM0 = 15, BTNTYPE_CUSTOM1, BTNTYPE_CUSTOM2,
  BTNTYPE_CUSTOM3, BTNTYPE_CUSTOM4, BTNTYPE_CUSTOM5, BTNTYPE_CUSTOM6,
  BTNTYPE_CUSTOM7
}
 

Detailed Description

The definition of the base dialog object, that can be used with any display type. These are designed to handle simple user informational pages and questions.

Dialogs are a core function of tcMenu, and must be supported on all available platforms.

Typedef Documentation

◆ CompletedHandlerFn

typedef void(* CompletedHandlerFn) (ButtonType buttonPressed, void *yourData)

If you need to capture the finished state of the dialog, then you create a function to this spec and it will be called back once the dialog is dismissed. Example: void completedCallback(ButtonType buttonPressed);

Enumeration Type Documentation

◆ ButtonType

enum ButtonType : uint8_t

The types of button that can be passed to setButton for button 1 and button 2