winaccessibility/source/UAccCOMIDL/AccessibleKeyBinding.idl

   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 import "objidl.idl";
  21 import "oaidl.idl";
  22 import "oleacc.idl";
  23 import "AccessibleKeyStroke.idl";
  24
  25 [object, uuid(6B1923AC-3E9A-4336-99E1-A69EA4E946E9)]
  26 interface IAccessibleKeyBinding : IUnknown
  27 {
  28   // get number of key bindings for this object
  29   [propget] HRESULT nKeyBindings
  30     (
  31      [out, retval] long *nKeyBindings
  32      );
  33
  34   // get length of keystroke sequence for specified key binding
  35   [propget] HRESULT keyStrokeSequenceLength
  36     (
  37      [in] long keyBindingIndex,
  38      [out] long *sequenceLength
  39      );
  40
  41   // The returned sequence of key strokes describes one method
  42   // to invoke the associated action (the one from which you
  43   // obtained the object at which you called this method) by
  44   // pressing keys. The keys specified by each of the returned
  45   // key strokes have to be pressed at the same time (the
  46   // Control-key and the A-key for example). The keys of one key
  47   // stroke have to be released before pressing those of the next.
  48   // The order of the key strokes in the sequence define the order
  49   // in which to press them.
  50   [propget] HRESULT keyBinding
  51     (
  52      [in] long keyBindingIndex,
  53      [in] long keyStrokeSequenceLength,
  54      [out, size_is(,keyStrokeSequenceLength), length_is(,*actualKeyStrokeSequenceLength)]
  55        ACCESSIBLE_KEYSTROKE **keyStroke,
  56      [out, retval] long *actualKeyStrokeSequenceLength
  57      );
  58 }
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */