Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
KODI::MESSAGING::HELPERS::DialogYesNoMessage Struct Reference

Payload sent for message TMSG_GUI_DIALOG_YESNO. More...

#include "messaging/helpers/DialogHelper.h"

Public Attributes

CVariant heading
 Heading to be displayed in the dialog box.
 
CVariant text
 Body text to be displayed, this is mutually exclusive with lines below.
 
std::array< CVariant, 3 > lines
 Body text to be displayed, specified as three lines. This is mutually exclusive with the text above.
 
CVariant yesLabel
 Text to show on the yes button.
 
CVariant noLabel
 Text to show on the no button.
 
CVariant customLabel
 Text to show on the 3rd custom button.
 
uint32_t autoclose {0}
 Time in milliseconds before autoclosing the dialog, 0 means don't autoclose.
 

Detailed Description

Payload sent for message TMSG_GUI_DIALOG_YESNO.

See also
ShowDialogText
ShowDialogLines

Member Data Documentation

◆ autoclose

uint32_t KODI::MESSAGING::HELPERS::DialogYesNoMessage::autoclose {0}

Time in milliseconds before autoclosing the dialog, 0 means don't autoclose.

◆ customLabel

CVariant KODI::MESSAGING::HELPERS::DialogYesNoMessage::customLabel

Text to show on the 3rd custom button.

◆ heading

CVariant KODI::MESSAGING::HELPERS::DialogYesNoMessage::heading

Heading to be displayed in the dialog box.

◆ lines

std::array<CVariant, 3> KODI::MESSAGING::HELPERS::DialogYesNoMessage::lines

Body text to be displayed, specified as three lines. This is mutually exclusive with the text above.

◆ noLabel

CVariant KODI::MESSAGING::HELPERS::DialogYesNoMessage::noLabel

Text to show on the no button.

◆ text

CVariant KODI::MESSAGING::HELPERS::DialogYesNoMessage::text

Body text to be displayed, this is mutually exclusive with lines below.

◆ yesLabel

CVariant KODI::MESSAGING::HELPERS::DialogYesNoMessage::yesLabel

Text to show on the yes button.


The documentation for this struct was generated from the following file: