offapi/com/sun/star/accessibility/XAccessibleExtendedComponent.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
  30 #define __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
  31
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #include <com/sun/star/awt/XFocusListener.idl>
  34 #include <com/sun/star/awt/XFont.idl>
  35 #include <com/sun/star/awt/FontDescriptor.idl>
  36 #include <com/sun/star/awt/Point.idl>
  37 #include <com/sun/star/awt/Rectangle.idl>
  38 #include <com/sun/star/awt/Size.idl>
  39 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  40
  41 module com { module sun { module star { module accessibility {
  42
  43 /** The <type>XAccessibleExtendedComponent</type> interface contains
  44     additional methods to those of the <type>XAccessibleComponent</type>
  45     interface.  These methods provide information that is used not as often.  The
  46     division into two interfaces allows classes to support the more
  47     frequently used methods of the <type>XAccessibleComponent</type>
  48     interface and only support the <type>XAccessibleExtendedComponent</type>
  49     interface if that makes sense for the class.
  50
  51     <p>This interface provides extended access to retrieve information
  52     concerning the graphical representation of an object.  This interface
  53     combines methods from the Java interfaces
  54     <code>javax.accessibility.AccessibleComponent</code> and
  55     <code>javax.accessibility.AccessibleExtendedComponent</code>.</p>
  56
  57     @since OOo 1.1.2
  58 */
  59 published interface XAccessibleExtendedComponent : XAccessibleComponent
  60 {
  61     /** Returns the font of this object.
  62
  63         @return
  64             The returned reference to a font object is empty if a font is not
  65             supported by this object.
  66     */
  67     ::com::sun::star::awt::XFont getFont ();
  68
  69     /** Returns the titled border text.
  70
  71         <p>This method stems from the Java interface
  72         <code>AccessibleExtendedComponent</code>.</p>
  73
  74         @return
  75             The returned value is the titled border text of the object or
  76             empty if that is not supported.
  77     */
  78     string getTitledBorderText ();
  79
  80     /** Returns the tool tip text of this object.
  81
  82         <p>This method stems from the Java interface
  83         <code>AccessibleExtendedComponent</code>.</p>
  84
  85         @return
  86             Returns the localized tool tip text of the object.  If tool tips
  87             are not supported and empty string is returned.
  88     */
  89     string getToolTipText ();
  90 };
  91
  92 }; }; }; };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */