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/vclxaccessiblecomponent.hxx>
  24 #include <toolkit/awt/vclxwindow.hxx>
  25
  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 pAccessible      the accessible of the new opened window
  40  */
  41 void AccTopWindowListener::HandleWindowOpened( css::accessibility::XAccessible* pAccessible )
  42 {
  43     //get SystemData from window
  44     VclPtr<vcl::Window> window;
  45     if (auto pvclwindow = dynamic_cast<VCLXWindow*>(pAccessible))
  46         window = pvclwindow->GetWindow();
  47     else if (auto pvclxcomponent = dynamic_cast<VCLXAccessibleComponent*>(pAccessible))
  48         window = pvclxcomponent->GetWindow();
  49     assert(window);
  50     // The SalFrame of window may be destructed at this time
  51     const SystemEnvData* systemdata = nullptr;
  52     try
  53     {
  54         systemdata = window->GetSystemData();
  55     }
  56     catch(...)
  57     {
  58         systemdata = nullptr;
  59     }
  60     Reference<css::accessibility::XAccessibleContext> xContext = pAccessible->getAccessibleContext();
  61     if(!xContext.is())
  62         return;
  63
  64     css::accessibility::XAccessibleContext* pAccessibleContext = xContext.get();
  65     //Only AccessibleContext exist, add all listeners
  66     if(pAccessibleContext != nullptr && systemdata != nullptr)
  67     {
  68         accManagerAgent.SaveTopWindowHandle(
  69                 reinterpret_cast<sal_Int64>(systemdata->hWnd), pAccessible);
  70
  71         AddAllListeners(pAccessible,nullptr,systemdata->hWnd);
  72
  73         if( window->GetStyle() & WB_MOVEABLE )
  74             accManagerAgent.IncreaseState( pAccessible, static_cast<unsigned short>(-1) /* U_MOVEBLE */ );
  75
  76         short role = pAccessibleContext->getAccessibleRole();
  77
  78         if (role == css::accessibility::AccessibleRole::POPUP_MENU ||
  79                 role == css::accessibility::AccessibleRole::MENU )
  80         {
  81             accManagerAgent.NotifyAccEvent(UM_EVENT_MENUPOPUPSTART, pAccessible);
  82         }
  83
  84         if (role == css::accessibility::AccessibleRole::FRAME ||
  85                 role == css::accessibility::AccessibleRole::DIALOG ||
  86                 role == css::accessibility::AccessibleRole::WINDOW ||
  87                 role == css::accessibility::AccessibleRole::ALERT)
  88         {
  89             accManagerAgent.NotifyAccEvent(UM_EVENT_SHOW, pAccessible);
  90         }
  91     }
  92 }
  93
  94 AccTopWindowListener::AccTopWindowListener()
  95     : accManagerAgent()
  96 {
  97 }
  98
  99 AccTopWindowListener::~AccTopWindowListener()
 100 {
 101 }
 102
 103 /**
 104  *  It is invoked when a new window is opened, the source of this EventObject is the window
 105  */
 106 void AccTopWindowListener::windowOpened( const css::lang::EventObject& e )
 107 {
 108     SAL_INFO( "iacc2", "windowOpened triggered" );
 109
 110     if ( !e.Source.is())
 111         return;
 112
 113     Reference< css::accessibility::XAccessible > xAccessible ( e.Source, UNO_QUERY );
 114     css::accessibility::XAccessible* pAccessible = xAccessible.get();
 115     if ( !pAccessible )
 116         return;
 117
 118     SolarMutexGuard g;
 119
 120     HandleWindowOpened( pAccessible );
 121 }
 122
 123 /**
 124  *  Add the accessible event listener to object and all its children objects.
 125  *  @param  pAccessible     the accessible object
 126  *  @param  pParentXAcc     the parent of current accessible object
 127  *  @param  pWND            the handle of top window which current object resides
 128  */
 129 void AccTopWindowListener::AddAllListeners(css::accessibility::XAccessible* pAccessible, css::accessibility::XAccessible* pParentXAcc, HWND pWND)
 130 {
 131     Reference<css::accessibility::XAccessibleContext> xContext = pAccessible->getAccessibleContext();
 132     if(!xContext.is())
 133     {
 134         return;
 135     }
 136     css::accessibility::XAccessibleContext* pAccessibleContext = xContext.get();
 137     if(pAccessibleContext == nullptr)
 138     {
 139         return;
 140     }
 141
 142     accManagerAgent.InsertAccObj(pAccessible, pParentXAcc,
 143             reinterpret_cast<sal_Int64>(pWND));
 144
 145     if (!accManagerAgent.IsContainer(pAccessible))
 146     {
 147         return;
 148     }
 149
 150
 151     short role = pAccessibleContext->getAccessibleRole();
 152     if(css::accessibility::AccessibleRole::DOCUMENT == role ||
 153             css::accessibility::AccessibleRole::DOCUMENT_PRESENTATION == role ||
 154             css::accessibility::AccessibleRole::DOCUMENT_SPREADSHEET == role ||
 155             css::accessibility::AccessibleRole::DOCUMENT_TEXT == role)
 156     {
 157         if(accManagerAgent.IsStateManageDescendant(pAccessible))
 158         {
 159             return ;
 160         }
 161     }
 162
 163
 164     int count = pAccessibleContext->getAccessibleChildCount();
 165     for (int i=0;i<count;i++)
 166     {
 167         Reference<css::accessibility::XAccessible> mxAccessible
 168         = pAccessibleContext->getAccessibleChild(i);
 169
 170         css::accessibility::XAccessible* mpAccessible = mxAccessible.get();
 171         if(mpAccessible != nullptr)
 172         {
 173             Reference<css::accessibility::XAccessibleContext> mxAccessibleContext
 174             = mpAccessible->getAccessibleContext();
 175             css::accessibility::XAccessibleContext* mpContext = mxAccessibleContext.get();
 176             if(mpContext != nullptr)
 177                 AddAllListeners( mpAccessible, pAccessible, pWND);
 178         }
 179     }
 180 }
 181
 182 void AccTopWindowListener::windowClosing( const css::lang::EventObject& )
 183 {
 184     SAL_INFO( "iacc2", "windowClosing triggered" );
 185 }
 186
 187 /**
 188  *  Invoke this method when the top window is closed, remove all the objects and its children
 189  *  from current manager's cache, and remove the COM object and the accessible event listener
 190  *  assigned to the accessible objects.
 191  */
 192 void AccTopWindowListener::windowClosed( const css::lang::EventObject& e )
 193 {
 194     SAL_INFO( "iacc2", "windowClosed triggered" );
 195
 196     if ( !e.Source.is())
 197         return;
 198
 199     Reference< css::accessibility::XAccessible > xAccessible ( e.Source, UNO_QUERY );
 200     css::accessibility::XAccessible* pAccessible = xAccessible.get();
 201     if ( pAccessible == nullptr)
 202         return;
 203
 204     Reference<css::accessibility::XAccessibleContext> xContext = pAccessible->getAccessibleContext();
 205     if(!xContext.is())
 206     {
 207         return;
 208     }
 209     css::accessibility::XAccessibleContext* pAccessibleContext = xContext.get();
 210
 211     short role = -1;
 212     if(pAccessibleContext != nullptr)
 213     {
 214         role = pAccessibleContext->getAccessibleRole();
 215
 216         if (role == css::accessibility::AccessibleRole::POPUP_MENU ||
 217                 role == css::accessibility::AccessibleRole::MENU)
 218         {
 219             accManagerAgent.NotifyAccEvent(UM_EVENT_MENUPOPUPEND, pAccessible);
 220         }
 221     }
 222
 223
 224     accManagerAgent.DeleteChildrenAccObj( pAccessible );
 225     if( role != css::accessibility::AccessibleRole::POPUP_MENU )
 226         accManagerAgent.DeleteAccObj( pAccessible );
 227
 228 }
 229
 230 void AccTopWindowListener::windowMinimized( const css::lang::EventObject& )
 231 {
 232 }
 233
 234 void AccTopWindowListener::windowNormalized( const css::lang::EventObject& )
 235 {
 236 }
 237
 238 void AccTopWindowListener::windowActivated( const css::lang::EventObject& )
 239 {
 240 }
 241
 242 void AccTopWindowListener::windowDeactivated( const css::lang::EventObject& )
 243 {
 244 }
 245
 246 void AccTopWindowListener::disposing( const css::lang::EventObject&  )
 247 {
 248 }
 249
 250 sal_Int64 AccTopWindowListener::GetMSComPtr(
 251         sal_Int64 hWnd, sal_Int64 lParam, sal_Int64 wParam)
 252 {
 253     return accManagerAgent.Get_ToATInterface(hWnd, lParam, wParam);
 254 }
 255
 256 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */