winaccessibility/source/UAccCOM/AccHyperLink.h

   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_SOURCE_UACCCOM_ACCHYPERLINK_H
  21 #define INCLUDED_WINACCESSIBILITY_SOURCE_UACCCOM_ACCHYPERLINK_H
  22
  23 #include "resource.h"       // main symbols
  24
  25 #include <com/sun/star/accessibility/XAccessibleHyperlink.hpp>
  26 #include "AccActionBase.h"
  27 #include "UNOXWrapper.h"
  28
  29 /**
  30  * CAccHyperLink implements IAccessibleHyperlink interface.
  31  */
  32 class ATL_NO_VTABLE CAccHyperLink :
  33             public CComObjectRoot,
  34             public CComCoClass<CAccHyperLink,&CLSID_AccHyperLink>,
  35             public IAccessibleHyperlink,
  36             public CAccActionBase
  37 {
  38 public:
  39     CAccHyperLink()
  40     {
  41             }
  42     ~CAccHyperLink()
  43     {
  44             }
  45
  46     BEGIN_COM_MAP(CAccHyperLink)
  47     COM_INTERFACE_ENTRY(IAccessibleAction)
  48     COM_INTERFACE_ENTRY(IAccessibleHyperlink)
  49     COM_INTERFACE_ENTRY(IUNOXWrapper)
  50     END_COM_MAP()
  51
  52     DECLARE_NO_REGISTRY()
  53
  54     static HRESULT WINAPI _SmartQI(void* pv,
  55                                    REFIID iid, void** ppvObject, DWORD_PTR)
  56     {
  57         return ((CAccHyperLink*)pv)->SmartQI(iid,ppvObject);
  58     }
  59
  60     HRESULT SmartQI(REFIID iid, void** ppvObject)
  61     {
  62         if( m_pOuterUnknown )
  63             return OuterQueryInterface(iid,ppvObject);
  64         return E_FAIL;
  65     }
  66
  67     // IAccessibleHyperlink
  68 public:
  69     // IAccessibleAction
  70
  71     // Returns the number of action.
  72     STDMETHOD(nActions)(/*[out,retval]*/long* nActions);
  73
  74     // Performs specified action on the object.
  75     STDMETHOD(doAction)(/* [in] */ long actionIndex);
  76
  77     // get the action name
  78     STDMETHOD(get_name)( long actionIndex, BSTR __RPC_FAR *name);
  79
  80     // get the localized action name
  81     STDMETHOD(get_localizedName)( long actionIndex, BSTR __RPC_FAR *localizedName);
  82
  83     // Gets description of specified action.
  84     STDMETHOD(get_description)(long actionIndex,BSTR __RPC_FAR *description);
  85
  86     // Returns key binding object (if any) associated with specified action
  87     // key binding is string.
  88     // e.g. "alt+d" (like IAccessible::get_accKeyboardShortcut).
  89     STDMETHOD(get_keyBinding)(
  90         /* [in] */ long actionIndex,
  91         /* [in] */ long nMaxBinding,
  92         /* [length_is][length_is][size_is][size_is][out] */ BSTR __RPC_FAR *__RPC_FAR *keyBinding,
  93         /* [retval][out] */ long __RPC_FAR *nBinding);
  94
  95     // IAccessibleHyperlink
  96
  97     // get an object, e.g. BSTR or image object, that is overloaded with link behavior
  98     STDMETHOD(get_anchor)(/* [in] */ long index,
  99                                      /* [retval][out] */ VARIANT __RPC_FAR *anchor);
 100
 101     // get an object representing the target of the link, usually a BSTR of the URI
 102     STDMETHOD(get_anchorTarget)(/* [in] */ long index,
 103                                            /* [retval][out] */ VARIANT __RPC_FAR *anchorTarget);
 104
 105     // Returns the index at which the textual representation of the
 106     // hyperlink (group) starts.
 107     STDMETHOD(get_startIndex)(/* [retval][out] */ long __RPC_FAR *index);
 108
 109     // Returns the index at which the textual rerpesentation of the
 110     // hyperlink (group) ends.
 111     STDMETHOD(get_endIndex)(/* [retval][out] */ long __RPC_FAR *index);
 112
 113     // Returns whether the document referenced by this links is still valid.
 114     STDMETHOD(get_valid)(/* [retval][out] */ boolean __RPC_FAR *valid);
 115
 116     // Override of IUNOXWrapper.
 117     STDMETHOD(put_XInterface)(hyper pXInterface);
 118
 119     // Override of IUNOXWrapper.
 120     STDMETHOD(put_XSubInterface)(hyper pXSubInterface);
 121
 122 private:
 123
 124     com::sun::star::uno::Reference<com::sun::star::accessibility::XAccessibleHyperlink> pRXLink;
 125
 126     inline com::sun::star::accessibility::XAccessibleHyperlink* GetXInterface()
 127     {
 128         return pRXLink.get();
 129     }
 130
 131 };
 132
 133 #endif // INCLUDED_WINACCESSIBILITY_SOURCE_UACCCOM_ACCHYPERLINK_H
 134
 135 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */