File: IGUIScrollBarOwner.h

package info (click to toggle)
0ad 0.28.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 182,352 kB
  • sloc: cpp: 201,989; javascript: 19,730; ansic: 15,057; python: 6,597; sh: 2,046; perl: 1,232; xml: 543; java: 533; makefile: 105
file content (99 lines) | stat: -rw-r--r-- 2,392 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/* Copyright (C) 2025 Wildfire Games.
 * This file is part of 0 A.D.
 *
 * 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
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * 0 A.D. 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 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef INCLUDED_IGUISCROLLBAROWNER
#define INCLUDED_IGUISCROLLBAROWNER

#include "lib/code_annotation.h"

#include <memory>
#include <vector>

class CCanvas2D;
class CStr8;
class IGUIObject;
class IGUIScrollBar;
struct SGUIMessage;
struct SGUIScrollBarStyle;

/**
 * Base-class this if you want an object to contain
 * one, or several, scroll-bars.
 */
class IGUIScrollBarOwner
{
	NONCOPYABLE(IGUIScrollBarOwner);

	friend class IGUIScrollBar;

public:
	IGUIScrollBarOwner(IGUIObject& m_pObject);
	virtual ~IGUIScrollBarOwner();

	virtual void Draw(CCanvas2D& canvas);

	/**
	 * @see IGUIObject#HandleMessage()
	 */
	virtual void HandleMessage(SGUIMessage& Message);

	/**
	 * @see IGUIObject#ResetStates()
	 */
	virtual void ResetStates();

	/**
	 * Interface for the m_ScrollBar to use.
	 */
	virtual const SGUIScrollBarStyle* GetScrollBarStyle(const CStr8& style) const;

	/**
	 * Add a scroll-bar
	 */
	virtual void AddScrollBar(std::unique_ptr<IGUIScrollBar> scrollbar);

	/**
	 * Get Scroll Bar reference (it should be transparent it's actually
	 * pointers).
	 */
	virtual IGUIScrollBar& GetScrollBar(const int& index)
	{
		return *m_ScrollBars[index];
	}

	/**
	 * Get the position of the scroll bar at @param index.
	 * Equivalent to GetScrollbar(index).GetPos().
	 */
	virtual float GetScrollBarPos(const int index) const;

protected:
	/**
	 * Predominately you will only have one, but you can have
	 * as many as you like.
	 */
	std::vector<std::unique_ptr<IGUIScrollBar>> m_ScrollBars;

private:
	/**
	 * Reference to the IGUIObject.
	 * Private, because we don't want to inherit it in multiple classes.
	 */
	IGUIObject& m_pObject;
};

#endif // INCLUDED_IGUISCROLLBAROWNER