cursor.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_display.h"
00035 #include "../../Core/System/sharedptr.h"
00036 #include "../display_target.h"
00037 
00038 class CL_DisplayWindow;
00039 class CL_CursorProvider;
00040 class CL_SpriteDescription;
00041 class CL_Point;
00042 class CL_Cursor_Impl;
00043 
00047 class CL_API_DISPLAY CL_Cursor
00048 {
00051 
00052 public:
00054         CL_Cursor();
00055 
00061         CL_Cursor(const CL_DisplayWindow &window, const CL_SpriteDescription &sprite_description, const CL_Point &hotspot);
00062 
00066 
00067 public:
00069         bool is_null() const { return !impl; }
00070 
00072         void throw_if_null() const;
00073 
00075         CL_CursorProvider *get_provider() const;
00076 
00080 
00081 public:
00082 
00086 
00087 private:
00088         CL_SharedPtr<CL_Cursor_Impl> impl;
00090 };
00091