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