mirror of
https://github.com/tuxbox-fork-migrations/recycled-ni-neutrino.git
synced 2025-08-29 00:11:08 +02:00
CComponentsWindow: add more tags for doxygen
Origin commit data
------------------
Commit: 9b6893ee34
Author: Thilo Graf <dbt@novatux.de>
Date: 2017-02-25 (Sat, 25 Feb 2017)
This commit is contained in:
@@ -128,10 +128,47 @@ class CComponentsWindow : public CComponentsForm
|
||||
{
|
||||
CC_WINDOW_ITEM_HEADER = 0
|
||||
};
|
||||
///simple constructor for CComponentsWindow, this shows a window over full screen
|
||||
|
||||
enum
|
||||
{
|
||||
CC_WINDOW_LEFT_SIDEBAR = 1,
|
||||
CC_WINDOW_RIGHT_SIDEBAR = 2
|
||||
};
|
||||
|
||||
/**simple constructor for CComponentsWindow, this shows a window over full screen
|
||||
* @param[in] parent
|
||||
* @li optional: expects type CComponentsForm * as possible parent object, default = NULL
|
||||
*/
|
||||
CComponentsWindow(CComponentsForm *parent = NULL);
|
||||
|
||||
///advanced constructor for CComponentsWindow, provides parameters for the most required properties, and caption as string, x_pos or y_pos = 0 will center window
|
||||
/**
|
||||
* advanced constructor for CComponentsWindow, provides parameters for the most required properties, and caption as string, x_pos or y_pos = 0 will center window
|
||||
* @param[in] x_pos
|
||||
* @li expects type const &int, defines x position on screen
|
||||
* @param[in] y_pos
|
||||
* @li expects type const &int, defines y position on screen
|
||||
* @param[in] w
|
||||
* @li expects type const &int, width of window, Note: value = 0 uses full screen, value > 0 to 100 interpreted as percent value of screen, value > 100 use native lines count on screen
|
||||
* @param[in] h
|
||||
* @li expects type const &int, height of window, Note: value = 0 uses full screen, value > 0 to 100 interpreted as percent value of screen, value > 100 use native lines count on screen
|
||||
* @param[in] caption
|
||||
* @li optional: expects type const std::string&, defines title of window header
|
||||
* @param[in] iconname
|
||||
* @li optional: expects type const std::string&, defines icon name of window header
|
||||
* @param[in] parent
|
||||
* @li optional: expects type CComponentsForm * as possible parent object, default = NULL
|
||||
* @param[in] shadow_mode
|
||||
* @li optional: expects type int as mode, default = CC_SHADOW_OFF
|
||||
* possible values are
|
||||
* CC_SHADOW_ON = (CC_SHADOW_RIGHT | CC_SHADOW_BOTTOM | CC_SHADOW_CORNER_BOTTOM_LEFT | CC_SHADOW_CORNER_BOTTOM_RIGHT | CC_SHADOW_CORNER_TOP_RIGHT)
|
||||
* @see cc_types.h
|
||||
* @param[in] color_frame
|
||||
* @li optional: expects type fb_pixel_t, defines frame color, default = COL_FRAME_PLUS_0
|
||||
* @param[in] color_body
|
||||
* @li optional: expects type fb_pixel_t, defines color color, default = COL_MENUCONTENT_PLUS_0
|
||||
* @param[in] color_shadow
|
||||
* @li optional: expects type fb_pixel_t, defines shadow color, default = COL_SHADOW_PLUS_0
|
||||
*/
|
||||
CComponentsWindow( const int& x_pos, const int& y_pos, const int& w, const int& h,
|
||||
const std::string& caption = "",
|
||||
const std::string& iconname = "",
|
||||
@@ -141,7 +178,12 @@ class CComponentsWindow : public CComponentsForm
|
||||
fb_pixel_t color_body = COL_MENUCONTENT_PLUS_0,
|
||||
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0);
|
||||
|
||||
///advanced constructor for CComponentsWindow, provides parameters for the most required properties, and caption from locales, x_pos or y_pos = 0 will center window
|
||||
/**
|
||||
* advanced constructor for CComponentsWindow, provides parameters for the most required properties
|
||||
* @param[in] locale_text
|
||||
* @li optional: expects type neutrino_locale_t, defines title of window header
|
||||
* @see for other parameters take a look to CComponentsWindow base class above
|
||||
*/
|
||||
CComponentsWindow( const int& x_pos, const int& y_pos, const int& w, const int& h,
|
||||
neutrino_locale_t locale_text = NONEXISTANT_LOCALE,
|
||||
const std::string& iconname = "",
|
||||
@@ -151,90 +193,249 @@ class CComponentsWindow : public CComponentsForm
|
||||
fb_pixel_t color_body = COL_MENUCONTENT_PLUS_0,
|
||||
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0);
|
||||
|
||||
///add item to body object, also usable is addCCItem() to add items to the windo object
|
||||
/**
|
||||
* Add an item to body object, also usable is addCCItem() to add items to the window object
|
||||
* @param[in] cc_Item
|
||||
* @li expects type CComponentsItem* , defines a cc item
|
||||
* @return Returns item ID
|
||||
* @see Take a look to cc_types.h for possible types.
|
||||
*/
|
||||
int addWindowItem(CComponentsItem* cc_Item);
|
||||
|
||||
///allow/disallow paint a footer, default true, see also ccw_show_footer, showHeader()
|
||||
void showFooter(bool show = true){ccw_show_footer = show; initCCWItems();};
|
||||
///allow/disallow paint a header, default true, see also ccw_show_header, showFooter()
|
||||
void showHeader(bool show = true){ccw_show_header = show; initCCWItems();};
|
||||
/**
|
||||
* enable/disable paint of footer, default true
|
||||
* @param[in] show
|
||||
* @li expects type bool, default = true
|
||||
* @see ccw_show_footer, showHeader()
|
||||
*/
|
||||
void showFooter(bool show = true){ccw_show_footer = show; initCCWItems();}
|
||||
|
||||
enum
|
||||
{
|
||||
CC_WINDOW_LEFT_SIDEBAR = 1,
|
||||
CC_WINDOW_RIGHT_SIDEBAR = 2
|
||||
};
|
||||
///allow/disallow paint a sidebar, default are enabled
|
||||
/**
|
||||
* enable/disable paint of header, default true
|
||||
* @param[in] show
|
||||
* @li expects type bool, default = true
|
||||
* @see ccw_show_header, showFooter()
|
||||
*/
|
||||
void showHeader(bool show = true){ccw_show_header = show; initCCWItems();}
|
||||
|
||||
/**
|
||||
* enable/disable paint of sidebar,
|
||||
* @param[in] show
|
||||
* @li optional: expects type const int&, default = enabled
|
||||
*/
|
||||
void enableSidebar(const int& sidbar_type = CC_WINDOW_LEFT_SIDEBAR | CC_WINDOW_RIGHT_SIDEBAR);
|
||||
|
||||
///set caption in header with string, see also getHeaderObject()
|
||||
/**
|
||||
* sets title text in header
|
||||
* @param[in] text
|
||||
* @li expects type const std::string&, defines title of window header
|
||||
* @param[in] align_mode
|
||||
* @li optional: expects type const int&, defines allignment of title text
|
||||
* @see CTextBox for alignment modes
|
||||
*/
|
||||
void setWindowCaption(const std::string& text, const int& align_mode = CTextBox::NO_AUTO_LINEBREAK){ccw_caption = text; ccw_align_mode = align_mode;}
|
||||
///set header text color
|
||||
void setWindowHeaderTextColor(const fb_pixel_t& color){ccw_col_head_text = color;}
|
||||
///set background to header
|
||||
void setWindowHeaderColor(const fb_pixel_t& color){ccw_col_head = color;}
|
||||
///set caption in header from locales, see also getHeaderObject()
|
||||
|
||||
/**
|
||||
* sets title text in header
|
||||
* @param[in] text
|
||||
* @li expects type neutrino_locale_t
|
||||
* @param[in] align_mode
|
||||
* @li optional: expects type const int&, defines allignment of title text
|
||||
* @see CTextBox for alignment modes
|
||||
*/
|
||||
void setWindowCaption(neutrino_locale_t locale_text, const int& align_mode = CTextBox::NO_AUTO_LINEBREAK);
|
||||
///set caption alignment, see CTextBox for possible modes
|
||||
|
||||
/**
|
||||
* Sets header text color
|
||||
* @param[in] const fb_pixel_t&
|
||||
* @li expects type const fb_pixel_t&
|
||||
*/
|
||||
void setWindowHeaderTextColor(const fb_pixel_t& color){ccw_col_head_text = color;}
|
||||
|
||||
/**
|
||||
* Sets header background color
|
||||
* @param[in] const fb_pixel_t&
|
||||
* @li expects type const fb_pixel_t&
|
||||
*/
|
||||
void setWindowHeaderColor(const fb_pixel_t& color){ccw_col_head = color;}
|
||||
|
||||
/**
|
||||
* sets title text alignment
|
||||
* @param[in] align_mode
|
||||
* @li expects type const int&
|
||||
* @see CTextBox for alignment modes
|
||||
*/
|
||||
void setWindowCaptionAlignment(const int& align_mode){ccw_align_mode = align_mode;};
|
||||
|
||||
///set icon name in header, see also getHeaderObject()
|
||||
/**
|
||||
* Sets icon name of window header.
|
||||
* @param[in] iconname
|
||||
* @li expects type const std::string&
|
||||
*/
|
||||
void setWindowIcon(const std::string& iconname){ccw_icon_name = iconname; initHeader();};
|
||||
|
||||
///set default header icon buttons, see also getHeaderObject()
|
||||
void setWindowHeaderButtons(const int& buttons){ccw_buttons = buttons;};
|
||||
/**
|
||||
* Sets context buttons in window header.
|
||||
* @param[in] buttons
|
||||
* @li expects type const int&
|
||||
* @note possible types are:
|
||||
* CC_BTN_HELP,
|
||||
CC_BTN_INFO,
|
||||
CC_BTN_MENU,
|
||||
CC_BTN_EXIT,
|
||||
CC_BTN_MUTE_ZAP_ACTIVE,
|
||||
CC_BTN_MUTE_ZAP_INACTIVE,
|
||||
CC_BTN_OKAY,
|
||||
CC_BTN_MUTE,
|
||||
CC_BTN_UP,
|
||||
CC_BTN_DOWN,
|
||||
CC_BTN_LEFT,
|
||||
CC_BTN_RIGHT,
|
||||
CC_BTN_FORWARD,
|
||||
CC_BTN_BACKWARD,
|
||||
CC_BTN_PAUSE,
|
||||
CC_BTN_PLAY,
|
||||
CC_BTN_RECORD_ACTIVE,
|
||||
CC_BTN_RECORD_INACTIVE,
|
||||
CC_BTN_RECORD_STOP,
|
||||
* @see cc_frm_header.h for current types
|
||||
*/
|
||||
void setWindowHeaderButtons(const int& buttons){ccw_buttons = buttons;}
|
||||
|
||||
///returns a pointer to the internal header object, use this to get access to header properities
|
||||
CComponentsHeader* getHeaderObject(){return ccw_head;};
|
||||
/**
|
||||
* Gets a pointer to the internal header object, use this to get direct access to header properities
|
||||
* @return CComponentsHeader*
|
||||
*/
|
||||
CComponentsHeader* getHeaderObject(){return ccw_head;}
|
||||
|
||||
///returns a pointer to the internal body object, use this to get access to body properities
|
||||
CComponentsForm* getBodyObject(){return ccw_body;};
|
||||
///returns a pointer to the internal footer object, use this to get access to footer properities
|
||||
CComponentsFooter* getFooterObject(){return ccw_footer;};
|
||||
/**
|
||||
* Gets a pointer to the internal body object, use this to get access to body properities
|
||||
* @return CComponentsForm*
|
||||
*/
|
||||
CComponentsForm* getBodyObject(){return ccw_body;}
|
||||
|
||||
///set background to footer
|
||||
/**
|
||||
* Gets a pointer to the internal footer object, use this to get access to footer properities
|
||||
* @return CComponentsFooter*
|
||||
*/
|
||||
CComponentsFooter* getFooterObject(){return ccw_footer;}
|
||||
|
||||
/**
|
||||
* Sets footer background color
|
||||
* @param[in] color
|
||||
* @li expects type const fb_pixel_t&
|
||||
*/
|
||||
void setWindowFooterColor(const fb_pixel_t& color){ccw_col_footer = color;}
|
||||
///set font for footer buttons
|
||||
|
||||
/**
|
||||
* Sets font for footer buttons
|
||||
* @param[in] font_type
|
||||
* @li expects type Font*
|
||||
*/
|
||||
void setWindowFooterFont(Font* font_type){ccw_button_font = font_type;}
|
||||
|
||||
///returns a pointer to the internal left side bar object, use this to get access to left sidebar properities
|
||||
CComponentsFrmChain* getLeftSidebarObject(){return ccw_left_sidebar;};
|
||||
///returns a pointer to the internal right side bar object, use this to get access to right sidebar properities
|
||||
CComponentsFrmChain* getRightSidebarObject(){return ccw_right_sidebar;};
|
||||
///sets width of sidebars
|
||||
void setWidthSidebar(const int& sidebar_width){ccw_w_sidebar = sidebar_width; initCCWItems();};
|
||||
/**
|
||||
* Gets a pointer to the internal left side bar object, use this to get access to left sidebar properities
|
||||
* @return CComponentsFrmChain*
|
||||
*/
|
||||
CComponentsFrmChain* getLeftSidebarObject(){return ccw_left_sidebar;}
|
||||
|
||||
///sets current page, NOTE: this is simliar with setCurrentPage() known from basic class CComponentsForm, but here it is related only for window body object
|
||||
/**
|
||||
* Gets a pointer to the internal right side bar object, use this to get access to right sidebar properities
|
||||
* @return CComponentsFrmChain*
|
||||
*/
|
||||
CComponentsFrmChain* getRightSidebarObject(){return ccw_right_sidebar;}
|
||||
|
||||
/**
|
||||
* Sets width of sidebars
|
||||
* @param[in] sidebar_width
|
||||
* @li expects type const int&
|
||||
*/
|
||||
void setWidthSidebar(const int& sidebar_width){ccw_w_sidebar = sidebar_width; initCCWItems();}
|
||||
|
||||
/**
|
||||
* Sets current page number
|
||||
* @param[in] sidebar_width
|
||||
* @li expects type const int&
|
||||
* @note This is simliar to setCurrentPage() known from basic class CComponentsForm, but here it is related only for window body object.
|
||||
*/
|
||||
void setCurrentPage(const u_int8_t& current_page);
|
||||
///get current page, NOTE: this is simliar with getCurrentPage() known from basic class CComponentsForm, but here it is related only for window body object
|
||||
|
||||
/**
|
||||
* Gets current page number
|
||||
* @return CComponentsFrmChain*
|
||||
* @note This simliar to getCurrentPage() known from basic class CComponentsForm, but here it is related only for window body object
|
||||
*/
|
||||
u_int8_t getCurrentPage();
|
||||
|
||||
///paint window body items, this paints only the current page, body = page, current page is definied in body object, see setCurrentPage()
|
||||
/**
|
||||
* Paints window body items, this paints only the current page, body = page, current page is definied in body object, see setCurrentPage()
|
||||
* @param[in] do_save_bg
|
||||
* @li optional: expects type bool, default = CC_SAVE_SCREEN_NO (false), sets background save mode
|
||||
*/
|
||||
void paintCurPage(bool do_save_bg = CC_SAVE_SCREEN_NO);
|
||||
///paint defined page of body, parameter number 0...n
|
||||
|
||||
/**
|
||||
* Paints defined page of body, parameter number 0...n
|
||||
* @param[in] page_number
|
||||
* @li expects type const u_int8_t& as page number
|
||||
* @param[in] do_save_bg
|
||||
* @li optional: expects type bool, default = CC_SAVE_SCREEN_NO (false), sets background save mode
|
||||
*/
|
||||
void paintPage(const u_int8_t& page_number, bool do_save_bg = CC_SAVE_SCREEN_NO);
|
||||
///enable/disable page scroll, parameter1 default enabled for up/down keys, only for body!
|
||||
|
||||
/**
|
||||
* enable/disable page scroll
|
||||
* @param[in] mode
|
||||
* @li optional: expects type const int&, default enabled for up/down keys, only for body!
|
||||
*/
|
||||
void enablePageScroll(const int& mode = PG_SCROLL_M_UP_DOWN_KEY);
|
||||
|
||||
///set width of body scrollbar
|
||||
/**
|
||||
* Sets width of body scrollbar
|
||||
* @param[in] crollbar_width
|
||||
* @li expects type const int&
|
||||
*/
|
||||
void setScrollBarWidth(const int& scrollbar_width);
|
||||
|
||||
///refresh position and dimension and reinitialize elemenatary properties
|
||||
/**
|
||||
* Reinit position and dimensions and reinitialize mostly elemenatary properties
|
||||
*/
|
||||
void Refresh(){initCCWItems();};
|
||||
|
||||
///paint all window items, this overwriting paint() from CComponentsForm
|
||||
/**
|
||||
* Paint window
|
||||
* @param[in] do_save_bg
|
||||
* @li optional: expects type bool, sets background save mode
|
||||
*/
|
||||
void paint(bool do_save_bg = CC_SAVE_SCREEN_YES);
|
||||
|
||||
///adds additional exec key to current collection, default exit keys are CRCInput::RC_home and CRCInput::RC_setup
|
||||
/**
|
||||
* Adds an additional exec key to current collection, default exit keys are CRCInput::RC_home and CRCInput::RC_setup
|
||||
* @param[in] key
|
||||
* @li expects type const neutrino_msg_t&
|
||||
* @see river/rcinput.h for possible keys
|
||||
*/
|
||||
virtual void addExitKey(const neutrino_msg_t& key){getBodyObject()->addExitKey(key);}
|
||||
///remove all current exec keys from current collection, NOTE: use addExitKey() if new exec key is required
|
||||
|
||||
/**
|
||||
* Removes all current exec keys from current collection.
|
||||
* @note use addExitKey() if new exec key is required
|
||||
*/
|
||||
virtual void removeExitKeys(){getBodyObject()->removeExitKeys();}
|
||||
};
|
||||
|
||||
class CComponentsWindowMax : public CComponentsWindow
|
||||
{
|
||||
public:
|
||||
///simple constructor for CComponentsWindow, provides parameters for caption as string and icon, this shows a centered window based up current screen settings
|
||||
/**
|
||||
* Simple constructor for CComponentsWindow, this shows only a centered window based up current screen settings
|
||||
* @see for other parameters take a look to CComponentsWindow base class above
|
||||
* @param[in] caption
|
||||
* @li expects type const std::string&, defines title of window header
|
||||
* @see for other parameters take a look to CComponentsWindow base class above
|
||||
*/
|
||||
CComponentsWindowMax( const std::string& caption, const std::string& iconname = "",
|
||||
CComponentsForm *parent = NULL,
|
||||
int shadow_mode = CC_SHADOW_OFF,
|
||||
@@ -242,7 +443,13 @@ class CComponentsWindowMax : public CComponentsWindow
|
||||
fb_pixel_t color_body = COL_MENUCONTENT_PLUS_0,
|
||||
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0);
|
||||
|
||||
///simple constructor for CComponentsWindow, provides parameters for caption from locales and icon, this shows a centered window based up current screen settings
|
||||
/**
|
||||
* Simple constructor for CComponentsWindow, this shows only a centered window based up current screen settings
|
||||
* @see for other parameters take a look to CComponentsWindow base class above
|
||||
* @param[in] locale_text
|
||||
* @li expects type neutrino_locale_t, defines title of window header
|
||||
* @see for other parameters take a look to CComponentsWindow base class above
|
||||
*/
|
||||
CComponentsWindowMax( neutrino_locale_t locale_caption, const std::string& iconname = "",
|
||||
CComponentsForm *parent = NULL,
|
||||
int shadow_mode = CC_SHADOW_OFF,
|
||||
|
||||
Reference in New Issue
Block a user