CComponents: split some header files

Should bring more overview and less susceptibility to conflicts (merge etc)

License texts updated.


Origin commit data
------------------
Commit: 04574fc6eb
Author: Thilo Graf <dbt@novatux.de>
Date: 2014-01-06 (Mon, 06 Jan 2014)

src/gui/components/cc_frm_window.h

@@ -0,0 +1,160 @@
+/*
+	Based up Neutrino-GUI - Tuxbox-Project
+	Copyright (C) 2001 by Steffen Hehn 'McClean'
+
+	Classes for generic GUI-related components.
+	Copyright (C) 2012, 2013, 2014, Thilo Graf 'dbt'
+
+	License: GPL
+
+	This program is free software; you can redistribute it and/or
+	modify it under the terms of the GNU General Public
+	License as published by the Free Software Foundation; either
+	version 2 of the License, or (at your option) any later version.
+
+	This program is distributed in the hope that it will be useful,
+	but WITHOUT ANY WARRANTY; without even the implied warranty of
+	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+	General Public License for more details.
+
+	You should have received a copy of the GNU General Public License
+	along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef __CC_FORM_WINDOW_H__
+#define __CC_FORM_WINDOW_H__
+
+#include "cc_frm.h"
+#include "cc_frm_icons.h"
+#include "cc_frm_header.h"
+
+//! Sub class of CComponentsForm. Shows a window with prepared items.
+/*!
+CComponentsWindow provides prepared items like header, footer and a container for
+items like text, labels, pictures ...
+*/
+/*
+        x
+       y+-------------------------------------------------------+
+        |icon        caption                            buttons |header (ccw_head)
+        +-x-----------------------------------------------------+
+        |cc_item0                                               |
+        |cc_item1                                               |body (ccw_body)
+        |               add items here directly with            |
+        |               addWindowItem() or                      |
+        y               with ccw_body->addCCItem()              |
+        |               Note: x/y related to body object        |
+        |                                                       |
+        +-------------------------------------------------------+
+        |        add cc_items with ccw_footer->addCCItem()      |footer(ccw_footer)
+        +-------------------------------------------------------+
+
+*/
+
+class CComponentsWindow : public CComponentsForm
+{
+	protected:
+		///object: header object, to get access to header properties see also getHeaderObject()
+		CComponentsHeader * ccw_head;
+		///object: body object, this is the container for all needed items, to add with addWindowItem()
+		CComponentsForm * ccw_body;
+		///object: footer object, to get access to header properties see also getFooterObject(
+		CComponentsFooter * ccw_footer;
+		///property: caption in header, see also getHeaderObject()
+		std::string ccw_caption;
+		///property: alignment mode for header caption
+		int ccw_align_mode;
+		///property: icon name in header, see also getHeaderObject()
+		const char* ccw_icon_name;
+		///property: assigned default icon buttons in header, see also getHeaderObject()
+		int ccw_buttons;
+		///property: value = true, let show footer, see showFooter()
+		bool ccw_show_footer;
+		///property: value = true, let show header, see showHeader()
+		bool ccw_show_header;
+
+		///initialze header object
+		void initHeader();
+		///initialze body object
+		void initBody();
+		///initialze footer object
+		void initFooter();
+		///initialze all window objects at once
+		void initCCWItems();
+		///initialize all attributes
+		void initVarWindow();
+
+	public:
+		enum
+		{
+			CC_WINDOW_ITEM_HEADER 	= 0
+		};
+		///simple constructor for CComponentsWindow
+		CComponentsWindow();
+
+		///advanced constructor for CComponentsWindow, provides parameters for the most required properties, and caption as string
+		CComponentsWindow(	const int x_pos, const int y_pos, const int w, const int h,
+					const std::string& caption,
+					const char* iconname = NULL,
+					bool has_shadow = CC_SHADOW_OFF,
+					fb_pixel_t color_frame = COL_MENUCONTENT_PLUS_6,
+					fb_pixel_t color_body = COL_MENUCONTENT_PLUS_0,
+					fb_pixel_t color_shadow = COL_MENUCONTENTDARK_PLUS_0);
+
+		///advanced constructor for CComponentsWindow, provides parameters for the most required properties, and caption from locales
+		CComponentsWindow(	const int x_pos, const int y_pos, const int w, const int h,
+					neutrino_locale_t locale_caption,
+					const char* iconname = NULL,
+					bool has_shadow = CC_SHADOW_OFF,
+					fb_pixel_t color_frame = COL_MENUCONTENT_PLUS_6,
+					fb_pixel_t color_body = COL_MENUCONTENT_PLUS_0,
+					fb_pixel_t color_shadow = COL_MENUCONTENTDARK_PLUS_0);
+
+		///simple constructor for CComponentsWindow, provides parameters for caption as string and icon, position of window is general centered and bound
+		///to current screen settings, this shows a window over full screen
+		CComponentsWindow(const std::string& caption, const char* iconname = NULL);
+
+		///simple constructor for CComponentsWindow, provides parameters for caption from locales and icon, position of window is general centered and bound
+		///to current screen settings, this shows a window over full screen
+		CComponentsWindow(neutrino_locale_t locale_caption, const char* iconname = NULL);
+
+		~CComponentsWindow();
+
+		///add item to body object, also usable is addCCItem() to add items to the windo object
+		void 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();};
+
+		///set caption in header with string, see also getHeaderObject()
+		void setWindowCaption(const std::string& text, const int& align_mode = CTextBox::NO_AUTO_LINEBREAK){ccw_caption = text; ccw_align_mode = align_mode;};
+
+		///set caption in header from locales, see also getHeaderObject()
+		void setWindowCaption(neutrino_locale_t locale_text, const int& align_mode = CTextBox::NO_AUTO_LINEBREAK);
+		///set caption alignment
+		void setWindowCaptionAlignment(const int& align_mode){ccw_align_mode = align_mode;};
+
+		///set icon name in header, see also getHeaderObject()
+		void setWindowIcon(const char* iconname){ccw_icon_name = iconname;};
+
+		///set default header icon buttons, see also getHeaderObject()
+		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;};
+
+		///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;};
+
+		///refresh position and dimension and reinitialize elemenatary properties
+		void Refresh(){initCCWItems();};
+
+		///paint all window items, this overwriting paint() from CComponentsForm
+		virtual void paint(bool do_save_bg = CC_SAVE_SCREEN_YES);
+};
+
+#endif