offapi/com/sun/star/accessibility/XAccessibleContext2.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 module com { module sun { module star { module accessibility {
  21
  22 /** Implement this interface for exposing more aspects of a class's
  23     content.
  24
  25     <p>This is an extension of XAccessibleContext to add getAccessibleId().</p>
  26
  27     @since LibreOffice 6.3
  28 */
  29 interface XAccessibleContext2 : ::com::sun::star::accessibility::XAccessibleContext
  30 {
  31     /** Return the object's identifier.
  32
  33         <p>This is not meant to be presented to the user, but to be an ID
  34         which is stable over application development. Typically, this is
  35         the gtkbuilder ID. Such an ID can then be used to identify a given
  36         well-known accessible object independently from the current locale,
  37         user-visible labelling, or dialog structure. This can then be used for
  38         tailored screen reading (e.g. automatically announcing the content of a
  39         well-known object), or for automatic regression testing (to check the
  40         behavior of well-known objects). Uniqueness within the window is thus
  41         desirable when returning a non-empty string.</p>
  42
  43         @return
  44             The returned string is the object's identifier.
  45     */
  46     string  getAccessibleId ();
  47 };
  48
  49 }; }; }; };
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */