blob: 574bed68665fb73115ef5b5dedee84ae8d05bd36 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "utils/Variant.h"
#include <array>
#include <string>
namespace KODI
{
namespace MESSAGING
{
namespace HELPERS
{
/*! \struct DialogOkMessage DialogHelper.h "messaging/helpers/DialogHelper.h"
\brief Payload sent for message TMSG_GUI_DIALOG_OK
\sa ShowOKDialogText
\sa ShowOKDialogLines
*/
struct DialogOKMessage
{
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
bool show = true; //!< bool to see if the dialog needs to be shown
};
/*!
\brief This is a helper method to send a threadmessage to update a Ok dialog text
\param[in] heading The text to display as the dialog box header
\param[in] text The text to display in the dialog body
\sa ShowOKDialogLines
\sa CGUIDialogOK::ShowAndGetInput
\sa DialogOKMessage
*/
void UpdateOKDialogText(CVariant heading, CVariant text);
/*!
\brief This is a helper method to send a threadmessage to open a Ok dialog box
\param[in] heading The text to display as the dialog box header
\param[in] text The text to display in the dialog body
\return if it's confirmed
\sa UpdateOKDialogLines
\sa CGUIDialogOK::ShowAndGetInput
\sa DialogOKMessage
*/
bool ShowOKDialogText(CVariant heading, CVariant text);
/*!
\brief This is a helper method to send a threadmessage to open a OK dialog box
\param[in] heading The text to display as the dialog box header
\param[in] line0 The text to display on the first line
\param[in] line1 The text to display on the second line
\param[in] line2 The text to display on the third line
\return if it's confirmed
\sa ShowOKDialogText
\sa CGUIDialogOK::ShowAndGetInput
\sa DialogOKMessage
*/
bool ShowOKDialogLines(CVariant heading, CVariant line0, CVariant line1 = CVariant(),
CVariant line2 = CVariant());
}
}
}
|
