/*
 * UltraStar Deluxe - Karaoke Game
 *
 * UltraStar Deluxe is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef CONTAINER_HPP
#define CONTAINER_HPP

#include <list>
#include <boost/signals2.hpp>
#include <log4cpp/Category.hh>

#include "drawable_control.hpp"
#include "utils/point.hpp"

namespace usdx
{
	class Frame;

	class Container : public DrawableControl
	{
	private:
		static log4cpp::Category&  log;

		Frame* frame;
		std::list<DrawableControl*> controls;

		/**
		 * Left bottom corner of the container in window coordinats. This is
		 * used for calculating the window coordinates of the containing
		 * controls for clipping, that only works with window coordinates.
		 */
		Point<int> window_coords;
		void recalculate_window_coords(void);

		/**
		 * Connection to recieve window coordinate changes from parent
		 * container.
		 */
		boost::signals2::connection window_coords_connection;

		void init(Container* parent);

	protected:
		Container(Container*, const ContainerHelper&);

		virtual void draw(void);

	public:
		Container(Container*);
		virtual ~Container();

		virtual void add(DrawableControl*);
		virtual void remove(DrawableControl*);

		virtual void setFrame(Frame*);
		virtual void removeFrame(void);

		const Point<int>& get_window_coords(void) const;

		/**
		 * Overwritten here to be able to recalculate the window coordinates.
		 *
		 * @see window_coords
		 */
		virtual void set_position(const Point<int>& position);

		/**
		 * Overwritten here to be able to recalculate the window coordinates.
		 *
		 * @see window_coords
		 */
		virtual void set_position(int left, int top);

		/**
		 * Overwritten here to be able to recalculate the window coordinates.
		 *
		 * @see window_coords
		 */
		virtual void set_size(const Dimension<int>& size);

		/**
		 * Overwritten here to be able to recalculate the window coordinates.
		 *
		 * @see window_coords
		 */
		virtual void set_size(int width, int height);

		virtual DrawableControl* get_component_at(const Point<int>& p);

		/**
		 * This signal gets emitted, if the window coordinates are changed.
		 */
		boost::signals2::signal<void ()> window_coords_change;
	};
};


#endif