File: cursor.hpp

package info (click to toggle)
sight 25.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 42,184 kB
  • sloc: cpp: 289,476; xml: 17,257; ansic: 9,878; python: 1,379; sh: 144; makefile: 33
file content (159 lines) | stat: -rw-r--r-- 3,891 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/************************************************************************
 *
 * Copyright (C) 2009-2024 IRCAD France
 * Copyright (C) 2012-2019 IHU Strasbourg
 *
 * This file is part of Sight.
 *
 * Sight is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Sight is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Sight. If not, see <https://www.gnu.org/licenses/>.
 *
 ***********************************************************************/

#pragma once

#include <sight/ui/__/config.hpp>

#include "ui/__/cursor_base.hpp"

#include <core/base.hpp>

namespace sight::ui
{

/**
 * @brief   Defines the generic cursor for UI.
 * Use the Delegate design pattern
 */
class SIGHT_UI_CLASS_API cursor : public ui::cursor_base
{
public:

    SIGHT_DECLARE_CLASS(cursor, ui::cursor_base);

    /// Constructor. Create the implementation of the specific cursor
    SIGHT_UI_API cursor();
    /// Destructor. Do nothing
    SIGHT_UI_API ~cursor() override = default;

    // TODO : update API to reflect the cursor stack
    /// Set the cursor
    SIGHT_UI_API void set_cursor(ui::cursor_base::state_t _cursor, bool _set_overriden_as_default = true) override;

    /// Set the default cursor
    SIGHT_UI_API void set_default_cursor() override;

protected:

    /// Implementation of a cursor in a specific UI (wx/Qt)
    ui::cursor_base::sptr m_implementation;
};

/// Convenience "busy" cursor  that will reset to default once deleted
/// It can be useful in case of exception
class SIGHT_UI_CLASS_API busy_cursor : public cursor
{
public:

    SIGHT_DECLARE_CLASS(busy_cursor, cursor);

    /// Constructor. Sets cursor to "busy" state
    SIGHT_UI_API busy_cursor()
    {
        set_cursor(state_t::busy);
    }

    /// Destructor. Reset cursor to default
    SIGHT_UI_API ~busy_cursor() override
    {
        set_default_cursor();
    }
};

class SIGHT_UI_CLASS_API wait_cursor : public cursor
{
public:

    SIGHT_DECLARE_CLASS(wait_cursor, cursor);

    /// Constructor. Sets cursor to "wait" state
    SIGHT_UI_API wait_cursor()
    {
        set_cursor(state_t::wait);
    }

    /// Destructor. Reset cursor to default
    SIGHT_UI_API ~wait_cursor() override
    {
        set_default_cursor();
    }
};

class SIGHT_UI_CLASS_API cross_cursor : public cursor
{
public:

    SIGHT_DECLARE_CLASS(cross_cursor, cursor);

    /// Constructor. Sets cursor to "cross" state
    SIGHT_UI_API cross_cursor()
    {
        set_cursor(state_t::cross);
    }

    /// Destructor. Reset cursor to default
    SIGHT_UI_API ~cross_cursor() override
    {
        set_default_cursor();
    }
};

class SIGHT_UI_CLASS_API open_hand_cursor : public cursor
{
public:

    SIGHT_DECLARE_CLASS(open_hand_cursor, cursor);

    /// Constructor. Sets cursor to "cross" state
    SIGHT_UI_API open_hand_cursor()
    {
        set_cursor(state_t::open_hand);
    }

    /// Destructor. Reset cursor to default
    SIGHT_UI_API ~open_hand_cursor() override
    {
        set_default_cursor();
    }
};

class SIGHT_UI_CLASS_API closed_hand_cursor : public cursor
{
public:

    SIGHT_DECLARE_CLASS(closed_hand_cursor, cursor);

    /// Constructor. Sets cursor to "cross" state
    SIGHT_UI_API closed_hand_cursor()
    {
        set_cursor(state_t::closed_hand);
    }

    /// Destructor. Reset cursor to default
    SIGHT_UI_API ~closed_hand_cursor() override
    {
        set_default_cursor();
    }
};

} // namespace sight::ui