winaccessibility/source/service/AccTopWindowListener.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 #include <sal/log.hxx>
  22 #include <vcl/window.hxx>
  23 #include <toolkit/awt/vclxwindow.hxx>
  24
  25 #include <vcl/accessibility/vclxaccessiblecomponent.hxx>
  26 #include <vcl/sysdata.hxx>
  27 #include <vcl/svapp.hxx>
  28
  29 #include <AccTopWindowListener.hxx>
  30 #include <unomsaaevent.hxx>
  31
  32 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  33
  34 using namespace com::sun::star::uno;
  35
  36 /**
  37  *  For the new opened window, generate all the UNO accessible's object, COM object and add
  38  *  accessible listener to monitor all these objects.
  39  *  @param pWindow      the new opened window
  40  */
  41 void AccTopWindowListener::HandleWindowOpened(vcl::Window* pWindow)
  42 {
  43     assert(pWindow);
  44
  45     const SystemEnvData* pSystemData = pWindow->GetSystemData();
  46     if (!pSystemData)
  47         return;
  48
  49     Reference<css::accessibility::XAccessible> xAccessible = pWindow->GetAccessible();
  50     if (!xAccessible.is())
  51         return;
  52
  53     Reference<css::accessibility::XAccessibleContext> xContext = xAccessible->getAccessibleContext();
  54     if(!xContext.is())
  55         return;
  56
  57     // add all listeners
  58     m_aAccObjectManager.SaveTopWindowHandle(pSystemData->hWnd, xAccessible.get());
  59
  60     AddAllListeners(xAccessible.get(), nullptr, pSystemData->hWnd);
  61
  62     if (pWindow->GetStyle() & WB_MOVEABLE)
  63         m_aAccObjectManager.IncreaseState(xAccessible.get(), static_cast<unsigned short>(-1) /* U_MOVEBLE */ );
  64
  65     short role = xContext->getAccessibleRole();
  66
  67     if (role == css::accessibility::AccessibleRole::POPUP_MENU ||
  68             role == css::accessibility::AccessibleRole::MENU )
  69     {
  70         m_aAccObjectManager.NotifyAccEvent(xAccessible.get(), UnoMSAAEvent::MENUPOPUPSTART);
  71     }
  72
  73     if (role == css::accessibility::AccessibleRole::FRAME ||
  74             role == css::accessibility::AccessibleRole::DIALOG ||
  75             role == css::accessibility::AccessibleRole::WINDOW ||
  76             role == css::accessibility::AccessibleRole::ALERT)
  77     {
  78         m_aAccObjectManager.NotifyAccEvent(xAccessible.get(), UnoMSAAEvent::SHOW);
  79     }
  80 }
  81
  82 AccTopWindowListener::AccTopWindowListener()
  83     : m_aAccObjectManager()
  84 {
  85 }
  86
  87 AccTopWindowListener::~AccTopWindowListener()
  88 {
  89 }
  90
  91 /**
  92  *  It is invoked when a new window is opened, the source of this EventObject is the window
  93  */
  94 void AccTopWindowListener::windowOpened( const css::lang::EventObject& e )
  95 {
  96     SAL_INFO( "iacc2", "windowOpened triggered" );
  97
  98     if ( !e.Source.is())
  99         return;
 100
 101     SolarMutexGuard g;
 102
 103     VCLXWindow* pVCLXWindow = dynamic_cast<VCLXWindow*>(e.Source.get());
 104     assert(pVCLXWindow && "Window is not a VCLXWindow");
 105
 106     vcl::Window* pWindow = pVCLXWindow->GetWindow();
 107     assert(pWindow);
 108
 109     HandleWindowOpened(pWindow);
 110 }
 111
 112 /**
 113  *  Add the accessible event listener to object and all its children objects.
 114  *  @param  pAccessible     the accessible object
 115  *  @param  pParentXAcc     the parent of current accessible object
 116  *  @param  pWND            the handle of top window which current object resides
 117  */
 118 void AccTopWindowListener::AddAllListeners(css::accessibility::XAccessible* pAccessible, css::accessibility::XAccessible* pParentXAcc, HWND pWND)
 119 {
 120     Reference<css::accessibility::XAccessibleContext> xContext = pAccessible->getAccessibleContext();
 121     if(!xContext.is())
 122     {
 123         return;
 124     }
 125
 126     m_aAccObjectManager.InsertAccObj(pAccessible, pParentXAcc, pWND);
 127
 128     if (!AccObjectWinManager::IsContainer(pAccessible))
 129     {
 130         return;
 131     }
 132
 133
 134     short role = xContext->getAccessibleRole();
 135     if(css::accessibility::AccessibleRole::DOCUMENT == role ||
 136             css::accessibility::AccessibleRole::DOCUMENT_PRESENTATION == role ||
 137             css::accessibility::AccessibleRole::DOCUMENT_SPREADSHEET == role ||
 138             css::accessibility::AccessibleRole::DOCUMENT_TEXT == role)
 139     {
 140         if(AccObjectWinManager::IsStateManageDescendant(pAccessible))
 141         {
 142             return ;
 143         }
 144     }
 145
 146     sal_Int64 nCount = xContext->getAccessibleChildCount();
 147     for (sal_Int64 i = 0; i < nCount; i++)
 148     {
 149         Reference<css::accessibility::XAccessible> xAccessible
 150             = xContext->getAccessibleChild(i);
 151
 152         if (xAccessible.is())
 153             AddAllListeners(xAccessible.get(), pAccessible, pWND);
 154     }
 155 }
 156
 157 void AccTopWindowListener::windowClosing( const css::lang::EventObject& )
 158 {
 159     SAL_INFO( "iacc2", "windowClosing triggered" );
 160 }
 161
 162 /**
 163  *  Invoke this method when the top window is closed, remove all the objects and its children
 164  *  from current manager's cache, and remove the COM object and the accessible event listener
 165  *  assigned to the accessible objects.
 166  */
 167 void AccTopWindowListener::windowClosed( const css::lang::EventObject& e )
 168 {
 169     SAL_INFO( "iacc2", "windowClosed triggered" );
 170
 171     if ( !e.Source.is())
 172         return;
 173
 174     VCLXWindow* pVCLXWindow = dynamic_cast<VCLXWindow*>(e.Source.get());
 175     assert(pVCLXWindow && "Window is not a VCLXWindow");
 176
 177     vcl::Window* pWindow = pVCLXWindow->GetWindow();
 178     assert(pWindow);
 179
 180     Reference<css::accessibility::XAccessible> xAccessible = pWindow->GetAccessible();
 181     if (!xAccessible.is())
 182         return;
 183
 184     Reference<css::accessibility::XAccessibleContext> xContext = xAccessible->getAccessibleContext();
 185     if(!xContext.is())
 186         return;
 187
 188     short role = xContext->getAccessibleRole();
 189     if (role == css::accessibility::AccessibleRole::POPUP_MENU ||
 190             role == css::accessibility::AccessibleRole::MENU)
 191     {
 192         m_aAccObjectManager.NotifyAccEvent(xAccessible.get(), UnoMSAAEvent::MENUPOPUPEND);
 193     }
 194
 195     m_aAccObjectManager.DeleteChildrenAccObj(xAccessible.get());
 196     if( role != css::accessibility::AccessibleRole::POPUP_MENU )
 197         m_aAccObjectManager.DeleteAccObj(xAccessible.get());
 198 }
 199
 200 void AccTopWindowListener::windowMinimized( const css::lang::EventObject& )
 201 {
 202 }
 203
 204 void AccTopWindowListener::windowNormalized( const css::lang::EventObject& )
 205 {
 206 }
 207
 208 void AccTopWindowListener::windowActivated( const css::lang::EventObject& )
 209 {
 210 }
 211
 212 void AccTopWindowListener::windowDeactivated( const css::lang::EventObject& )
 213 {
 214 }
 215
 216 void AccTopWindowListener::disposing( const css::lang::EventObject&  )
 217 {
 218 }
 219
 220 sal_Int64 AccTopWindowListener::GetMSComPtr(
 221         sal_Int64 hWnd, sal_Int64 lParam, sal_Int64 wParam)
 222 {
 223     return m_aAccObjectManager.Get_ToATInterface(hWnd, lParam, wParam);
 224 }
 225
 226 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */