winaccessibility/source/UAccCOM/AccActionBase.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 // AccActionBase.h: interface for the CAccActionBase class.
  21
  22 #ifndef INCLUDED_WINACCESSIBILITY_SOURCE_UACCCOM_ACCACTIONBASE_H
  23 #define INCLUDED_WINACCESSIBILITY_SOURCE_UACCCOM_ACCACTIONBASE_H
  24
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include <com/sun/star/accessibility/XAccessibleAction.hpp>
  27 #include "UNOXWrapper.h"
  28
  29 class ATL_NO_VTABLE CAccActionBase  : public CUNOXWrapper
  30 {
  31 public:
  32     CAccActionBase();
  33     virtual ~CAccActionBase();
  34
  35     // IAccessibleAction
  36 public:
  37     // IAccessibleAction
  38
  39     // Returns the number of action.
  40     STDMETHOD(nActions)(/*[out,retval]*/long* nActions);
  41
  42     // Performs specified action on the object.
  43     STDMETHOD(doAction)(/* [in] */ long actionIndex);
  44
  45     // Gets description of specified action.
  46     STDMETHOD(get_description)(long actionIndex,BSTR __RPC_FAR *description);
  47
  48     // added , 2006/06/28, for driver 07/11
  49     // get the action name
  50     STDMETHOD(get_name)( long actionIndex, BSTR __RPC_FAR *name);
  51
  52     // get the localized action Name
  53     STDMETHOD(get_localizedName)( long actionIndex, BSTR __RPC_FAR *localizedName);
  54
  55     // Returns key binding object (if any) associated with specified action
  56     // key binding is string.
  57     // e.g. "alt+d" (like IAccessible::get_accKeyboardShortcut).
  58     STDMETHOD(get_keyBinding)(
  59         /* [in] */ long actionIndex,
  60         /* [in] */ long nMaxBinding,
  61         /* [length_is][length_is][size_is][size_is][out] */ BSTR __RPC_FAR *__RPC_FAR *keyBinding,
  62         /* [retval][out] */ long __RPC_FAR *nBinding);
  63
  64     // Override of IUNOXWrapper.
  65     STDMETHOD(put_XInterface)(hyper pXInterface) override;
  66
  67 protected:
  68     css::uno::Reference<css::accessibility::XAccessibleAction> pRXAct;
  69
  70 private:
  71     css::accessibility::XAccessibleAction* GetXInterface()
  72     {
  73         return pRXAct.get();
  74     }
  75 };
  76
  77 #endif // INCLUDED_WINACCESSIBILITY_SOURCE_UACCCOM_ACCACTIONBASE_H
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */