gui_message.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 **    Harry Storbacka
00028 */
00029 
00032 
00033 #pragma once
00034 
00035 #include "api_gui.h"
00036 #include "../Core/System/sharedptr.h"
00037 
00038 class CL_GUIComponent;
00039 class CL_GUIMessage_Impl;
00040 
00041 class CL_GUIMessageData
00042 {
00043 public:
00044         virtual ~CL_GUIMessageData() { }
00045 };
00046 
00050 class CL_API_GUI CL_GUIMessage
00051 {
00054 
00055 public:
00057         CL_GUIMessage();
00058 
00059         virtual ~CL_GUIMessage();
00060 
00064 
00065 public:
00067         CL_StringRef get_type() const;
00068 
00070         bool is_type(const CL_StringRef &type) const;
00071 
00073         CL_SharedPtr<CL_GUIMessageData> get_data(const CL_StringRef &data_name) const;
00074 
00076         CL_GUIComponent *get_target() const;
00077 
00079         bool is_consumed() const;
00080 
00084 
00085 public:
00087         void set_type(const CL_StringRef &type);
00088 
00090         void set_data(const CL_StringRef &data_name, const CL_SharedPtr<CL_GUIMessageData> &ptr);
00091 
00093         void set_target(CL_GUIComponent *target);
00094 
00096         void set_null();
00097 
00099         void set_consumed();
00100 
00104 
00105 private:
00106         CL_SharedPtr<CL_GUIMessage_Impl> impl;
00108 };
00109