vcl/inc/osx/a11yfocustracker.hxx

   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 #ifndef INCLUDED_VCL_INC_OSX_A11YFOCUSTRACKER_HXX
  21 #define INCLUDED_VCL_INC_OSX_A11YFOCUSTRACKER_HXX
  22
  23 #include <com/sun/star/accessibility/XAccessible.hpp>
  24
  25 #include "keyboardfocuslistener.hxx"
  26
  27 #include <rtl/instance.hxx>
  28
  29 #include <tools/link.hxx>
  30 #include <vcl/vclevent.hxx>
  31 #include <set>
  32
  33 namespace vcl { class Window; }
  34 class ToolBox;
  35 class DocumentFocusListener;
  36
  37 // - AquaA11yFocusTracker -
  38
  39 class AquaA11yFocusTracker : public rtl::Static< AquaA11yFocusTracker, AquaA11yFocusTracker>
  40 {
  41
  42 public:
  43     AquaA11yFocusTracker();
  44
  45     ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > getFocusedObject() { return m_xFocusedObject; };
  46
  47     // sets the currently focus object and notifies the FocusEventListener (if any)
  48     void setFocusedObject(const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible >& xAccessible);
  49
  50     // may evolve to add/remove later
  51     void setFocusListener(const rtl::Reference< KeyboardFocusListener >& aFocusListener) { m_aFocusListener = aFocusListener; };
  52
  53 protected:
  54
  55     // received a WINDOW_GETFOCUS event for this window
  56     void window_got_focus(vcl::Window *pWindow);
  57
  58     // received a TOOLBOX_HIGHLIGHT event for this window
  59     void toolbox_highlight_on(vcl::Window *pWindow);
  60
  61     // received a TOOLBOX_HIGHLIGHTOFF event for this window
  62     void toolbox_highlight_off(vcl::Window *pWindow);
  63
  64     // received a TABPAGE_ACTIVATE event for this window
  65     void tabpage_activated(vcl::Window *pWindow);
  66
  67     // received a MENU_HIGHLIGHT event for this window
  68     void menu_highlighted(const ::VclMenuEvent *pEvent);
  69
  70     // toolbox items are widgets in gtk+ and Cocoa
  71     void notify_toolbox_item_focus(ToolBox *pToolBox);
  72
  73     // toolbox item opened a floating window (e.g. color chooser)
  74     void toolbox_open_floater(vcl::Window *pWindow);
  75
  76     // callback function for Application::addEventListener
  77     static sal_IntPtr WindowEventHandler(void * pThis, void * pCaller);
  78
  79 private:
  80     // the accessible object that has the keyboard focus (if any)
  81     ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > m_xFocusedObject;
  82
  83     // the listener for focus events
  84     rtl::Reference< KeyboardFocusListener > m_aFocusListener;
  85
  86     // the list of Windows that need deeper (focus) investigation
  87     std::set<VclPtr<vcl::Window>> m_aDocumentWindowList;
  88
  89     // the link object needed for Application::addEventListener
  90     Link<> m_aWindowEventLink;
  91
  92     // the UNO XAccessibilityEventListener for Documents and other non VCL objects
  93     const ::com::sun::star::uno::Reference< DocumentFocusListener > m_xDocumentFocusListener;
  94 };
  95
  96 #endif // INCLUDED_VCL_INC_OSX_A11YFOCUSTRACKER_HXX
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */