ClanLib  2.3.7
gui_message.h
Go to the documentation of this file.
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2011 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** Harry Storbacka
28 */
29 
32 
33 #pragma once
34 
35 #include "api_gui.h"
36 #include "../Core/System/sharedptr.h"
37 
38 class CL_GUIComponent;
39 class CL_GUIMessage_Impl;
40 
42 {
43 public:
44  virtual ~CL_GUIMessageData() { }
45 };
46 
51 {
54 
55 public:
57  CL_GUIMessage();
58 
59  virtual ~CL_GUIMessage();
60 
64 
65 public:
67  CL_StringRef get_type() const;
68 
70  bool is_type(const CL_StringRef &type) const;
71 
73  CL_SharedPtr<CL_GUIMessageData> get_data(const CL_StringRef &data_name) const;
74 
76  CL_GUIComponent *get_target() const;
77 
79  bool is_consumed() const;
80 
84 
85 public:
87  void set_type(const CL_StringRef &type);
88 
90  void set_data(const CL_StringRef &data_name, const CL_SharedPtr<CL_GUIMessageData> &ptr);
91 
93  void set_target(CL_GUIComponent *target);
94 
96  void set_null();
97 
99  void set_consumed();
100 
104 
105 private:
106  CL_SharedPtr<CL_GUIMessage_Impl> impl;
108 };
109