offapi/com/sun/star/awt/AccessibleScrollBar.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: AccessibleScrollBar.idl,v $
  10  * $Revision: 1.7 $
  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_awt_AccessibleScrollBar_idl__
  32 #define __com_sun_star_awt_AccessibleScrollBar_idl__
  33
  34 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  35 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  36 #endif
  37 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  38 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  39 #endif
  40 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  41 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  42 #endif
  43 #ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
  44 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  45 #endif
  46 #ifndef __com_sun_star_accessibility_XAccessibleAction_idl__
  47 #include <com/sun/star/accessibility/XAccessibleAction.idl>
  48 #endif
  49 #ifndef __com_sun_star_accessibility_XAccessibleValue_idl__
  50 #include <com/sun/star/accessibility/XAccessibleValue.idl>
  51 #endif
  52
  53 module com { module sun { module star { module awt {
  54
  55 /** specifies accessibility support for a scroll bar.
  56
  57     @since OOo 1.1.2
  58  */
  59 published service AccessibleScrollBar
  60 {
  61     /** This interface gives access to the structural information of a
  62         scroll bar:
  63
  64         <ul>
  65         <li>Role: The role of a scroll bar is <const
  66             scope="com::sun::star::accessibility"
  67             >AccessibleRole::SCROLL_BAR</const>.</li>
  68         <li>Name: There is no name.</li>
  69         <li>Description: The description of a scroll bar is its localized
  70             help text.</li>
  71         <li>Children: There are no children.</li>
  72         <li>Parent: The parent is the window that contains the scroll bar.</li>
  73         <li>Relations: There are no relations.</li>
  74         <li>States: The states supported by this service are
  75             <ul>
  76             <li><const scope="com::sun::star::accessibility"
  77                 >AccessibleStateType::DEFUNC</const>
  78                 is set if the object has already been disposed
  79                 and subsequent calls to this object result in
  80                 <type scope="com::sun::star::lang">DisposedException</type>
  81                 exceptions.</li>
  82             <li><const scope="com::sun::star::accessibility"
  83                 >AccessibleStateType::ENABLED</const> is set
  84                 if the object is enabled.</li>
  85             <li><const scope="com::sun::star::accessibility"
  86                 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  87             <li><const scope="com::sun::star::accessibility"
  88                 >AccessibleStateType::FOCUSED</const> is set
  89                 if the object currently has the keyboard focus.</li>
  90             <li><const scope="com::sun::star::accessibility"
  91                 >AccessibleStateType::HORIZONTAL</const> is set
  92                 if the orientation of the object is horizontal.</li>
  93             <li><const scope="com::sun::star::accessibility"
  94                 >AccessibleStateType::SHOWING</const> is set
  95                 if the object is displayed on the screen.</li>
  96             <li><const scope="com::sun::star::accessibility"
  97                 >AccessibleStateType::VERTICAL</const> is set
  98                 if the orientation of the object is vertical.</li>
  99             <li><const scope="com::sun::star::accessibility"
 100                 >AccessibleStateType::VISIBLE</const> is always set.</li>
 101             </ul>
 102             </li>
 103         </ul>
 104      */
 105     interface ::com::sun::star::accessibility::XAccessibleContext;
 106
 107     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 108
 109     interface ::com::sun::star::accessibility::XAccessibleComponent;
 110
 111     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
 112
 113     /** This interface gives access to the actions that can be executed for
 114         a scroll bar. The supported actions for a scroll bar are:
 115         <ul>
 116         <li>decrementLine</li>
 117         <li>incrementLine</li>
 118         <li>decrementBlock</li>
 119         <li>incrementBlock</li>
 120         </ul>
 121      */
 122     interface ::com::sun::star::accessibility::XAccessibleAction;
 123
 124     /** This interface gives access to the numerical value of a scroll bar,
 125         which is related to the position of the scroll bar thumb.
 126      */
 127     interface ::com::sun::star::accessibility::XAccessibleValue;
 128 };
 129
 130 }; }; }; };
 131
 132 #endif