CATAccessible.h

Go to the documentation of this file.

/// \file CATAccessible.h
/// \brief Base class for Microsoft's IAccessible handling
/// \ingroup CATGUI
///
/// Copyright (c) 2007-2008 by Michael Ellison.
/// See COPYING.txt for the \ref gaslicense License (MIT License).
///
// $Author: mikeellison $
// $Date: 2008-01-24 06:27:32 -0600 (Thu, 24 Jan 2008) $
// $Revision:   $
// $NoKeywords: $

#ifndef _CATACCESSIBLE_H_
#define _CATACCESSIBLE_H_

#include "CATInternal.h"
#include "CATGuiObj.h"
#include <Oleacc.h>

class CATWindow;

#define CATACC HRESULT STDMETHODCALLTYPE

class CATAccessible : public IAccessible
{
    public:
        // IHateCOM

        CATAccessible(CATGuiObj* object, CATWindow* window);

        /// Called by the linked CATGuiObject upon it's destruction.
        /// We should clear our ptr to it and release a ref.
        virtual  void   ObjectDeath();

        // IUnknown
        virtual  CATACC QueryInterface(         REFIID          riid,
                                                void **         ppvObject);
        virtual  ULONG STDMETHODCALLTYPE AddRef ( void);

        virtual  ULONG STDMETHODCALLTYPE Release( void);

        // IDispatch
        virtual  CATACC GetTypeInfoCount(       UINT *          pctinfo);
        
        virtual  CATACC GetTypeInfo(            UINT            iTInfo,
                                                LCID            lcid,
                                                ITypeInfo **    ppTInfo);
        
        virtual  CATACC GetIDsOfNames(          REFIID          riid,
                                                __RPC__in_ecount_full(cNames) LPOLESTR *rgszNames,
                                                UINT            cNames,
                                                LCID            lcid,
                                                __RPC__out_ecount_full(cNames) DISPID *rgDispId);
        
        virtual  CATACC Invoke(                 DISPID          dispIdMember,
                                                REFIID          riid,
                                                LCID            lcid,
                                                WORD            wFlags,
                                                DISPPARAMS *    pDispParams,
                                                VARIANT *       pVarResult,
                                                EXCEPINFO *     pExcepInfo,
                                                UINT *          puArgErr);

        // IAccessible
        virtual  CATACC get_accParent    (      IDispatch**     ppdispParent);
        
        virtual  CATACC get_accChildCount(      long *          pcountChildren);        
        
        virtual  CATACC get_accChild     (      VARIANT         varChild,
                                                IDispatch **    ppdispChild);
        
        virtual  CATACC get_accName      (      VARIANT         varChild,
                                                BSTR *          pszName);
        
        virtual  CATACC get_accValue     (      VARIANT         varChild,
                                                BSTR *          pszValue);
        
        virtual  CATACC get_accDescription(     VARIANT         varChild,
                                                BSTR *          pszDescription);
        
        virtual  CATACC get_accRole      (      VARIANT         varChild,
                                                VARIANT *       pvarRole);
        
        virtual  CATACC get_accState     (      VARIANT         varChild, 
                                                VARIANT *       pvarState);
        
        virtual  CATACC get_accHelp      (      VARIANT         varChild,
                                                BSTR *          pszHelp);
        
        virtual  CATACC get_accHelpTopic (      BSTR *          pszHelpFile,
                                                VARIANT         varChild,
                                                long *          pidTopic);
        
        virtual  CATACC get_accKeyboardShortcut(VARIANT         varChild,
                                                BSTR *          pszKeyboardShortcut);
        
        virtual  CATACC get_accFocus     (      VARIANT *       pvarChild);
        
        virtual  CATACC get_accSelection (      VARIANT *       pvarChildren);
        
        virtual  CATACC get_accDefaultAction(   VARIANT         varChild,
                                                BSTR *          pszDefaultAction);
        
        virtual  CATACC accSelect        (      long            flagsSelect,
                                                VARIANT         varChild);
        
        virtual  CATACC accLocation      (      long *          pxLeft,
                                                long *          pyTop,
                                                long *          pcxWidth,
                                                long *          pcyHeight,
                                                 VARIANT        varChild);
        
        virtual  CATACC accNavigate      (      long            navDir,
                                                VARIANT         varStart,
                                                VARIANT *       pvarEndUpAt);
        
        virtual  CATACC accHitTest       (      long            xLeft,
                                                long            yTop,
                                                VARIANT *       pvarChild);
        
        virtual  CATACC accDoDefaultAction(     VARIANT         varChild);
        
        virtual CATACC put_accName       (      VARIANT         varChild,
                                                BSTR            szName);
        
        virtual CATACC put_accValue      (      VARIANT         varChild,
                                                BSTR            szValue);
    
    protected:
        virtual     ~CATAccessible();
        CATGuiObj*   fObject;
        CATWindow*   fWindow;
        CATUInt32    fRefCount;
};

#undef CATACC

#endif // _CATACCESSIBLE_H_

---