/*
	Rogue Trader.
	Copyright (c) 2007, Darragh Coy.
	All rights reserved.
	Original work(s), source code & author(s) details available at: http://www.darraghcoy.com

	Redistribution and use in source and binary forms, with or without modification, are permitted 
	provided that the following conditions are met:

		* 	Redistributions of source code must retain the above copyright notice, this list of 
			conditions and the following disclaimer.
		* 	Redistributions in binary form must reproduce the above copyright notice, this list of 
			conditions and the following disclaimer in the documentation.
		* 	Neither the name of the author nor the names of contributors may be used to endorse or 
			promote products derived from this software without specific prior written permission.
		* 	The use of any third party libraries, modules or data files provided with the source 
			form of the program must follow and respect the individual licensing terms of these 
			components. You do not have permission to modify or circumvent the licensing terms for 
			provided third party components unless the third party licenses specifically allow this. 
			If you do not agree to the terms of provided third party components then you do not have 
			permission to use them in your derived work(s).
		* 	The terms of this license do not apply to separate (but related) distributions if supplied 
			by the author(s), only to the contents of this source distribution, derived works, and the 
			binaries produced by either modified or unmodified versions of the source code. The terms 
			of this license do not also apply to any third party libraries or components provided with 
			the source distribution. Such third party elements are licensed under their own separate 
			agreements.

	THIS SOFTWARE IS PROVIDED BY DARRAGH COY ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, 
	BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
	ARE DISCLAIMED. IN NO EVENT SHALL DARRAGH COY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
	EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 
	OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
	OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
	IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef GUIPANEL_H
#define GUIPANEL_H

//##############################################################################
// C Includes:
//##############################################################################

#include <Windows.h>
#include <gl/gl.h>

//##############################################################################
// C++ Includes: cant forward reference these because the compiler complains
//##############################################################################

#include "GuiWidget.h"
#include "GLWindowEventListener.h"

//##############################################################################
//##############################################################################
//##############################################################################
//##############################################################################
//
//
// Class Name:   GuiButton
// Purpose:      A panel is a bit like a gui screen in that it can contain other
//               widgets, but has no purpose other than stylistic. It does propogate
//               events down to contained widgets however, much like the GuiScreen
//               does with its contained widgets.
//
//
//
//##############################################################################
//##############################################################################
//##############################################################################
//##############################################################################

class GuiPanel : public GuiWidget
{

 public:

        //----------------------------------------------------------------------
        // Functions
        //----------------------------------------------------------------------

        // Default Constructor:

        GuiPanel();

        // Destructor: delete all attached widgets

        ~GuiPanel();

        // Trys to add a widget to the panel. Widget memory is managed by the panel from here on in.
        // If the add is unsuccessful the widget is deleted.

        void addWidget ( GuiWidget * widget );

        // Trys to remove a widget from the panel. Deletes it also if found.

        void removeWidget ( GuiWidget * widget );

        // Draw the panel

        void windowRedrawing();

        // Set and get whether the panel is raised or sunken

        void setRaised( bool );
        bool getRaised( void );

//##############################################################################
//##############################################################################
//##############################################################################
//##############################################################################

 protected:

        //----------------------------------------------------------------------
        // Constants
        //----------------------------------------------------------------------

        // These constants control the shading of the panel

        static const float INTENSITY_NORMAL_1;  // normal fill brightness for the panel: first shade
        static const float INTENSITY_NORMAL_2;  // normal fill brightness for the panel: second shade
        static const float INTENSITY_SHINE_1;   // fill brightness around the shiny parts of the widget: first shade
        static const float INTENSITY_SHINE_2;   // fill brightness around the shiny parts of the widget: second shade
        static const float INTENSITY_SHADE_1;   // fill brightness around the shady parts of the widget: first shade
        static const float INTENSITY_SHADE_2;   // fill brightness around the shady parts of the widget: second shade

        //----------------------------------------------------------------------
        // Variables
        //----------------------------------------------------------------------

        bool raised;    // is the panel raised or sunken ?

//##############################################################################
//##############################################################################
//##############################################################################
//##############################################################################

 private:

        //----------------------------------------------------------------------
        // Constants
        //----------------------------------------------------------------------

        // Maximum number of widgets a panel allows for

        static const unsigned MAX_WIDGETS = 128;

        //----------------------------------------------------------------------
        // Functions
        //----------------------------------------------------------------------

        // These event handling function are private and cannot be over-ridden by derived classes

        void mouseMoved    ( int x , int y );
        void mousePressed  ( int x , int y , GLWindow::MouseButton button );
        void mouseReleased ( int x , int y , GLWindow::MouseButton button );

        void lostFocus();

        //----------------------------------------------------------------------
        // Variables
        //----------------------------------------------------------------------

        // The array of pointers to widgets

        GuiWidget * widgets[MAX_WIDGETS];

}; // end of: class GuiPanel{}


#endif // end of: ifndef GUIPANEL_H
