offapi/com/sun/star/accessibility/XAccessibleExtendedComponent.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 /** The XAccessibleExtendedComponent interface contains
  23     additional methods to those of the XAccessibleComponent
  24     interface.  These methods provide information that is used not as often.  The
  25     division into two interfaces allows classes to support the more
  26     frequently used methods of the XAccessibleComponent
  27     interface and only support the XAccessibleExtendedComponent
  28     interface if that makes sense for the class.
  29
  30     <p>This interface provides extended access to retrieve information
  31     concerning the graphical representation of an object.  This interface
  32     combines methods from the Java interfaces
  33     <code>javax.accessibility.AccessibleComponent</code> and
  34     <code>javax.accessibility.AccessibleExtendedComponent</code>.</p>
  35
  36     @since OOo 1.1.2
  37 */
  38 interface XAccessibleExtendedComponent : XAccessibleComponent
  39 {
  40     /** Returns the font of this object.
  41
  42         @return
  43             The returned reference to a font object is empty if a font is not
  44             supported by this object.
  45     */
  46     ::com::sun::star::awt::XFont getFont ();
  47
  48     /** Returns the titled border text.
  49
  50         <p>This method stems from the Java interface
  51         <code>AccessibleExtendedComponent</code>.</p>
  52
  53         @return
  54             The returned value is the titled border text of the object or
  55             empty if that is not supported.
  56     */
  57     string getTitledBorderText ();
  58
  59     /** Returns the tool tip text of this object.
  60
  61         <p>This method stems from the Java interface
  62         <code>AccessibleExtendedComponent</code>.</p>
  63
  64         @return
  65             Returns the localized tool tip text of the object.  If tool tips
  66             are not supported and empty string is returned.
  67     */
  68     string getToolTipText ();
  69 };
  70
  71 }; }; }; };
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */