winaccessibility/inc/AccContainerEventListener.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 #pragma once
  21
  22 enum class UnoMSAAEvent;
  23
  24 #include <stdio.h>
  25 #include "AccEventListener.hxx"
  26 #include <com/sun/star/accessibility/XAccessibleEventListener.hpp>
  27 #include <com/sun/star/accessibility/XAccessible.hpp>
  28
  29
  30 /**
  31  * AccContainerEventListener is inherited from AccEventListener. It handles the events
  32  * generated by container controls. The accessible roles are: CANVAS, COMBO_BOX, DOCUMENT,
  33  * EMBEDDED_OBJECT, END_NOTE, FILLER, FOOTNOTE, FOOTER, GRAPHIC, HEADER, LAYERED_PANE,
  34  * MENU_BAR, POPUP_MENU, OPTION_PANE, PAGE_TAB, PAGE_TAB_LIST, PANEL, SCROLL_PANE, SPLIT_PANE,
  35  * STATUS_BAR, TABLE_CELL, TEXT_FRAME, TOOL_BAR, VIEW_PORT.
  36  * It defines the procedure of specific event handling related with containsers and provides
  37  * the detailed support for some related methods.
  38  */
  39 class AccContainerEventListener: public AccEventListener
  40 {
  41 public:
  42     AccContainerEventListener(css::accessibility::XAccessible* pAcc, AccObjectManagerAgent* Agent);
  43     virtual ~AccContainerEventListener() override;
  44
  45     //AccessibleEventListener
  46     virtual void SAL_CALL notifyEvent( const css::accessibility::AccessibleEventObject& aEvent ) override;
  47
  48     //for child changed event
  49     virtual void HandleChildChangedEvent(
  50             css::uno::Any oldValue, css::uno::Any newValue);
  51
  52     //for selection changed event
  53     virtual void HandleSelectionChangedEvent(
  54             const css::uno::Any &oldValue, const css::uno::Any &newValue);
  55
  56     //for all children changed event
  57     virtual void HandleAllChildrenChangedEvent();
  58
  59     //for text changed event
  60     virtual void HandleTextChangedEvent(
  61             css::uno::Any oldValue, css::uno::Any newValue);
  62     virtual void HandleStateChangedEvent(
  63             css::uno::Any oldValue, css::uno::Any newValue) override;
  64
  65     //for value changed event
  66     virtual void HandleValueChangedEvent(
  67             css::uno::Any oldValue, css::uno::Any newValue);
  68
  69     //state changed
  70     virtual void SetComponentState(sal_Int64 state, bool enable) override;
  71     virtual void FireStatePropertyChange(sal_Int64 state, bool set) override;
  72     virtual void FireStateFocusedChange(bool enable) override;
  73     virtual bool IsEditable(css::uno::Reference<css::accessibility::XAccessibleContext> const & xContext);
  74
  75     // update all children's state
  76     void UpdateAllChildrenState( css::accessibility::XAccessible* pXAccessible);
  77
  78     bool NotifyChildEvent(UnoMSAAEvent eWinEvent, const css::uno::Any& Value);
  79
  80     virtual void HandleSelectionChangedAddEvent(
  81             const css::uno::Any &oldValue, const css::uno::Any &newValue);
  82     virtual void HandleSelectionChangedRemoveEvent(
  83             const css::uno::Any &oldValue, const css::uno::Any &newValue);
  84     virtual void HandleSelectionChangedWithinEvent(
  85             const css::uno::Any &oldValue, const css::uno::Any &newValue);
  86
  87     virtual void HandlePageChangedEvent(
  88             const css::uno::Any &oldValue, const css::uno::Any &newValue);
  89
  90     virtual void HandleSectionChangedEvent(
  91             const css::uno::Any &oldValue, const css::uno::Any &newValue);
  92     virtual void HandleColumnChangedEvent(
  93             const css::uno::Any &oldValue, const css::uno::Any &newValue);
  94
  95     //for name changed event
  96     virtual void HandleNameChangedEvent(css::uno::Any name) override;
  97 };
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */