mirrors/neutrino
1
0
Fork 0
mirror of https://github.com/tuxbox-neutrino/neutrino.git synced 2025-09-01 09:51:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

comments: fix copy paste errors

Browse Source
This commit is contained in:
Thilo Graf
2017-08-28 12:16:45 +02:00
parent c743cb632b
commit 6e310a8157
9 changed files with 132 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
src/gui/widget/msgbox.h
View File

@@ -121,22 +121,22 @@ class CMsgBox : public CHintBox
public:
/**CMsgBox Constructor
* @param[in] Text
* @li exepts type const char*, this is the message text inside the window, text is UTF-8 encoded
* @li expects type const char*, this is the message text inside the window, text is UTF-8 encoded
* @param[in] Title
* @li optional: exepts type const char*, default = NULL, this causes default title "Information"
* @li optional: expects type const char*, default = NULL, this causes default title "Information"
* @param[in] Icon
* @li optional: exepts type const char*, defines the icon name on the left side of titlebar, default = DEFAULT_HEADER_ICON
* @li optional: expects type const char*, defines the icon name on the left side of titlebar, default = DEFAULT_HEADER_ICON
* @param[in] Picon
* @li optional: exepts type const char*, defines the picon name on the left side of message text, default = NULL (non Icon)
* @li optional: expects type const char*, defines the picon name on the left side of message text, default = NULL (non Icon)
* @param[in] Width
* @li optional: exepts type int, defines box width, default value = MSGBOX_MIN_WIDTH
* @li optional: expects type int, defines box width, default value = MSGBOX_MIN_WIDTH
* @param[in] Height
* @li optional: exepts type int, defines box width, default value = MSGBOX_MIN_HEIGHT
* @li optional: expects type int, defines box width, default value = MSGBOX_MIN_HEIGHT
* @param[in] ShowButtons
* @li optional: exepts type int, defines which buttons are available on screen, default value = mbCancel
* @li optional: expects type int, defines which buttons are available on screen, default value = mbCancel
* @see setShowedButtons()
* @param[in] Default_result
* @li optional: exepts type int, defines default result value, default value = mbrCancel
* @li optional: expects type int, defines default result value, default value = mbrCancel
* possible values are:
* mbrYes = 0,
* mbrNo = 1,
@@ -148,7 +148,7 @@ class CMsgBox : public CHintBox
* mbrNone = -1
* @see setDefaultResult(), getResult(); getDefaultResult(), enableDefaultResultOnTimeOut()
* @param[in] text_mode
* @li optional: exepts type int, defines the text modes for embedded text lines
* @li optional: expects type int, defines the text modes for embedded text lines
* Possible Modes defined in /gui/widget/textbox.h
* AUTO_WIDTH
* AUTO_HIGH
@@ -175,22 +175,22 @@ class CMsgBox : public CHintBox
/**CMsgBox Constructor
* @param[in] Text
* @li exepts type const char*, this is the message text inside the window, text is UTF-8 encoded
* @li expects type const char*, this is the message text inside the window, text is UTF-8 encoded
* @param[in] Title
* @li optional: exepts type neutrino_locale_t with locale entry from /system/locals.h default = NONEXISTANT_LOCALE, this causes default title "Information"
* @li optional: expects type neutrino_locale_t with locale entry from /system/locals.h default = NONEXISTANT_LOCALE, this causes default title "Information"
* @param[in] Icon
* @li optional: exepts type const char*, defines the icon name on the left side of titlebar, default = DEFAULT_HEADER_ICON
* @li optional: expects type const char*, defines the icon name on the left side of titlebar, default = DEFAULT_HEADER_ICON
* @param[in] Picon
* @li optional: exepts type const char*, defines the picon name on the left side of message text, default = NULL (non Icon)
* @li optional: expects type const char*, defines the picon name on the left side of message text, default = NULL (non Icon)
* @param[in] Width
* @li optional: exepts type int, defines box width, default value = MSGBOX_MIN_WIDTH
* @li optional: expects type int, defines box width, default value = MSGBOX_MIN_WIDTH
* @param[in] Height
* @li optional: exepts type int, defines box width, default value = MSGBOX_MIN_HEIGHT
* @li optional: expects type int, defines box width, default value = MSGBOX_MIN_HEIGHT
* @param[in] ShowButtons
* @li optional: exepts type int, defines which buttons are available on screen, default value = mbCancel
* @li optional: expects type int, defines which buttons are available on screen, default value = mbCancel
* @see setShowedButtons()
* @param[in] Default_result
* @li optional: exepts type int, defines default result value, default value = mbrCancel
* @li optional: expects type int, defines default result value, default value = mbrCancel
* possible values are:
* mbrYes = 0,
* mbrNo = 1,
@@ -202,7 +202,7 @@ class CMsgBox : public CHintBox
* mbrNone = -1
* @see setDefaultResult(), getResult(); getDefaultResult(), enableDefaultResultOnTimeOut()
* @param[in] text_mode
* @li optional: exepts type int, defines the text modes for embedded text lines
* @li optional: expects type int, defines the text modes for embedded text lines
* Possible Modes defined in /gui/widget/textbox.h
* AUTO_WIDTH
* AUTO_HIGH
@@ -249,7 +249,7 @@ class CMsgBox : public CHintBox
/**
* sets current default result as msg_result_t, independently from current selected button result
* @param[in] Default_result
* @li exepts type msg_result_t
* @li expects type msg_result_t
*/
void setDefaultResult(const msg_result_t& Default_result){default_result = Default_result;}
@@ -258,7 +258,7 @@ class CMsgBox : public CHintBox
* This member allows to set and overrides already defined buttons from constructor,
* parameter ''ShowButtons'' accepts given types, find under button_define_t enumeration
* @param[in] ShowButtons
* @li optional: exepts type int, defines which buttons are available on screen, default value = mbCancel
* @li optional: expects type int, defines which buttons are available on screen, default value = mbCancel
* possible values are:
* mbYes = 0x01,
* mbNo = 0x02,
@@ -277,14 +277,14 @@ class CMsgBox : public CHintBox
/**
* define timeout, timeout is enabled if parmeter 1 > -1, otherwise it will be disabled,
* @param[in] Timeout
* @li exepts type int
* @li expects type int
*/
void setTimeOut(const int& Timeout){timeout = Timeout;};
/**
* enable/disable defined timeout, otherwise it will be ignored
* @param[in] enable
* @li exepts type bool, default = true
* @li expects type bool, default = true
*/
void enableDefaultResultOnTimeOut(bool enable = true);
@@ -293,17 +293,17 @@ class CMsgBox : public CHintBox
* This member allows to define an alternate text for an already defined button,
* Result values are not touched!
* @param[in] showed_button
* @li exepts type int
* @li expects type int
* @see setShowedButtons()
* @param[in] text
* @li exepts type std::string, sets the new text for button
* @li expects type std::string, sets the new text for button
*/
void setButtonText(const int& showed_button, const std::string& text);
/**
* enables background of buttons
* @param[in] enable
* @li exepts type bool, default = true
* @li expects type bool, default = true
*/
void enableButtonBg(bool enable = true);