mirrors/neutrino
1
0
Fork 0
mirror of https://github.com/tuxbox-neutrino/neutrino.git synced 2025-08-27 23:42:58 +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

66
src/gui/widget/hintbox.h
View File

@@ -90,20 +90,20 @@ class CHintBox : public CComponentsWindow
public:
/**CHintBox Constructor
* @param[in] Caption
* @li exepts type neutrino_locale_t with locale entry from /system/locals.h
* @li expects type neutrino_locale_t with locale entry from /system/locals.h
* @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] Width
* @li optional: exepts type int, defines box width, default value = HINTBOX_MIN_WIDTH
* @li optional: expects type int, defines box width, default value = HINTBOX_MIN_WIDTH
* @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] header_buttons
* @li optional: exepts type int, defines the icon name on the right side of titlebar, default = 0 (non Icon)
* @li optional: expects type int, defines the icon name on the right side of titlebar, default = 0 (non Icon)
* @see class CComponentsWindow()
* @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
@@ -115,7 +115,7 @@ class CHintBox : public CComponentsWindow
* NO_AUTO_LINEBREAK
* AUTO_LINEBREAK_NO_BREAKCHARS
* @param[in] indent
* @li optional: exepts type int, defines indent of text
* @li optional: expects type int, defines indent of text
*
* @see classes CComponentsText(), CTextBox()
*/
@@ -130,7 +130,7 @@ class CHintBox : public CComponentsWindow
/**CHintBox Constructor
* @param[in] Caption
* @li exepts type const char*
* @li expects type const char*
* @see for other parameters take a look to basic class CHintBox()
*/
CHintBox( const char * const Caption,
@@ -144,9 +144,9 @@ class CHintBox : public CComponentsWindow
/**CHintBox Constructor
* @param[in] Caption
* @li exepts type neutrino_locale_t with locale entry from /system/locals.h
* @li expects type neutrino_locale_t with locale entry from /system/locals.h
* @param[in] Text
* @li exepts type neutrino_locale_t with locale entry from /system/locals.h
* @li expects type neutrino_locale_t with locale entry from /system/locals.h
* @see for other parameters take a look to basic class CHintBox()
*/
CHintBox( const neutrino_locale_t Caption,
@@ -160,9 +160,9 @@ class CHintBox : public CComponentsWindow
/**CHintBox Constructor
* @param[in] Caption
* @li exepts type const char*
* @li expects type const char*
* @param[in] Text
* @li exepts type neutrino_locale_t with locale entry from /system/locals.h
* @li expects type neutrino_locale_t with locale entry from /system/locals.h
* @see for other parameters take a look to basic class CHintBox()
*/
CHintBox( const char * const Caption,
@@ -192,7 +192,7 @@ class CHintBox : public CComponentsWindow
/**
* enable/disable visualized timeout as progressbar under titlebar
* @param[in] enable
* @li optional: exepts type bool, default = true
* @li optional: expects type bool, default = true
*/
void enableTimeOutBar(bool enable = true);
@@ -205,7 +205,7 @@ class CHintBox : public CComponentsWindow
/**
* scroll handler for text objects: NOTE: exec() must be called !
* @param[in] hint_id
* @li optional: exepts type unsigned int, default = 0
* @li optional: expects type unsigned int, default = 0
* default for the 1st hint item (=0), item id arises from the order of added items with addHintItem(), default we have minimal one item with id=0
* @see Scroll()
*/
@@ -214,7 +214,7 @@ class CHintBox : public CComponentsWindow
/**
* scroll down handler for text objects: NOTE: exec() must be called !
* @param[in] hint_id
* @li exepts type unsigned int, default = 0
* @li expects type unsigned int, default = 0
* default for the 1st hint item (=0), item id arises from the order of added items with addHintItem(), default we h
* @see Scroll()
*/
@@ -223,9 +223,9 @@ class CHintBox : public CComponentsWindow
/**
* Member to add a hint item
* @param[in] Text
* @li exepts type std::string, this is the message text inside the window, text is UTF-8 encoded
* @li expects type std::string, this is the message text inside the window, text is UTF-8 encoded
* @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
@@ -237,11 +237,11 @@ class CHintBox : public CComponentsWindow
* NO_AUTO_LINEBREAK
* AUTO_LINEBREAK_NO_BREAKCHARS
* @param[in] Picon
* @li optional: exepts type std::string, defines the picon name on the left side of message text, default = NULL (non Icon)
* @li optional: expects type std::string, defines the picon name on the left side of message text, default = NULL (non Icon)
* @param[in] color_text
* @li optional: exepts type fb_pixel_t, defines the text color, default = COL_MENUCONTENT_TEXT
* @li optional: expects type fb_pixel_t, defines the text color, default = COL_MENUCONTENT_TEXT
* * @param[in] font_text
* @li optional: exepts type Font*, defines the text font type, default = NULL for system preset for message contents
* @li optional: expects type Font*, defines the text font type, default = NULL for system preset for message contents
*/
void addHintItem( const std::string& Text,
const int& text_mode = DEFAULT_HINTBOX_TEXT_MODE,
@@ -252,7 +252,7 @@ class CHintBox : public CComponentsWindow
/**
* Member to add a hint item from specified cc-item type
* @param[in] cc_Item
* @li exepts type CComponentsItem*, allows to add any possible cc-item type
* @li expects type CComponentsItem*, allows to add any possible cc-item type
*
* @see /gui/components/cc_types.h
*/
@@ -261,11 +261,11 @@ class CHintBox : public CComponentsWindow
/**
* Sets a text to a hint item.
* @param[in] Text
* @li exepts type std::string, this is the message text inside the hint item, text is UTF-8 encoded
* @li expects type std::string, this is the message text inside the hint item, text is UTF-8 encoded
* @param[in] hint_id
* @li optional: exepts type unsigned int, default = 0 for the first or one and only item
* @li optional: expects type unsigned int, default = 0 for the first or one and only item
* @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
@@ -278,9 +278,9 @@ class CHintBox : public CComponentsWindow
* AUTO_LINEBREAK_NO_BREAKCHARS
* default: CTextBox::AUTO_WIDTH | CTextBox::AUTO_HIGH | CTextBox::CENTER
* @param[in] color_text
* @li optional: exepts type fb_pixel_t, defines the text color, default = COL_MENUCONTENT_TEXT
* @li optional: expects type fb_pixel_t, defines the text color, default = COL_MENUCONTENT_TEXT
* * @param[in] style
* @li optional: exepts type int, defines the text style NOTE: only for dynamic font
* @li optional: expects type int, defines the text style NOTE: only for dynamic font
* possible styles are:
* FONT_STYLE_REGULAR (default)
* FONT_STYLE_BOLD
@@ -323,16 +323,16 @@ class CHint : public CHintBox
public:
/**CHint 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] show_background
* @li optional: exepts type bool, enable/disable backround paint, default = true
* @li optional: expects type bool, enable/disable backround paint, default = true
*/
CHint(const char * const Text, bool show_background = true);
/**CHint Constructor
* @param[in] Text
* @li exepts type neutrino_locale_t, this is the message text inside the window, text is UTF-8 encoded
* @li expects type neutrino_locale_t, this is the message text inside the window, text is UTF-8 encoded
* @param[in] show_background
* @li optional: exepts type bool, enable/disable backround paint, default = true
* @li optional: expects type bool, enable/disable backround paint, default = true
*/
CHint(const neutrino_locale_t Text, bool show_background = true);
};
@@ -341,9 +341,9 @@ class CHint : public CHintBox
* Simplified methodes to show hintboxes without titlebar and footer
* Text is UTF-8 encoded
* @param[in] timeout
* @li optional: exepts type int as seconds, default = HINTBOX_DEFAULT_TIMEOUT (get from settings)
* @li optional: expects type int as seconds, default = HINTBOX_DEFAULT_TIMEOUT (get from settings)
* @param[in] show_background
* @li optional: exepts type bool, enable/disable backround paint, default = true
* @li optional: expects type bool, enable/disable backround paint, default = true
* @see for possible text parameters take a look to CHintBox()
*/
int ShowHintS(const neutrino_locale_t Text, int timeout = HINTBOX_DEFAULT_TIMEOUT, bool show_background = true);