Cursor.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#pragma once

// Headers
#include <SFML/Window/Export.hpp>
 
#include <SFML/System/Vector2.hpp>
 
#include <memory>
#include <optional>
 
#include <cstdint>
 
namespace sf
{
namespace priv
{
class CursorImpl;
}

class SFML_WINDOW_API Cursor
{
public:
    enum class Type
    {
        Arrow,                  
        ArrowWait,              
        Wait,                   
        Text,                   
        Hand,                   
        SizeHorizontal,         
        SizeVertical,           
        SizeTopLeftBottomRight, 
        SizeBottomLeftTopRight, 
        SizeLeft,               
        SizeRight,              
        SizeTop,                
        SizeBottom,             
        SizeTopLeft,            
        SizeBottomRight, 
        SizeBottomLeft,  
        SizeTopRight,    
        SizeAll,         
        Cross,           
        Help,            
        NotAllowed       
    };

    ~Cursor();

    Cursor(const Cursor&) = delete;

    Cursor& operator=(const Cursor&) = delete;

    Cursor(Cursor&&) noexcept;

    Cursor& operator=(Cursor&&) noexcept;

    Cursor(const std::uint8_t* pixels, Vector2u size, Vector2u hotspot);

    explicit Cursor(Type type);

    [[nodiscard]] static std::optional<Cursor> createFromPixels(const std::uint8_t* pixels, Vector2u size, Vector2u hotspot);

    [[nodiscard]] static std::optional<Cursor> createFromSystem(Type type);
 
private:
    friend class WindowBase;

    Cursor();

    [[nodiscard]] const priv::CursorImpl& getImpl() const;

    // Member data
    std::unique_ptr<priv::CursorImpl> m_impl; 
};
 
} // namespace sf