mirrors/recycled-ni-neutrino
1
0
Fork 0
mirror of https://github.com/tuxbox-fork-migrations/recycled-ni-neutrino.git synced 2025-08-27 23:42:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

comments: fix copy paste errors

Browse Source 
Origin commit data
------------------
Commit: 6e310a8157
Author: Thilo Graf <dbt@novatux.de>
Date: 2017-08-28 (Mon, 28 Aug 2017)
This commit is contained in:
Thilo Graf
2017-08-28 12:16:45 +02:00
parent b490817d1b
commit ab4bcc584a
9 changed files with 132 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/gui/components/cc_draw.h
View File

@@ -342,7 +342,7 @@ class CCDraw : public COSDFader, public CComponentsSignals
* *
* @return bool returns true if effect was successful canceled * @return bool returns true if effect was successful canceled
* *
* @param[in] keep_on_screen optional, exepts bool, default = false. means: item is not repainted after canceled effect * @param[in] keep_on_screen optional, expects bool, default = false. means: item is not repainted after canceled effect
* *
* @see take a look into test menu class for examples * @see take a look into test menu class for examples
* NOTE: Effect must be started with paintBlink() * NOTE: Effect must be started with paintBlink()

2
src/gui/components/cc_frm_button.h
View File

@@ -211,7 +211,7 @@ class CComponentsButton : public CComponentsFrmChain, public CCTextScreen
* Returns true if filtered event msg value of button object is found in cc_directKeys container. * Returns true if filtered event msg value of button object is found in cc_directKeys container.
* @return bool * @return bool
* @param[in] msg * @param[in] msg
* @li exepts type neutrino_msg_t as filter for searched message * @li expects type neutrino_msg_t as filter for searched message
* @see neutrino_msg_t getButtonDirectKey(), driver/rcinput.h for possible values * @see neutrino_msg_t getButtonDirectKey(), driver/rcinput.h for possible values
*/ */
bool hasButtonDirectKey(const neutrino_msg_t& msg) bool hasButtonDirectKey(const neutrino_msg_t& msg)

4
src/gui/components/cc_frm_header.h
View File

@@ -204,7 +204,7 @@ class CComponentsHeader : public CComponentsForm, public CCTextScreen, CCHeaderT
* Height can be changed with modes by setSizeMode(), setHeight() or constructor. * Height can be changed with modes by setSizeMode(), setHeight() or constructor.
* @return void * @return void
* *
* @param[in] font exepts font object, type Font* * @param[in] font expects font object, type Font*
* @see getCaptionFont(), setSizeMode(), * @see getCaptionFont(), setSizeMode(),
* setCaptionColor(), * setCaptionColor(),
* setCaptionAlignment(), * setCaptionAlignment(),
@@ -227,7 +227,7 @@ class CComponentsHeader : public CComponentsForm, public CCTextScreen, CCHeaderT
* If other size wanted then use set setCaptionFont() and setHeight() * If other size wanted then use set setCaptionFont() and setHeight()
* @return void * @return void
* *
* @param[in] size_mode exepts type int (enums) * @param[in] size_mode expects type int (enums)
* possible modes are: * possible modes are:
* CC_HEADER_SIZE_LARGE * CC_HEADER_SIZE_LARGE
* CC_HEADER_SIZE_SMALL * CC_HEADER_SIZE_SMALL

58
src/gui/components/cc_frm_scrollbar.h
View File

@@ -70,20 +70,20 @@ class CComponentsScrollBar : public CComponentsFrmChain
public: public:
/**Class constructor to generate individual scrollbar objects /**Class constructor to generate individual scrollbar objects
* *
* @param[in] x_pos exepts type int, x position on screen * @param[in] x_pos expects type int, x position on screen
* @param[in] x_pos exepts type int, y position on screen modes are: * @param[in] x_pos expects type int, y position on screen modes are:
* @param[in] w exepts type int, width of scrollbar object * @param[in] w expects type int, width of scrollbar object
* @param[in] h exepts type int, height of scrollbar object * @param[in] h expects type int, height of scrollbar object
* @param[in] count optional, exepts type int, count of pages, default 1 * @param[in] count optional, expects type int, count of pages, default 1
* *
* usual paraemters: * usual paraemters:
* @param[in] parent optional, exepts type pointer to a parent CComponentsForm object, default NULL * @param[in] parent optional, expects type pointer to a parent CComponentsForm object, default NULL
* @param[in] shadow_mode optional, exepts type int defined by shadow mode enums, default CC_SHADOW_OFF * @param[in] shadow_mode optional, expects type int defined by shadow mode enums, default CC_SHADOW_OFF
* @param[in] color_frame optional, exepts type fb_pixel_t, default COL_SCROLLBAR_PLUS_0 * @param[in] color_frame optional, expects type fb_pixel_t, default COL_SCROLLBAR_PLUS_0
* @param[in] color_body optional, exepts type fb_pixel_t, default COL_SCROLLBAR_PLUS_0 * @param[in] color_body optional, expects type fb_pixel_t, default COL_SCROLLBAR_PLUS_0
* @param[in] color_shadow optional, exepts type fb_pixel_t, default COL_SHADOW_PLUS_0 * @param[in] color_shadow optional, expects type fb_pixel_t, default COL_SHADOW_PLUS_0
* @param[in] color_select optional, exepts type fb_pixel_t, default COL_SCROLLBAR_ACTIVE_PLUS_0 * @param[in] color_select optional, expects type fb_pixel_t, default COL_SCROLLBAR_ACTIVE_PLUS_0
* @param[in] color_passive optional, exepts type fb_pixel_t, default COL_SCROLLBAR_PASSIVE_PLUS_0 * @param[in] color_passive optional, expects type fb_pixel_t, default COL_SCROLLBAR_PASSIVE_PLUS_0
*/ */
CComponentsScrollBar( const int &x_pos, CComponentsScrollBar( const int &x_pos,
const int &y_pos, const int &y_pos,
@@ -102,7 +102,7 @@ class CComponentsScrollBar : public CComponentsFrmChain
/**Set current page number /**Set current page number
* @return void * @return void
* *
* @param[in] mark_id exepts type int, this sets the current selected page number. * @param[in] mark_id expects type int, this sets the current selected page number.
* *
* @see getMarkID() * @see getMarkID()
*/ */
@@ -120,8 +120,8 @@ class CComponentsScrollBar : public CComponentsFrmChain
* Each segment is assigned to a page number. Starting with id 0...n * Each segment is assigned to a page number. Starting with id 0...n
* @return void * @return void
* *
* @param[in] segment_count exepts type int, sets the current count of pages. * @param[in] segment_count expects type int, sets the current count of pages.
* @param[in] mark_id optional, exepts type int, sets the current selected page number, default = 0 * @param[in] mark_id optional, expects type int, sets the current selected page number, default = 0
* @see also setMarkID() * @see also setMarkID()
* getMarkID() * getMarkID()
*/ */
@@ -135,7 +135,7 @@ class CComponentsScrollBar : public CComponentsFrmChain
int getSegmentCount(){return sb_segments_count;} int getSegmentCount(){return sb_segments_count;}
/**Enable/disable vizualized count of possible scroll items /**Enable/disable vizualized count of possible scroll items
* @param[in] enable optional, exepts type bool. * @param[in] enable optional, expects type bool.
* @note Default mode is disabled. * @note Default mode is disabled.
*/ */
void enableVisualize(bool enable = true){sb_visual_enable = enable;} void enableVisualize(bool enable = true){sb_visual_enable = enable;}
@@ -150,21 +150,21 @@ void getScrollBarData(int *total_pages, int *current_page, int total_items, int
/**Small and easy to apply scrollbar paint methode without expilcit object declaration /**Small and easy to apply scrollbar paint methode without expilcit object declaration
* @return void * @return void
* *
* @param[in] x_pos exepts type int, x position on screen * @param[in] x_pos expects type int, x position on screen
* @param[in] x_pos exepts type int, y position on screen modes are: * @param[in] x_pos expects type int, y position on screen modes are:
* @param[in] w exepts type int, width of scrollbar object * @param[in] w expects type int, width of scrollbar object
* @param[in] h exepts type int, height of scrollbar object * @param[in] h expects type int, height of scrollbar object
* @param[in] count exepts type int, count of pages, default 1 * @param[in] count expects type int, count of pages, default 1
* @param[in] current_num exepts type int, current selected page, default 0 * @param[in] current_num expects type int, current selected page, default 0
* *
* usual paraemters: * usual paraemters:
* @param[in] parent optional, exepts type pointer to a parent CComponentsForm object, default NULL * @param[in] parent optional, expects type pointer to a parent CComponentsForm object, default NULL
* @param[in] shadow_mode optional, exepts type int defined by shadow mode enums, default CC_SHADOW_OFF * @param[in] shadow_mode optional, expects type int defined by shadow mode enums, default CC_SHADOW_OFF
* @param[in] color_frame optional, exepts type fb_pixel_t, default COL_SCROLLBAR_PLUS_0 * @param[in] color_frame optional, expects type fb_pixel_t, default COL_SCROLLBAR_PLUS_0
* @param[in] color_body optional, exepts type fb_pixel_t, default COL_SCROLLBAR_PLUS_0 * @param[in] color_body optional, expects type fb_pixel_t, default COL_SCROLLBAR_PLUS_0
* @param[in] color_shadow optional, exepts type fb_pixel_t, default COL_SHADOW_PLUS_0 * @param[in] color_shadow optional, expects type fb_pixel_t, default COL_SHADOW_PLUS_0
* @param[in] color_select optional, exepts type fb_pixel_t, default COL_SCROLLBAR_ACTIVE_PLUS_0 * @param[in] color_select optional, expects type fb_pixel_t, default COL_SCROLLBAR_ACTIVE_PLUS_0
* @param[in] color_passive optional, exepts type fb_pixel_t, default COL_SCROLLBAR_PASSIVE_PLUS_0 * @param[in] color_passive optional, expects type fb_pixel_t, default COL_SCROLLBAR_PASSIVE_PLUS_0
*/ */
void paintScrollBar( const int &x_pos, void paintScrollBar( const int &x_pos,
const int &y_pos, const int &y_pos,

58
src/gui/widget/helpbox.h
View File

@@ -52,19 +52,19 @@ public:
* NOTE: addLine() members are used only for compatibilty with older implementation * NOTE: addLine() members are used only for compatibilty with older implementation
* of lines. * of lines.
* @param[in] Title * @param[in] Title
* @li exepts type std::string, defines caption of window * @li expects type std::string, defines caption of window
* @param[in] Default_Text * @param[in] Default_Text
* @li optional: exepts type std::string, defines a pre defined help text * @li optional: expects type std::string, defines a pre defined help text
* @param[in] text_mode * @param[in] text_mode
* @li optional: exepts type int, defines text modes, see /gui/widget/textbox.h for possible modes * @li optional: expects type int, defines text modes, see /gui/widget/textbox.h for possible modes
* @param[in] line_height * @param[in] line_height
* @li optional: exepts type int, defines height of line * @li optional: expects type int, defines height of line
* @param[in] line_indent * @param[in] line_indent
* @li optional: exepts type int, defines lenght of indent from left * @li optional: expects type int, defines lenght of indent from left
* @param[in] font_text * @param[in] font_text
* @li optional: exepts type Font*, default = NULL, this means SNeutrinoSettings::FONT_TYPE_INFOBAR_INFO is used * @li optional: expects type Font*, default = NULL, this means SNeutrinoSettings::FONT_TYPE_INFOBAR_INFO is used
* @param[in] Icon * @param[in] Icon
* @li exepts type const char*, defins the title bar icon and can be name (see /gui/icons.h) or path to an image file * @li expects type const char*, defins the title bar icon and can be name (see /gui/icons.h) or path to an image file
*/ */
Helpbox( const std::string& Title, Helpbox( const std::string& Title,
const std::string& Default_Text = std::string(), const std::string& Default_Text = std::string(),
@@ -79,15 +79,15 @@ public:
/**Adds an item with pre defined text /**Adds an item with pre defined text
* @param[in] text * @param[in] text
* @li exepts type std::string * @li expects type std::string
* @param[in] text_mode * @param[in] text_mode
* @li optional: exepts type int, defines text modes, see /gui/widget/textbox.h for possible modes * @li optional: expects type int, defines text modes, see /gui/widget/textbox.h for possible modes
* @param[in] line_height * @param[in] line_height
* @li optional: exepts type int, defines height of line * @li optional: expects type int, defines height of line
* @param[in] line_indent * @param[in] line_indent
* @li optional: exepts type int, defines lenght of indent from left * @li optional: expects type int, defines lenght of indent from left
* @param[in] font_text * @param[in] font_text
* @li optional: exepts type Font*, default = NULL, this means SNeutrinoSettings::FONT_TYPE_INFOBAR_INFO is used * @li optional: expects type Font*, default = NULL, this means SNeutrinoSettings::FONT_TYPE_INFOBAR_INFO is used
*/ */
void addLine( const std::string& text, void addLine( const std::string& text,
const int& text_mode = HELPBOX_DEFAULT_TEXT_MODE, const int& text_mode = HELPBOX_DEFAULT_TEXT_MODE,
@@ -97,15 +97,15 @@ public:
/**Adds an item with pre defined text /**Adds an item with pre defined text
* @param[in] text * @param[in] text
* @li exepts type const char * * @li expects type const char *
* @param[in] text_mode * @param[in] text_mode
* @li optional: exepts type int, defines text modes, see /gui/widget/textbox.h for possible modes * @li optional: expects type int, defines text modes, see /gui/widget/textbox.h for possible modes
* @param[in] line_height * @param[in] line_height
* @li optional: exepts type int, defines height of line * @li optional: expects type int, defines height of line
* @param[in] line_indent * @param[in] line_indent
* @li optional: exepts type int, defines lenght of indent from left * @li optional: expects type int, defines lenght of indent from left
* @param[in] font_text * @param[in] font_text
* @li optional: exepts type Font*, default = NULL, this means SNeutrinoSettings::FONT_TYPE_INFOBAR_INFO is used * @li optional: expects type Font*, default = NULL, this means SNeutrinoSettings::FONT_TYPE_INFOBAR_INFO is used
*/ */
void addLine( const char *text, void addLine( const char *text,
const int& text_mode = HELPBOX_DEFAULT_TEXT_MODE, const int& text_mode = HELPBOX_DEFAULT_TEXT_MODE,
@@ -115,17 +115,17 @@ public:
/**Adds an item with pre defined icon and text /**Adds an item with pre defined icon and text
* @param[in] icon * @param[in] icon
* @li exepts type std::string, icon can be name (see /gui/icons.h) or path to an image file * @li expects type std::string, icon can be name (see /gui/icons.h) or path to an image file
* @param[in] text * @param[in] text
* @li exepts type std::string * @li expects type std::string
* @param[in] text_mode * @param[in] text_mode
* @li optional: exepts type int, defines text modes, see /gui/widget/textbox.h for possible modes * @li optional: expects type int, defines text modes, see /gui/widget/textbox.h for possible modes
* @param[in] line_height * @param[in] line_height
* @li optional: exepts type int, defines height of line * @li optional: expects type int, defines height of line
* @param[in] line_indent * @param[in] line_indent
* @li optional: exepts type int, defines lenght of indent from left * @li optional: expects type int, defines lenght of indent from left
* @param[in] font_text * @param[in] font_text
* @li optional: exepts type Font*, default = NULL, this means SNeutrinoSettings::FONT_TYPE_INFOBAR_INFO is used * @li optional: expects type Font*, default = NULL, this means SNeutrinoSettings::FONT_TYPE_INFOBAR_INFO is used
*/ */
void addLine( const std::string& icon, void addLine( const std::string& icon,
const std::string& text, const std::string& text,
@@ -136,17 +136,17 @@ public:
/**Adds an item with pre defined icon and text /**Adds an item with pre defined icon and text
* @param[in] icon * @param[in] icon
* @li exepts type const char *, icon can be name (see /gui/icons.h) or path to an image file * @li expects type const char *, icon can be name (see /gui/icons.h) or path to an image file
* @param[in] text * @param[in] text
* @li exepts type const char * * @li expects type const char *
* @param[in] text_mode * @param[in] text_mode
* @li optional: exepts type int, defines text modes, see /gui/widget/textbox.h for possible modes * @li optional: expects type int, defines text modes, see /gui/widget/textbox.h for possible modes
* @param[in] line_height * @param[in] line_height
* @li optional: exepts type int, defines height of line * @li optional: expects type int, defines height of line
* @param[in] line_indent * @param[in] line_indent
* @li optional: exepts type int, defines lenght of indent from left * @li optional: expects type int, defines lenght of indent from left
* @param[in] font_text * @param[in] font_text
* @li optional: exepts type Font*, default = NULL, this means SNeutrinoSettings::FONT_TYPE_INFOBAR_INFO is used * @li optional: expects type Font*, default = NULL, this means SNeutrinoSettings::FONT_TYPE_INFOBAR_INFO is used
*/ */
void addLine( const char *icon, void addLine( const char *icon,
const char *text, const char *text,

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

@@ -90,20 +90,20 @@ class CHintBox : public CComponentsWindow
public: public:
/**CHintBox Constructor /**CHintBox Constructor
* @param[in] Caption * @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 * @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 * @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 * @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 * @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 * @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() * @see class CComponentsWindow()
* @param[in] text_mode * @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 * Possible Modes defined in /gui/widget/textbox.h
* AUTO_WIDTH * AUTO_WIDTH
* AUTO_HIGH * AUTO_HIGH
@@ -115,7 +115,7 @@ class CHintBox : public CComponentsWindow
* NO_AUTO_LINEBREAK * NO_AUTO_LINEBREAK
* AUTO_LINEBREAK_NO_BREAKCHARS * AUTO_LINEBREAK_NO_BREAKCHARS
* @param[in] indent * @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() * @see classes CComponentsText(), CTextBox()
*/ */
@@ -130,7 +130,7 @@ class CHintBox : public CComponentsWindow
/**CHintBox Constructor /**CHintBox Constructor
* @param[in] Caption * @param[in] Caption
* @li exepts type const char* * @li expects type const char*
* @see for other parameters take a look to basic class CHintBox() * @see for other parameters take a look to basic class CHintBox()
*/ */
CHintBox( const char * const Caption, CHintBox( const char * const Caption,
@@ -144,9 +144,9 @@ class CHintBox : public CComponentsWindow
/**CHintBox Constructor /**CHintBox Constructor
* @param[in] Caption * @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 * @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() * @see for other parameters take a look to basic class CHintBox()
*/ */
CHintBox( const neutrino_locale_t Caption, CHintBox( const neutrino_locale_t Caption,
@@ -160,9 +160,9 @@ class CHintBox : public CComponentsWindow
/**CHintBox Constructor /**CHintBox Constructor
* @param[in] Caption * @param[in] Caption
* @li exepts type const char* * @li expects type const char*
* @param[in] Text * @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() * @see for other parameters take a look to basic class CHintBox()
*/ */
CHintBox( const char * const Caption, CHintBox( const char * const Caption,
@@ -192,7 +192,7 @@ class CHintBox : public CComponentsWindow
/** /**
* enable/disable visualized timeout as progressbar under titlebar * enable/disable visualized timeout as progressbar under titlebar
* @param[in] enable * @param[in] enable
* @li optional: exepts type bool, default = true * @li optional: expects type bool, default = true
*/ */
void enableTimeOutBar(bool enable = true); void enableTimeOutBar(bool enable = true);
@@ -205,7 +205,7 @@ class CHintBox : public CComponentsWindow
/** /**
* scroll handler for text objects: NOTE: exec() must be called ! * scroll handler for text objects: NOTE: exec() must be called !
* @param[in] hint_id * @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 * 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() * @see Scroll()
*/ */
@@ -214,7 +214,7 @@ class CHintBox : public CComponentsWindow
/** /**
* scroll down handler for text objects: NOTE: exec() must be called ! * scroll down handler for text objects: NOTE: exec() must be called !
* @param[in] hint_id * @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 * default for the 1st hint item (=0), item id arises from the order of added items with addHintItem(), default we h
* @see Scroll() * @see Scroll()
*/ */
@@ -223,9 +223,9 @@ class CHintBox : public CComponentsWindow
/** /**
* Member to add a hint item * Member to add a hint item
* @param[in] Text * @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 * @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 * Possible Modes defined in /gui/widget/textbox.h
* AUTO_WIDTH * AUTO_WIDTH
* AUTO_HIGH * AUTO_HIGH
@@ -237,11 +237,11 @@ class CHintBox : public CComponentsWindow
* NO_AUTO_LINEBREAK * NO_AUTO_LINEBREAK
* AUTO_LINEBREAK_NO_BREAKCHARS * AUTO_LINEBREAK_NO_BREAKCHARS
* @param[in] Picon * @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 * @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 * * @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, void addHintItem( const std::string& Text,
const int& text_mode = DEFAULT_HINTBOX_TEXT_MODE, 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 * Member to add a hint item from specified cc-item type
* @param[in] cc_Item * @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 * @see /gui/components/cc_types.h
*/ */
@@ -261,11 +261,11 @@ class CHintBox : public CComponentsWindow
/** /**
* Sets a text to a hint item. * Sets a text to a hint item.
* @param[in] Text * @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 * @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 * @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 * Possible Modes defined in /gui/widget/textbox.h
* AUTO_WIDTH * AUTO_WIDTH
* AUTO_HIGH * AUTO_HIGH
@@ -278,9 +278,9 @@ class CHintBox : public CComponentsWindow
* AUTO_LINEBREAK_NO_BREAKCHARS * AUTO_LINEBREAK_NO_BREAKCHARS
* default: CTextBox::AUTO_WIDTH | CTextBox::AUTO_HIGH | CTextBox::CENTER * default: CTextBox::AUTO_WIDTH | CTextBox::AUTO_HIGH | CTextBox::CENTER
* @param[in] color_text * @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 * * @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: * possible styles are:
* FONT_STYLE_REGULAR (default) * FONT_STYLE_REGULAR (default)
* FONT_STYLE_BOLD * FONT_STYLE_BOLD
@@ -323,16 +323,16 @@ class CHint : public CHintBox
public: public:
/**CHint Constructor /**CHint Constructor
* @param[in] Text * @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 * @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(const char * const Text, bool show_background = true);
/**CHint Constructor /**CHint Constructor
* @param[in] Text * @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 * @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); 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 * Simplified methodes to show hintboxes without titlebar and footer
* Text is UTF-8 encoded * Text is UTF-8 encoded
* @param[in] timeout * @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 * @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() * @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); int ShowHintS(const neutrino_locale_t Text, int timeout = HINTBOX_DEFAULT_TIMEOUT, bool show_background = true);

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

@@ -121,22 +121,22 @@ class CMsgBox : public CHintBox
public: public:
/**CMsgBox Constructor /**CMsgBox Constructor
* @param[in] Text * @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 * @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 * @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 * @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 * @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 * @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 * @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() * @see setShowedButtons()
* @param[in] Default_result * @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: * possible values are:
* mbrYes = 0, * mbrYes = 0,
* mbrNo = 1, * mbrNo = 1,
@@ -148,7 +148,7 @@ class CMsgBox : public CHintBox
* mbrNone = -1 * mbrNone = -1
* @see setDefaultResult(), getResult(); getDefaultResult(), enableDefaultResultOnTimeOut() * @see setDefaultResult(), getResult(); getDefaultResult(), enableDefaultResultOnTimeOut()
* @param[in] text_mode * @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 * Possible Modes defined in /gui/widget/textbox.h
* AUTO_WIDTH * AUTO_WIDTH
* AUTO_HIGH * AUTO_HIGH
@@ -175,22 +175,22 @@ class CMsgBox : public CHintBox
/**CMsgBox Constructor /**CMsgBox Constructor
* @param[in] Text * @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 * @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 * @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 * @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 * @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 * @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 * @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() * @see setShowedButtons()
* @param[in] Default_result * @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: * possible values are:
* mbrYes = 0, * mbrYes = 0,
* mbrNo = 1, * mbrNo = 1,
@@ -202,7 +202,7 @@ class CMsgBox : public CHintBox
* mbrNone = -1 * mbrNone = -1
* @see setDefaultResult(), getResult(); getDefaultResult(), enableDefaultResultOnTimeOut() * @see setDefaultResult(), getResult(); getDefaultResult(), enableDefaultResultOnTimeOut()
* @param[in] text_mode * @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 * Possible Modes defined in /gui/widget/textbox.h
* AUTO_WIDTH * AUTO_WIDTH
* AUTO_HIGH * AUTO_HIGH
@@ -249,7 +249,7 @@ class CMsgBox : public CHintBox
/** /**
* sets current default result as msg_result_t, independently from current selected button result * sets current default result as msg_result_t, independently from current selected button result
* @param[in] Default_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;} 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, * This member allows to set and overrides already defined buttons from constructor,
* parameter ''ShowButtons'' accepts given types, find under button_define_t enumeration * parameter ''ShowButtons'' accepts given types, find under button_define_t enumeration
* @param[in] ShowButtons * @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: * possible values are:
* mbYes = 0x01, * mbYes = 0x01,
* mbNo = 0x02, * mbNo = 0x02,
@@ -277,14 +277,14 @@ class CMsgBox : public CHintBox
/** /**
* define timeout, timeout is enabled if parmeter 1 > -1, otherwise it will be disabled, * define timeout, timeout is enabled if parmeter 1 > -1, otherwise it will be disabled,
* @param[in] Timeout * @param[in] Timeout
* @li exepts type int * @li expects type int
*/ */
void setTimeOut(const int& Timeout){timeout = Timeout;}; void setTimeOut(const int& Timeout){timeout = Timeout;};
/** /**
* enable/disable defined timeout, otherwise it will be ignored * enable/disable defined timeout, otherwise it will be ignored
* @param[in] enable * @param[in] enable
* @li exepts type bool, default = true * @li expects type bool, default = true
*/ */
void enableDefaultResultOnTimeOut(bool enable = 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, * This member allows to define an alternate text for an already defined button,
* Result values are not touched! * Result values are not touched!
* @param[in] showed_button * @param[in] showed_button
* @li exepts type int * @li expects type int
* @see setShowedButtons() * @see setShowedButtons()
* @param[in] text * @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); void setButtonText(const int& showed_button, const std::string& text);
/** /**
* enables background of buttons * enables background of buttons
* @param[in] enable * @param[in] enable
* @li exepts type bool, default = true * @li expects type bool, default = true
*/ */
void enableButtonBg(bool enable = true); void enableButtonBg(bool enable = true);

20
src/gui/widget/navibar.h
View File

@@ -89,14 +89,14 @@ class CNaviBar : public CComponentsFrmChain
/** /**
* Enable or disable left icon * Enable or disable left icon
* @param[in] enable * @param[in] enable
* @li exepts type bool, default = true * @li expects type bool, default = true
*/ */
void enableLeftArrow(bool enable = true){nb_lpic_enable = enable; initCCItems();} void enableLeftArrow(bool enable = true){nb_lpic_enable = enable; initCCItems();}
/** /**
* Enable or disable right icon * Enable or disable right icon
* @param[in] enable * @param[in] enable
* @li exepts type bool, default = true * @li expects type bool, default = true
*/ */
void enableRightArrow(bool enable = true){nb_rpic_enable = enable; initCCItems();} void enableRightArrow(bool enable = true){nb_rpic_enable = enable; initCCItems();}
@@ -115,9 +115,9 @@ class CNaviBar : public CComponentsFrmChain
/** /**
* Enable or disable both icons at once. * Enable or disable both icons at once.
* @param[in] enable_left * @param[in] enable_left
* @li exepts type bool, default = true * @li expects type bool, default = true
* @param[in] enable_right * @param[in] enable_right
* @li exepts type bool, default = true * @li expects type bool, default = true
*/ */
void enableArrows(bool enable_left = true, bool enable_right = true){enableLeftArrow(enable_left); enableRightArrow(enable_right);} void enableArrows(bool enable_left = true, bool enable_right = true){enableLeftArrow(enable_left); enableRightArrow(enable_right);}
@@ -130,37 +130,37 @@ class CNaviBar : public CComponentsFrmChain
/** /**
* Sets font type for texts. * Sets font type for texts.
* @param[in] font * @param[in] font
* @li exepts type Font* * @li expects type Font*
*/ */
void setFont(Font *font) {nb_font = font; initCCItems();} void setFont(Font *font) {nb_font = font; initCCItems();}
/** /**
* Sets left text. * Sets left text.
* @param[in] text * @param[in] text
* @li exepts type std::string * @li expects type std::string
*/ */
void setLeftText(const std::string& text) {nb_l_text = text; initCCItems();} void setLeftText(const std::string& text) {nb_l_text = text; initCCItems();}
/** /**
* Sets right text * Sets right text
* @param[in] text * @param[in] text
* @li exepts type std::string * @li expects type std::string
*/ */
void setRightText(const std::string& text) {nb_r_text = text; initCCItems();} void setRightText(const std::string& text) {nb_r_text = text; initCCItems();}
/** /**
* Sets left and right text at once. * Sets left and right text at once.
* @param[in] left * @param[in] left
* @li exepts type std::string * @li expects type std::string
* @param[in] right * @param[in] right
* @li exepts type std::string * @li expects type std::string
*/ */
void setText(const std::string& left, const std::string& right) {setLeftText(left); setRightText(right);} void setText(const std::string& left, const std::string& right) {setLeftText(left); setRightText(right);}
/** /**
* Paint bar on screen. * Paint bar on screen.
* @param[in] do_save_bg * @param[in] do_save_bg
* @li optional: exepts type bool, default = CC_SAVE_SCREEN_YES. * @li optional: expects type bool, default = CC_SAVE_SCREEN_YES.
*/ */
void paint(bool do_save_bg = CC_SAVE_SCREEN_YES); void paint(bool do_save_bg = CC_SAVE_SCREEN_YES);
}; };

4
src/gui/widget/textbox.h
View File

@@ -227,9 +227,9 @@ class CTextBox : public sigc::trackable
/** /**
* Returns width of largest line from passed text * Returns width of largest line from passed text
* @param[in] text * @param[in] text
* @li exepts type std::string * @li expects type std::string
* @param[in] font * @param[in] font
* @li exepts font type object * @li expects font type object
* @return width of largest line as int * @return width of largest line as int
* @see getMaxLineWidth(void) * @see getMaxLineWidth(void)
*/ */