cursor.h Source File - ClanLib SDK
Description: cursor.h Source File

cursor.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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#pragma once
30
31#include <memory>
32#include "../display_target.h"
33
34namespace clan
35{
38
39 class DisplayWindow;
40 class CursorProvider;
41 class CursorDescription;
42 class Point;
43 class Cursor_Impl;
44
46 class Cursor
47 {
48 public:
50 Cursor();
51
57 Cursor(const DisplayWindow &window, const CursorDescription &cursor_description);
58
60 bool is_null() const { return !impl; }
61 explicit operator bool() const { return bool(impl); }
62
64 void throw_if_null() const;
65
67 CursorProvider *get_provider() const;
68
69 private:
70 std::shared_ptr<Cursor_Impl> impl;
71 };
72
74}
clan::CursorDescription
This class contains everything to construct a cursor - its data, default settings etc.
Definition cursor_description.h:70
clan::CursorProvider
Interface for implementing a Cursor target.
Definition cursor_provider.h:38
clan::Cursor
Mouse cursor class.
Definition cursor.h:47
clan::Cursor::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::Cursor::is_null
bool is_null() const
Returns true if this object is invalid.
Definition cursor.h:60
clan::Cursor::Cursor
Cursor(const DisplayWindow &window, const CursorDescription &cursor_description)
Constructs a Cursor.
clan::Cursor::get_provider
CursorProvider * get_provider() const
Returns the cursor provider.
clan::Cursor::Cursor
Cursor()
Constructs a null instance.
clan::DisplayWindow
Top-level window class.
Definition display_window.h:101
clan
Definition clanapp.h:36