AccActionBase.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
// AccActionBase.h: interface for the CAccActionBase class.
 
#pragma once
 
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/accessibility/XAccessibleAction.hpp>
#include "UNOXWrapper.h"
 
class ATL_NO_VTABLE CAccActionBase : public CUNOXWrapper
{
public:
    CAccActionBase();
    virtual ~CAccActionBase();
 
    // IAccessibleAction
public:
    // IAccessibleAction
 
    // Returns the number of action.
    STDMETHOD(nActions)(/*[out,retval]*/ long* nActions);
 
    // Performs specified action on the object.
    STDMETHOD(doAction)(/* [in] */ long actionIndex);
 
    // Gets description of specified action.
    STDMETHOD(get_description)(long actionIndex, BSTR __RPC_FAR* description);
 
    // added , 2006/06/28, for driver 07/11
    // get the action name
    STDMETHOD(get_name)(long actionIndex, BSTR __RPC_FAR* name);
 
    // get the localized action Name
    STDMETHOD(get_localizedName)(long actionIndex, BSTR __RPC_FAR* localizedName);
 
    // Returns key binding object (if any) associated with specified action
    // key binding is string.
    // e.g. "alt+d" (like IAccessible::get_accKeyboardShortcut).
    STDMETHOD(get_keyBinding)
    (
        /* [in] */ long actionIndex,
        /* [in] */ long nMaxBinding,
        /* [length_is][length_is][size_is][size_is][out] */ BSTR __RPC_FAR* __RPC_FAR* keyBinding,
        /* [retval][out] */ long __RPC_FAR* nBinding);
 
    // Override of IUNOXWrapper.
    STDMETHOD(put_XInterface)(hyper pXInterface) override;
 
protected:
    css::uno::Reference<css::accessibility::XAccessibleAction> pRXAct;
 
private:
    css::accessibility::XAccessibleAction* GetXInterface() { return pRXAct.get(); }
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */