File: component_manager.h

package info (click to toggle)
clanlib 0.5.4-1-6
  • links: PTS
  • area: main
  • in suites: woody
  • size: 10,320 kB
  • ctags: 10,893
  • sloc: cpp: 76,056; xml: 3,281; sh: 2,961; perl: 1,204; asm: 837; makefile: 775
file content (131 lines) | stat: -rw-r--r-- 4,257 bytes parent folder | download
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*
	$Id: component_manager.h,v 1.27 2001/12/27 22:17:37 mbn Exp $

	------------------------------------------------------------------------
	ClanLib, the platform independent game SDK.

	This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
	version 2. See COPYING for details.

	For a total list of contributers see CREDITS.

	See http://www.clanlib.org
	------------------------------------------------------------------------
*/

//! clanGUI="Framework"
//! header=gui.h

#ifndef header_component_manager
#define header_component_manager

#include "component.h"
#include "component_type.h"
#include "../Core/System/error.h"

#include <string>
#include <map>

class CL_StyleManager;
class CL_ResourceManager;
class CL_ComponentType;
class CL_ComponentManager_Generic;

//: Manages components loaded from a gui definition file.
// The component manager is responsible for loading a set of components from a gui definition
// file (for an example of such a file, have a look at the login_view in the CTalk example).
// After a successful construction of a component manager, it is possible get pointers to
// components defined in the definition file, thus making it easy to seperate component layout
// from the user interface logic.
class CL_ComponentManager
{
//! Construction:
public:
	//: Depricated; 'new's a component manager. Please use the constructor directly instead.
	static CL_ComponentManager *create(
		const std::string &resource_id,
		CL_ResourceManager *res_manager,
		CL_StyleManager *style, 
		CL_Component *parent);

	//: Depricated; 'new's a component manager. Please use the constructor directly instead.
	static CL_ComponentManager *create(
		const std::string &filename,
		bool is_datafile,
		CL_StyleManager *style, 
		CL_Component *parent);

	// Constructs a component manager, loading the gui definition file from a resource ID.
	CL_ComponentManager(
		const std::string &resource_id,
		CL_ResourceManager *res_manager,
		CL_StyleManager *style, 
		CL_Component *parent);

	// Constructs a component manager, loading the gui definition file from a resource ID.
	// Inherits style manager and resources from parent component.
	CL_ComponentManager(
		const std::string &resource_id,
		CL_Component *parent);

	// Constructs a component manager, loading the gui definition file from a text file.
	CL_ComponentManager(
		const std::string &filename,
		bool is_datafile,
		CL_StyleManager *style, 
		CL_Component *parent);

	// Copy constructor.
	CL_ComponentManager(const CL_ComponentManager &copy);
	
	//: Component manager destructor.
	virtual ~CL_ComponentManager();

//! Attributes:
public:
	//: List of known component types.
	typedef std::map<std::string, CL_ComponentType *> component_type_map_t;
	static component_type_map_t component_types;

	//: Creates a component of type 'component_type_name'. If no such component
	//: type exists, a CL_Error is thrown. The method invokes the specific component types
	//: virtual 'create_component' method with the passed arguments. 
	static CL_Component *create_component(
		const std::string &type,
		CL_Component *parent,
		CL_StyleManager *style)
	{
		component_type_map_t::const_iterator it(component_types.find(type));
		if (it != component_types.end())
			return (*it).second->create_component(parent, style);

		cl_throw_error(std::string("Failed to create component of type ") + type);
		return NULL;
	}

	//: Returns the component identified by the specified name in the gui definition file.
	//: If the component is not found, a CL_Error exception is thrown.
	CL_Component *get_component(const std::string &name) const;

	//: Get component identifed by the specified name in the gui definition file.
	//: If the component is not of the correct type, a CL_Error exception is thrown.
	template<class Comp>
	void get_component(const std::string &name, Comp **component) const
	{
		*component = dynamic_cast<Comp*>(get_component(name.c_str()));
		if (*component == 0) cl_throw_error("Wrong component type!");
	}

	CL_StyleManager *get_style_manager() const;

//! Operations:
public:
	// Copy assignment operator.
	CL_ComponentManager &operator =(const CL_ComponentManager &copy);

//! Implementation:
private:
	CL_ComponentManager_Generic *impl;
};

#endif