juce_MouseCursor.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE 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 General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_MOUSECURSOR_H_INCLUDED
#define JUCE_MOUSECURSOR_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  MouseCursor
{
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 MouseCursor&);
 
    MouseCursor& operator= (const MouseCursor&);
 
    ~MouseCursor();
 
   #if JUCE_COMPILER_SUPPORTS_MOVE_SEMANTICS
    MouseCursor (MouseCursor&&) noexcept;
    MouseCursor& operator= (MouseCursor&&) noexcept;
   #endif
 
    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;
    friend class SharedCursorHandle;
    SharedCursorHandle* cursorHandle;
 
    friend class MouseInputSourceInternal;
    void showInWindow (ComponentPeer* window) const;
    void showInAllWindows() const;
    void* getHandle() const noexcept;
 
    static void* createStandardMouseCursor (MouseCursor::StandardCursorType type);
    static void deleteMouseCursor (void* cursorHandle, bool isStandard);
 
    JUCE_LEAK_DETECTOR (MouseCursor)
};
 
#endif   // JUCE_MOUSECURSOR_H_INCLUDED