winaccessibility/inc/AccObject.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_ACCOBJECT_HXX
  21 #define INCLUDED_WINACCESSIBILITY_INC_ACCOBJECT_HXX
  22
  23 #include <vector>
  24 #include <map>
  25 #include <oleacc.h>
  26 #include <windows.h>
  27
  28 #include <rtl/ref.hxx>
  29
  30 #include <com/sun/star/accessibility/XAccessible.hpp>
  31 #include <com/sun/star/accessibility/XAccessibleSelection.hpp>
  32 #include <com/sun/star/accessibility/XAccessibleAction.hpp>
  33
  34 #include "accHelper.hxx"
  35 #include  "UAccCOM.h"
  36
  37 class AccEventListener;
  38 class AccObjectManagerAgent;
  39 class AccObject;
  40
  41 typedef std::map<const long, AccObject*> IAccSelectionList;
  42 typedef std::vector<AccObject *> IAccChildList;
  43
  44
  45 class AccObject
  46 {
  47 private:
  48
  49     short               m_accRole;
  50     long                m_resID;
  51     HWND                m_pParantID;
  52     sal_Bool                m_bShouldDestroy; //avoid access COM interface when acc object is deleted
  53     IMAccessible*       m_pIMAcc;
  54     AccObject*          m_pParentObj;
  55     IAccChildList       m_childrenList;
  56     ::rtl::Reference<AccEventListener>  m_pListener;
  57     IAccSelectionList   m_selectionList;
  58
  59     ::com::sun::star::uno::Reference < ::com::sun::star::accessibility::XAccessible > m_xAccRef;
  60     ::com::sun::star::uno::Reference < ::com::sun::star::accessibility::XAccessibleAction > m_xAccActionRef;
  61     ::com::sun::star::uno::Reference < ::com::sun::star::accessibility::XAccessibleContext > m_xAccContextRef;
  62
  63     void ImplInitializeCreateObj();//create COM object
  64
  65     void UpdateActionDesc();
  66     void UpdateRole();
  67
  68     DWORD GetMSAAStateFromUNO(short xState);//translate state from UNO to MSAA value
  69     ::com::sun::star::accessibility::XAccessibleSelection* GetXAccessibleSelection();
  70     void GetExpandedState(sal_Bool* isExpandable, sal_Bool* isExpanded);
  71     ::rtl::OUString GetMAccessibleValueFromAny(::com::sun::star::uno::Any pAny);
  72
  73 public:
  74
  75     AccObject ( ::com::sun::star::accessibility::XAccessible* pXAcc = NULL,AccObjectManagerAgent* pAgent = NULL ,AccEventListener* accListener=NULL);
  76     virtual ~AccObject();
  77
  78     sal_Bool UpdateAccessibleInfoFromUnoToMSAA(  ); //implement accessible information mapping
  79     void UpdateDefaultAction();
  80
  81     IMAccessible*  GetIMAccessible();   //return COM interface in acc object
  82     ::com::sun::star::uno::Reference<
  83         ::com::sun::star::accessibility::XAccessible> const& GetXAccessible();
  84
  85     void SetResID(long id);//ResID means ChildID in MSAA
  86     long GetResID();
  87
  88
  89     void SetParentHWND(HWND hWnd);//need to set top window handle when send event to AT
  90     HWND GetParentHWND();
  91
  92     void SetListener(::rtl::Reference<AccEventListener> const& pListener);
  93     AccEventListener* getListener();
  94
  95     void SetParentObj(AccObject* pParentAccObj);
  96     AccObject* GetParentObj();
  97
  98     void InsertChild( AccObject* pChild,short pos = LAST_CHILD);
  99     void DeleteChild( AccObject* pChild );
 100     AccObject* NextChild();
 101
 102     void NotifyDestroy(sal_Bool ifDelete);
 103     sal_Bool  ifShouldDestroy();
 104
 105     void  DecreaseState(short xState );//call COM interface DecreaseState method
 106     void  IncreaseState( short xState );//call COM interface IncreaseState method
 107
 108     void  SetName( com::sun::star::uno::Any newName);
 109     void  SetValue( com::sun::star::uno::Any pAny );
 110     void  SetDescription( com::sun::star::uno::Any newDesc );
 111     void  SetRole( short Role );
 112
 113     short GetRole() const;
 114
 115     void  UpdateState();
 116     void  UpdateName();
 117     void  UpdateValue();
 118     void  UpdateAction();
 119     void  UpdateDescription();
 120     void  UpdateValidWindow();
 121     void  UpdateLocation();
 122
 123     void  setFocus();
 124     void  unsetFocus();
 125
 126     void  AddSelect(long index, AccObject* accObj);
 127     IAccSelectionList& GetSelection();
 128     void  setLocalizedResourceString();
 129 };
 130
 131 #endif // INCLUDED_WINACCESSIBILITY_INC_ACCOBJECT_HXX
 132
 133 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */