resource.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 */
00028 
00031 
00032 #pragma once
00033 
00034 #include "../api_core.h"
00035 #include "../Resources/resource_manager.h"
00036 #include "../System/sharedptr.h"
00037 #include "../Text/string_types.h"
00038 
00039 class CL_DomElement;
00040 class CL_ResourceManager;
00041 class CL_Resource_Impl;
00042 
00043 class CL_ResourceData
00044 {
00045 public:
00046         virtual ~CL_ResourceData() { }
00047 };
00048 
00052 class CL_API_CORE CL_Resource
00053 {
00056 
00057 public:
00058         CL_Resource();
00059 
00060         ~CL_Resource();
00061 
00065 
00066 public:
00068         CL_String get_type() const;
00069 
00071         CL_String get_name() const;
00072 
00074         CL_DomElement &get_element();
00075 
00077         CL_ResourceManager get_manager();
00078 
00080         CL_SharedPtr<CL_ResourceData> get_data(const CL_String &data_name);
00081 
00083         int get_data_session_count(const CL_String &data_name);
00084 
00088 
00089 public:
00091         bool operator ==(const CL_Resource &other) const;
00092 
00094         void set_data(const CL_String &data_name, const CL_SharedPtr<CL_ResourceData> &ptr);
00095 
00097         void clear_data(const CL_String &data_name);
00098 
00100         int add_data_session(const CL_String &data_name);
00101 
00103         int remove_data_session(const CL_String &data_name);
00104 
00108 
00109 private:
00110 
00115         CL_Resource(CL_DomElement element, CL_ResourceManager &resource_manager);
00116 
00117         CL_SharedPtr<CL_Resource_Impl> impl;
00118 
00119         friend class CL_ResourceManager;
00121 };
00122