juce_MouseCursor.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  MouseCursor  final
{
public:
    //==============================================================================
    enum StandardCursorType
    {
        ParentCursor = 0,               
 
        NoCursor,                       
        NormalCursor,                   
 
        WaitCursor,                     
        IBeamCursor,                    
        CrosshairCursor,                
        CopyingCursor,                  
 
        PointingHandCursor,             
        DraggingHandCursor,             
 
        LeftRightResizeCursor,          
        UpDownResizeCursor,             
        UpDownLeftRightResizeCursor,    
 
        TopEdgeResizeCursor,            
        BottomEdgeResizeCursor,         
        LeftEdgeResizeCursor,           
        RightEdgeResizeCursor,          
        TopLeftCornerResizeCursor,      
        TopRightCornerResizeCursor,     
        BottomLeftCornerResizeCursor,   
        BottomRightCornerResizeCursor,  
 
        NumStandardCursorTypes
    };
 
    //==============================================================================
    MouseCursor() noexcept;

    MouseCursor (StandardCursorType);

    MouseCursor (const Image& image, int hotSpotX, int hotSpotY);

    MouseCursor (const Image& image, int hotSpotX, int hotSpotY, float scaleFactor);

    MouseCursor (const ScaledImage& image, Point<int> hotSpot);
 
    //==============================================================================
    MouseCursor (const MouseCursor&);

    MouseCursor& operator= (const MouseCursor&);

    ~MouseCursor();

    MouseCursor (MouseCursor&&) noexcept;

    MouseCursor& operator= (MouseCursor&&) noexcept;

    bool operator== (const MouseCursor&) const noexcept;

    bool operator!= (const MouseCursor&) const noexcept;

    bool operator== (StandardCursorType type) const noexcept;

    bool operator!= (StandardCursorType type) const noexcept;
 
    //==============================================================================
    static void showWaitCursor();

    static void hideWaitCursor();
 
 
private:
    //==============================================================================
    class SharedCursorHandle;
    std::shared_ptr<SharedCursorHandle> cursorHandle;
 
    class PlatformSpecificHandle;
 
    friend class MouseInputSourceInternal;
    void showInWindow (ComponentPeer*) const;
    PlatformSpecificHandle* getHandle() const noexcept;
 
    JUCE_LEAK_DETECTOR (MouseCursor)
};
 
} // namespace juce