tcMenu
Public Member Functions | Static Public Attributes | List of all members
DialogMultiPartEditor Class Reference
Inheritance diagram for DialogMultiPartEditor:
BaseDialogController

Public Member Functions

void startEditing (MenuBasedDialog *dlg, EditableMultiPartMenuItem *item)
 
void scrollChanged ()
 
void dialogDismissed (ButtonType buttonType) override
 
bool dialogButtonPressed (int buttonNum) override
 
void copyCustomButtonText (int buttonNumber, char *buffer, size_t bufferSize) override
 
void initialiseAndGetHeader (BaseDialog *dialog, char *buffer, size_t bufferSize) override
 

Static Public Attributes

static DialogMultiPartEditortheInstance
 

Member Function Documentation

◆ dialogDismissed()

void DialogMultiPartEditor::dialogDismissed ( ButtonType  buttonType)
overridevirtual

Called when the dialog is dismissed, along with with the button type that was pressed

Parameters
buttonTypethe button type that was pressed

Implements BaseDialogController.

◆ dialogButtonPressed()

bool DialogMultiPartEditor::dialogButtonPressed ( int  buttonNum)
overridevirtual

Called when a dialog button is pressed, the button number from 0..N not the button type.

Parameters
buttonNumthe button number
Returns
true if the action results in the dialog being dismissed

Implements BaseDialogController.

◆ copyCustomButtonText()

void DialogMultiPartEditor::copyCustomButtonText ( int  buttonNumber,
char *  buffer,
size_t  bufferSize 
)
overridevirtual

Copy the button text for any custom buttons by their button number

Parameters
buttonNumberthe button number
bufferthe buffer to copy text into
bufferSizethe size of the buffer

Implements BaseDialogController.

◆ initialiseAndGetHeader()

void DialogMultiPartEditor::initialiseAndGetHeader ( BaseDialog dialog,
char *  buffer,
size_t  bufferSize 
)
overridevirtual

Initialise the dialog and get the text for the header. It is called once during the dialog being shown. If you need to add extra menu items or buttons, this is the place to add them.

Parameters
dialogthe dialog object
bufferthe buffer to copy the title to
bufferSizethe size of the buffer

Implements BaseDialogController.


The documentation for this class was generated from the following files: