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

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