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

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