path: root/src/menu/vertical_text_alignment.hpp

/*
 * 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 VERTICAL_TEXT_ALIGNMENT_HPP
#define VERTICAL_TEXT_ALIGNMENT_HPP

#include "utils/rectangle.hpp"
#include "utils/dimension.hpp"

namespace usdx
{
	class VerticalTextAlignment
	{
	public:
		virtual ~VerticalTextAlignment() {};

		/**
		 * This function should be used to align a text vertical in a box.
		 *
		 * @param offset reference where the offset should be modified (only the
		 * vertical values are modified, so that it is possible to combine it
		 * with an other Alignment)
		 * @param font size of the text, that should be displayed
		 * @param box size of the box, the text should be aligned in
		 */
		virtual void align(Point<int>& offset, const Rectangle<int>& font,
						   const Dimension<int>& box) const = 0;
	};

	class VerticalTextAlignmentTop : public VerticalTextAlignment
	{
	public:
		virtual void align(Point<int>&, const Rectangle<int>&,
						   const Dimension<int>&) const;
	};

	class VerticalTextAlignmentBottom : public VerticalTextAlignment
	{
	public:
		virtual void align(Point<int>&, const Rectangle<int>&,
						   const Dimension<int>&) const;
	};

	class VerticalTextAlignmentBaseline : public VerticalTextAlignment
	{
	public:
		virtual void align(Point<int>&, const Rectangle<int>&,
						   const Dimension<int>&) const;
	};

	class VerticalTextAlignmentCenter : public VerticalTextAlignment
	{
	public:
		virtual void align(Point<int>&, const Rectangle<int>&,
						   const Dimension<int>&) const;
	};
}

#endif