juce_Desktop.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  FocusChangeListener
{
public:
    virtual ~FocusChangeListener() = default;

    virtual void globalFocusChanged (Component* focusedComponent) = 0;
};
 
//==============================================================================
class JUCE_API  DarkModeSettingListener
{
public:
    virtual ~DarkModeSettingListener() = default;

    virtual void darkModeSettingChanged() = 0;
};
 
//==============================================================================
class JUCE_API  Desktop  : private DeletedAtShutdown,
                           private Timer,
                           private AsyncUpdater
{
public:
    //==============================================================================
    static Desktop& JUCE_CALLTYPE getInstance();
 
    //==============================================================================
    static Point<int> getMousePosition();

    static void setMousePosition (Point<int> newPosition);

    static Point<int> getLastMouseDownPosition();

    int getMouseButtonClickCounter() const noexcept;

    int getMouseWheelMoveCounter() const noexcept;
 
    //==============================================================================
    static void setScreenSaverEnabled (bool isEnabled);

    static bool isScreenSaverEnabled();
 
    //==============================================================================
    void addGlobalMouseListener (MouseListener* listener);

    void removeGlobalMouseListener (MouseListener* listener);
 
    //==============================================================================
    void addFocusChangeListener (FocusChangeListener* listener);

    void removeFocusChangeListener (FocusChangeListener* listener);
 
    //==============================================================================
    void addDarkModeSettingListener (DarkModeSettingListener* listener);

    void removeDarkModeSettingListener (DarkModeSettingListener* listener);

    bool isDarkModeActive() const;
 
    //==============================================================================
    void setKioskModeComponent (Component* componentToUse,
                                bool allowMenusAndBars = true);

    Component* getKioskModeComponent() const noexcept               { return kioskModeComponent; }
 
    //==============================================================================
    int getNumComponents() const noexcept;

    Component* getComponent (int index) const noexcept;

    Component* findComponentAt (Point<int> screenPosition) const;

    ComponentAnimator& getAnimator() noexcept                       { return animator; }
 
    //==============================================================================
    LookAndFeel& getDefaultLookAndFeel() noexcept;

    void setDefaultLookAndFeel (LookAndFeel* newDefaultLookAndFeel);
 
    //==============================================================================
    const Array<MouseInputSource>& getMouseSources() const noexcept;

    int getNumMouseSources() const noexcept;

    MouseInputSource* getMouseSource (int index) const noexcept;

    MouseInputSource getMainMouseSource() const noexcept;

    int getNumDraggingMouseSources() const noexcept;

    MouseInputSource* getDraggingMouseSource (int index) const noexcept;

    void beginDragAutoRepeat (int millisecondsBetweenCallbacks);
 
    //==============================================================================
    enum DisplayOrientation
    {
        upright                 = 1,  
        upsideDown              = 2,  
        rotatedClockwise        = 4,  
        rotatedAntiClockwise    = 8,  
 
        allOrientations         = 1 + 2 + 4 + 8   
    };

    DisplayOrientation getCurrentOrientation() const;

    void setOrientationsEnabled (int allowedOrientations);

    int getOrientationsEnabled() const noexcept;

    bool isOrientationEnabled (DisplayOrientation orientation) const noexcept;
 
    //==============================================================================
    const Displays& getDisplays() const noexcept        { return *displays; }
 
    //==============================================================================
    void setGlobalScaleFactor (float newScaleFactor) noexcept;

    float getGlobalScaleFactor() const noexcept         { return masterScaleFactor; }
 
    //==============================================================================
    static bool canUseSemiTransparentWindows() noexcept;
 
   #if JUCE_MAC && ! defined (DOXYGEN)
    [[deprecated ("This macOS-specific method has been deprecated in favour of the cross-platform "
                  " isDarkModeActive() method.")]]
    static bool isOSXDarkModeActive()  { return Desktop::getInstance().isDarkModeActive(); }
   #endif
 
    //==============================================================================
    bool isHeadless() const noexcept;
 
private:
    //==============================================================================
    static Desktop* instance;
 
    friend class Component;
    friend class ComponentPeer;
    friend class MouseInputSourceInternal;
    friend class DeletedAtShutdown;
    friend class TopLevelWindowManager;
    friend class Displays;
 
    std::unique_ptr<MouseInputSource::SourceList> mouseSources;
 
    ListenerList<MouseListener> mouseListeners;
    ListenerList<FocusChangeListener> focusListeners;
    ListenerList<DarkModeSettingListener> darkModeSettingListeners;
 
    Array<Component*> desktopComponents;
    Array<ComponentPeer*> peers;
 
    std::unique_ptr<Displays> displays;
 
    Point<float> lastFakeMouseMove;
    void sendMouseMove();
 
    int mouseClickCounter = 0, mouseWheelCounter = 0;
    void incrementMouseClickCounter() noexcept;
    void incrementMouseWheelCounter() noexcept;
 
    std::unique_ptr<LookAndFeel> defaultLookAndFeel;
    WeakReference<LookAndFeel> currentLookAndFeel;
 
    std::unique_ptr<FocusOutline> focusOutline;
 
    Component* kioskModeComponent = nullptr;
    Rectangle<int> kioskComponentOriginalBounds;
    bool kioskModeReentrant = false;
 
    int allowedOrientations = allOrientations;
    void allowedOrientationsChanged();
 
    float masterScaleFactor;
 
    ComponentAnimator animator;
 
    void timerCallback() override;
    void resetTimer();
    ListenerList<MouseListener>& getMouseListeners();
 
    void addDesktopComponent (Component*);
    void removeDesktopComponent (Component*);
    void componentBroughtToFront (Component*);
 
    void setKioskComponent (Component*, bool shouldBeEnabled, bool allowMenusAndBars);
 
    void triggerFocusCallback();
    void updateFocusOutline();
    void handleAsyncUpdate() override;
 
    static Point<float> getMousePositionFloat();
 
    static double getDefaultMasterScale();
 
    Desktop();
    ~Desktop() override;
 
    //==============================================================================
    class NativeDarkModeChangeDetectorImpl;
    std::unique_ptr<NativeDarkModeChangeDetectorImpl> nativeDarkModeChangeDetectorImpl;
 
    static std::unique_ptr<NativeDarkModeChangeDetectorImpl> createNativeDarkModeChangeDetectorImpl();
    void darkModeChanged();
 
    //==============================================================================
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Desktop)
};
 
} // namespace juce