cursor.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 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 */
28 
29 
30 #pragma once
31 
32 #include "../api_display.h"
33 #include <memory>
34 #include "../display_target.h"
35 
36 namespace clan
37 {
40 
41 class DisplayWindow;
42 class CursorProvider;
43 class CursorDescription;
44 class Point;
45 class Cursor_Impl;
46 
48 class CL_API_DISPLAY Cursor
49 {
52 
53 public:
55  Cursor();
56 
62  Cursor(const DisplayWindow &window, const CursorDescription &cursor_description, const Point &hotspot);
63 
67 
68 public:
70  bool is_null() const { return !impl; }
71 
73  void throw_if_null() const;
74 
76  CursorProvider *get_provider() const;
77 
81 
82 public:
83 
87 
88 private:
89  std::shared_ptr<Cursor_Impl> impl;
91 };
92 
93 }
94 
Interface for implementing a Cursor target.
Definition: cursor_provider.h:40
Mouse cursor class.
Definition: cursor.h:48
bool is_null() const
Returns true if this object is invalid.
Definition: cursor.h:70
This class contains everything to construct a cursor - its data, default settings etc...
Definition: cursor_description.h:71
2D (x,y) point structure - Integer
Definition: point.h:63
Top-level window class.
Definition: display_window.h:85