cursor.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 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 <memory>
33 #include "../display_target.h"
34 
35 namespace clan
36 {
39 
40 class DisplayWindow;
41 class CursorProvider;
42 class CursorDescription;
43 class Point;
44 class Cursor_Impl;
45 
47 class Cursor
48 {
51 
52 public:
54  Cursor();
55 
61  Cursor(const DisplayWindow &window, const CursorDescription &cursor_description);
62 
66 
67 public:
69  bool is_null() const { return !impl; }
70 
72  void throw_if_null() const;
73 
76 
80 
81 public:
82 
86 
87 private:
88  std::shared_ptr<Cursor_Impl> impl;
90 };
91 
92 }
93 
bool is_null() const
Returns true if this object is invalid.
Definition: cursor.h:69
Cursor()
Constructs a null instance.
Mouse cursor class.
Definition: cursor.h:48
Cursor(const DisplayWindow &window, const CursorDescription &cursor_description)
Constructs a Cursor.
This class contains everything to construct a cursor - its data, default settings etc.
Definition: cursor_description.h:71
CursorProvider * get_provider() const
Returns the cursor provider.
Definition: clanapp.h:36
void throw_if_null() const
Throw an exception if this object is invalid.
Top-level window class.
Definition: display_window.h:102
Interface for implementing a Cursor target.
Definition: cursor_provider.h:40