source/modules/juce_gui_basics/native/accessibility/juce_win32_UIAWindowProvider.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library.
   5    Copyright (c) 2022 - Raw Material Software Limited
   6
   7    JUCE is an open source library subject to commercial or open-source
   8    licensing.
   9
  10    By using JUCE, you agree to the terms of both the JUCE 7 End-User License
  11    Agreement and JUCE Privacy Policy.
  12
  13    End User License Agreement: www.juce.com/juce-7-licence
  14    Privacy Policy: www.juce.com/juce-privacy-policy
  15
  16    Or: You may also use this code under the terms of the GPL v3 (see
  17    www.gnu.org/licenses).
  18
  19    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
  20    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
  21    DISCLAIMED.
  22
  23   ==============================================================================
  24 */
  25
  26 namespace juce
  27 {
  28
  29 //==============================================================================
  30 class UIAWindowProvider : public UIAProviderBase,
  31                           public ComBaseClassHelper<ComTypes::IWindowProvider>
  32 {
  33 public:
  34     using UIAProviderBase::UIAProviderBase;
  35
  36     //==============================================================================
  37     JUCE_COMRESULT SetVisualState (ComTypes::WindowVisualState state) override
  38     {
  39         if (! isElementValid())
  40             return (HRESULT) UIA_E_ELEMENTNOTAVAILABLE;
  41
  42         if (auto* peer = getPeer())
  43         {
  44             switch (state)
  45             {
  46                 case ComTypes::WindowVisualState_Maximized:
  47                     peer->setFullScreen (true);
  48                     break;
  49
  50                 case ComTypes::WindowVisualState_Minimized:
  51                     peer->setMinimised (true);
  52                     break;
  53
  54                 case ComTypes::WindowVisualState_Normal:
  55                     peer->setFullScreen (false);
  56                     peer->setMinimised (false);
  57                     break;
  58
  59                 default:
  60                     break;
  61             }
  62
  63             return S_OK;
  64         }
  65
  66         return (HRESULT) UIA_E_NOTSUPPORTED;
  67     }
  68
  69     JUCE_COMRESULT Close() override
  70     {
  71         if (! isElementValid())
  72             return (HRESULT) UIA_E_ELEMENTNOTAVAILABLE;
  73
  74         if (auto* peer = getPeer())
  75         {
  76             peer->handleUserClosingWindow();
  77             return S_OK;
  78         }
  79
  80         return (HRESULT) UIA_E_NOTSUPPORTED;
  81     }
  82
  83     JUCE_COMRESULT WaitForInputIdle (int, BOOL* pRetVal) override
  84     {
  85         return withCheckedComArgs (pRetVal, *this, []
  86         {
  87             return (HRESULT) UIA_E_NOTSUPPORTED;
  88         });
  89     }
  90
  91     JUCE_COMRESULT get_CanMaximize (BOOL* pRetVal) override
  92     {
  93         return withCheckedComArgs (pRetVal, *this, [&]() -> HRESULT
  94         {
  95             if (auto* peer = getPeer())
  96             {
  97                 *pRetVal = (peer->getStyleFlags() & ComponentPeer::windowHasMaximiseButton) != 0;
  98                 return S_OK;
  99             }
 100
 101             return (HRESULT) UIA_E_NOTSUPPORTED;
 102         });
 103     }
 104
 105     JUCE_COMRESULT get_CanMinimize (BOOL* pRetVal) override
 106     {
 107         return withCheckedComArgs (pRetVal, *this, [&]() -> HRESULT
 108         {
 109             if (auto* peer = getPeer())
 110             {
 111                 *pRetVal = (peer->getStyleFlags() & ComponentPeer::windowHasMinimiseButton) != 0;
 112                 return S_OK;
 113             }
 114
 115             return (HRESULT) UIA_E_NOTSUPPORTED;
 116         });
 117     }
 118
 119     JUCE_COMRESULT get_IsModal (BOOL* pRetVal) override
 120     {
 121         return withCheckedComArgs (pRetVal, *this, [&]() -> HRESULT
 122         {
 123             if (auto* peer = getPeer())
 124             {
 125                 *pRetVal = peer->getComponent().isCurrentlyModal();
 126                 return S_OK;
 127             }
 128
 129             return (HRESULT) UIA_E_NOTSUPPORTED;
 130         });
 131     }
 132
 133     JUCE_COMRESULT get_WindowVisualState (ComTypes::WindowVisualState* pRetVal) override
 134     {
 135         return withCheckedComArgs (pRetVal, *this, [&]() -> HRESULT
 136         {
 137             if (auto* peer = getPeer())
 138             {
 139                 if (peer->isFullScreen())
 140                     *pRetVal = ComTypes::WindowVisualState_Maximized;
 141                 else if (peer->isMinimised())
 142                     *pRetVal = ComTypes::WindowVisualState_Minimized;
 143                 else
 144                     *pRetVal = ComTypes::WindowVisualState_Normal;
 145
 146                 return S_OK;
 147             }
 148
 149             return (HRESULT) UIA_E_NOTSUPPORTED;
 150         });
 151     }
 152
 153     JUCE_COMRESULT get_WindowInteractionState (ComTypes::WindowInteractionState* pRetVal) override
 154     {
 155         return withCheckedComArgs (pRetVal, *this, [&]() -> HRESULT
 156         {
 157             if (auto* peer = getPeer())
 158             {
 159                 *pRetVal = peer->getComponent().isCurrentlyBlockedByAnotherModalComponent()
 160                     ? ComTypes::WindowInteractionState::WindowInteractionState_BlockedByModalWindow
 161                     : ComTypes::WindowInteractionState::WindowInteractionState_Running;
 162
 163                 return S_OK;
 164             }
 165
 166             return (HRESULT) UIA_E_NOTSUPPORTED;
 167         });
 168     }
 169
 170     JUCE_COMRESULT get_IsTopmost (BOOL* pRetVal) override
 171     {
 172         return withCheckedComArgs (pRetVal, *this, [&]() -> HRESULT
 173         {
 174             if (auto* peer = getPeer())
 175             {
 176                 *pRetVal = peer->isFocused();
 177                 return S_OK;
 178             }
 179
 180             return (HRESULT) UIA_E_NOTSUPPORTED;
 181         });
 182     }
 183
 184 private:
 185     ComponentPeer* getPeer() const
 186     {
 187         return getHandler().getComponent().getPeer();
 188     }
 189
 190     //==============================================================================
 191     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (UIAWindowProvider)
 192 };
 193
 194 } // namespace juce