KODI::MESSAGING::HELPERS Namespace Reference

Classes
struct	DialogOKMessage
struct	DialogYesNoMessage
	Payload sent for message TMSG_GUI_DIALOG_YESNO. More...

Enumerations
enum class	DialogResponse : int { CHOICE_CANCELLED , CHOICE_YES , CHOICE_NO , CHOICE_CUSTOM }

Functions
DialogResponse	ShowYesNoDialogText (CVariant heading, CVariant text, CVariant noLabel=CVariant(), CVariant yesLabel=CVariant(), uint32_t autoCloseTimeout=0)
	This is a helper method to send a threadmessage to open a Yes/No dialog box.
DialogResponse	ShowYesNoCustomDialog (CVariant heading, CVariant text, CVariant noLabel=CVariant(), CVariant yesLabel=CVariant(), CVariant customLabel=CVariant(), uint32_t autoCloseTimeout=0)
	This is a helper method to send a threadmessage to open a Yes/No dialog box with a custom button.
DialogResponse	ShowYesNoDialogLines (CVariant heading, CVariant line0, CVariant line1=CVariant(), CVariant line2=CVariant(), CVariant noLabel=CVariant(), CVariant yesLabel=CVariant(), uint32_t autoCloseTimeout=0)
	This is a helper method to send a threadmessage to open a Yes/No dialog box.
bool	ShowOKDialogText (CVariant heading, CVariant text)
	This is a helper method to send a threadmessage to open a Ok dialog box.
void	UpdateOKDialogText (CVariant heading, CVariant text)
	This is a helper method to send a threadmessage to update a Ok dialog text.
bool	ShowOKDialogLines (CVariant heading, CVariant line0, CVariant line1=CVariant(), CVariant line2=CVariant())
	This is a helper method to send a threadmessage to open a OK dialog box.

Enumeration Type Documentation

DialogResponse

enum class KODI::MESSAGING::HELPERS::DialogResponse : int

strong

Enumerator
CHOICE_CANCELLED
CHOICE_YES
CHOICE_NO
CHOICE_CUSTOM

Function Documentation

ShowOKDialogLines()

bool KODI::MESSAGING::HELPERS::ShowOKDialogLines	(	CVariant	heading,
		CVariant	line0,
		CVariant	line1 = CVariant(),
		CVariant	line2 = CVariant() )

This is a helper method to send a threadmessage to open a OK dialog box.

Parameters

[in]	heading	The text to display as the dialog box header
[in]	line0	The text to display on the first line
[in]	line1	The text to display on the second line
[in]	line2	The text to display on the third line

Returns

if it's confirmed

See also

ShowOKDialogText

CGUIDialogOK::ShowAndGetInput

DialogOKMessage

ShowOKDialogText()

bool KODI::MESSAGING::HELPERS::ShowOKDialogText	(	CVariant	heading,
		CVariant	text )

This is a helper method to send a threadmessage to open a Ok dialog box.

Parameters

[in]	heading	The text to display as the dialog box header
[in]	text	The text to display in the dialog body

Returns

if it's confirmed

See also

UpdateOKDialogLines

CGUIDialogOK::ShowAndGetInput

DialogOKMessage

ShowYesNoCustomDialog()

DialogResponse KODI::MESSAGING::HELPERS::ShowYesNoCustomDialog	(	CVariant	heading,
		CVariant	text,
		CVariant	noLabel = CVariant(),
		CVariant	yesLabel = CVariant(),
		CVariant	customLabel = CVariant(),
		uint32_t	autoCloseTimeout = 0 )

This is a helper method to send a threadmessage to open a Yes/No dialog box with a custom button.

Parameters

[in]	heading	The text to display as the dialog box header
[in]	text	The text to display in the dialog body
[in]	noLabel	The text to display on the No button defaults to No
[in]	yesLabel	The text to display on the Yes button defaults to Yes
[in]	customLabel	The text to display on the optional 3rd custom button defaults to empty and button not shown
[in]	autoCloseTimeout	The time before the dialog closes defaults to 0 show indefinitely

Returns

-1 on cancelled, 0 on no, 1 on yes and 2 on 3rd custom response

See also

ShowYesNoDialogLines

CGUIDialogYesNo::ShowAndGetInput

DialogYesNoMessage

ShowYesNoDialogLines()

DialogResponse KODI::MESSAGING::HELPERS::ShowYesNoDialogLines	(	CVariant	heading,
		CVariant	line0,
		CVariant	line1 = CVariant(),
		CVariant	line2 = CVariant(),
		CVariant	noLabel = CVariant(),
		CVariant	yesLabel = CVariant(),
		uint32_t	autoCloseTimeout = 0 )

This is a helper method to send a threadmessage to open a Yes/No dialog box.

Parameters

[in]	heading	The text to display as the dialog box header
[in]	line0	The text to display on the first line
[in]	line1	The text to display on the second line
[in]	line2	The text to display on the third line
[in]	noLabel	The text to display on the No button defaults to No
[in]	yesLabel	The text to display on the Yes button defaults to Yes
[in]	autoCloseTimeout	The time before the dialog closes defaults to 0 show indefinitely

Returns

-1 on cancelled, 0 on no and 1 on yes

See also

ShowYesNoDialogText

CGUIDialogYesNo::ShowAndGetInput

DialogYesNoMessage

ShowYesNoDialogText()

DialogResponse KODI::MESSAGING::HELPERS::ShowYesNoDialogText	(	CVariant	heading,
		CVariant	text,
		CVariant	noLabel = CVariant(),
		CVariant	yesLabel = CVariant(),
		uint32_t	autoCloseTimeout = 0 )

This is a helper method to send a threadmessage to open a Yes/No dialog box.

Parameters

[in]	heading	The text to display as the dialog box header
[in]	text	The text to display in the dialog body
[in]	noLabel	The text to display on the No button defaults to No
[in]	yesLabel	The text to display on the Yes button defaults to Yes
[in]	autoCloseTimeout	The time before the dialog closes defaults to 0 show indefinitely

Returns

-1 on cancelled, 0 on no and 1 on yes

See also

ShowYesNoDialogLines

CGUIDialogYesNo::ShowAndGetInput

DialogYesNoMessage

UpdateOKDialogText()

void KODI::MESSAGING::HELPERS::UpdateOKDialogText	(	CVariant	heading,
		CVariant	text )

This is a helper method to send a threadmessage to update a Ok dialog text.

Parameters

[in]	heading	The text to display as the dialog box header
[in]	text	The text to display in the dialog body

See also

ShowOKDialogLines

CGUIDialogOK::ShowAndGetInput

DialogOKMessage