Differential D761 Diff 3156 source/gui/CGUIScrollBarVertical.h

Changeset View

Standalone View

source/gui/CGUIScrollBarVertical.h

	/* Copyright (C) 2015 Wildfire Games.			/* Copyright (C) 2017 Wildfire Games.
	* This file is part of 0 A.D.			* This file is part of 0 A.D.
	*			*
	* 0 A.D. is free software: you can redistribute it and/or modify			* 0 A.D. is free software: you can redistribute it and/or modify
	* it under the terms of the GNU General Public License as published by			* it under the terms of the GNU General Public License as published by
	* the Free Software Foundation, either version 2 of the License, or			* the Free Software Foundation, either version 2 of the License, or
	* (at your option) any later version.			* (at your option) any later version.
	*			*
	* 0 A.D. is distributed in the hope that it will be useful,			* 0 A.D. is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of			* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU General Public License for more details.			* GNU General Public License for more details.
	*			*
	* You should have received a copy of the GNU General Public License			* You should have received a copy of the GNU General Public License
	* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.			* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
	*/			*/

	/*			/*
	A GUI ScrollBar			A vertical GUI Scrollbar, this class doesn't present all functionality
				to the scrollbar, it just controls the drawing, handles some events,
	--Overview--			and provides a wrapper for interaction with itself. Actual tracking
				of how far we've scrolled inside the owner is handled elsewhere.
	A GUI Scrollbar, this class doesn't present all functionality
	to the scrollbar, it just controls the drawing and a wrapper
	for interaction with it.

	--Usage--

	Used in everywhere scrollbars are needed, like in a combobox for instance.

	--More info--

	Check GUI.h

	*/			*/

	#ifndef INCLUDED_CGUISCROLLBARVERTICAL			#ifndef INCLUDED_CGUISCROLLBARVERTICAL
	#define INCLUDED_CGUISCROLLBARVERTICAL			#define INCLUDED_CGUISCROLLBARVERTICAL

	#include "IGUIScrollBar.h"			#include "IGUIScrollBar.h"
	#include "GUI.h"			#include "GUI.h"

	/**			/**
	* Vertical implementation of IGUIScrollBar			* Vertical implementation of IGUIScrollBar
	*			*
	* @see IGUIScrollBar			* @see IGUIScrollBar
	*/			*/
	class CGUIScrollBarVertical : public IGUIScrollBar			class CGUIScrollBarVertical : public IGUIScrollBar
	{			{
	public:			public:
	CGUIScrollBarVertical();			CGUIScrollBarVertical();
	virtual ~CGUIScrollBarVertical();			virtual ~CGUIScrollBarVertical();

	public:			public:

				virtual void Draw();

	/**			/**
	* Draw the scroll-bar			* Setup the scrollbar. Sets the size, length and position.
				* An object owning scrollbars still has to call this (preferably
				* in the object's own Setup function), it isn't called
				* automatically. There are two variations covering several common
				* uses.
				*
				* The first assumes that the content is inside the host and thus
				* uses the host's dimensions.
				*
				* The second permits a CRect defining the dimensions of the
				* scrollable content to be passed. Any object that uses this
				* variant has to set a scroll range.
	*/			*/
	virtual void Draw();			virtual void Setup();
				virtual void Setup(const CRect& content);

	/**			/**
	* If an object that contains a scrollbar has got messages, send			* If an object containing one (or more) scrollbars receives messages,
	* them to the scroll-bar and it will see if the message regarded			* pass the messages on to the scrollbar to be dealt with as appropriate.
	* itself.
	*			*
	* @see IGUIObject#HandleMessage()			* @see IGUIObject#HandleMessage()
	*/			*/
	virtual void HandleMessage(SGUIMessage& Message);			virtual void HandleMessage(SGUIMessage& Message);

	/**			/**
	* Set m_Pos with g_mouse_x/y input, i.e. when dragging.			* Set m_Pos with g_mouse_x/y input, i.e. when dragging.
	*/			*/
	virtual void SetPosFromMousePos(const CPos& mouse);			virtual void SetPosFromMousePos(const CPos& mouse);

	/**
	* @see IGUIScrollBar#HoveringButtonMinus
	*/
	virtual bool HoveringButtonMinus(const CPos& mouse);			virtual bool HoveringButtonMinus(const CPos& mouse);

	/**
	* @see IGUIScrollBar#HoveringButtonPlus
	*/
	virtual bool HoveringButtonPlus(const CPos& mouse);			virtual bool HoveringButtonPlus(const CPos& mouse);

	/**
	* Set Right Aligned
	* @param align Alignment
	*/
	void SetRightAligned(const bool& align) { m_RightAligned = align; }			void SetRightAligned(const bool& align) { m_RightAligned = align; }

	/**			/**
	* Get the rectangle of the actual BAR.			* Get the rectangle of the actual BAR.
	* @return Rectangle, CRect
	*/			*/
	virtual CRect GetBarRect() const;			virtual CRect GetBarRect() const;

	/**			/**
	* Get the rectangle of the outline of the scrollbar, every component of the			* Get the rectangle of the outline of the scrollbar, every component of the
	* scroll-bar should be inside this area.			* scrollbar should be inside this area.
	* @return Rectangle, CRect
	*/			*/
	virtual CRect GetOuterRect() const;			virtual CRect GetOuterRect() const;

	protected:			protected:
	/**			/**
	* Should the scroll bar proceed to the left or to the right of the m_X value.			* Should the scrollbar be drawn on the left or on the right of the m_X value.
	* Notice, this has nothing to do with where the owner places it.			* Notice, this has nothing to do with where the owner places it.
	*/			*/
	bool m_RightAligned;			bool m_RightAligned;
	};			};

	#endif // INCLUDED_CGUISCROLLBARVERTICAL			#endif // INCLUDED_CGUISCROLLBARVERTICAL