offapi/com/sun/star/awt/AccessibleScrollBar.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 #ifndef __com_sun_star_awt_AccessibleScrollBar_idl__
  21 #define __com_sun_star_awt_AccessibleScrollBar_idl__
  22
  23 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  24 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  25 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  26 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  27 #include <com/sun/star/accessibility/XAccessibleAction.idl>
  28 #include <com/sun/star/accessibility/XAccessibleValue.idl>
  29
  30 module com { module sun { module star { module awt {
  31
  32 /** specifies accessibility support for a scroll bar.
  33
  34     @since OOo 1.1.2
  35  */
  36 service AccessibleScrollBar
  37 {
  38     /** This interface gives access to the structural information of a
  39         scroll bar:
  40
  41         <ul>
  42         <li>Role: The role of a scroll bar is
  43         com::sun::star::accessibility::AccessibleRole::SCROLL_BAR.</li>
  44         <li>Name: There is no name.</li>
  45         <li>Description: The description of a scroll bar is its localized
  46             help text.</li>
  47         <li>Children: There are no children.</li>
  48         <li>Parent: The parent is the window that contains the scroll bar.</li>
  49         <li>Relations: There are no relations.</li>
  50         <li>States: The states supported by this service are
  51             <ul>
  52             <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  53                 is set if the object has already been disposed
  54                 and subsequent calls to this object result in
  55                 com::sun::star::lang::DisposedException
  56                 exceptions.</li>
  57             <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  58                 is set if the object is enabled.</li>
  59             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  60                 is always set.</li>
  61             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
  62                 is set if the object currently has the keyboard focus.</li>
  63             <li>com::sun::star::accessibility::AccessibleStateType::HORIZONTAL
  64                 is set if the orientation of the object is horizontal.</li>
  65             <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  66                 is set if the object is displayed on the screen.</li>
  67             <li>com::sun::star::accessibility::AccessibleStateType::VERTICAL
  68                 is set if the orientation of the object is vertical.</li>
  69             <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  70                 is always set.</li>
  71             </ul>
  72             </li>
  73         </ul>
  74      */
  75     interface ::com::sun::star::accessibility::XAccessibleContext;
  76
  77     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  78
  79     interface ::com::sun::star::accessibility::XAccessibleComponent;
  80
  81     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  82
  83     /** This interface gives access to the actions that can be executed for
  84         a scroll bar. The supported actions for a scroll bar are:
  85         <ul>
  86         <li>decrementLine</li>
  87         <li>incrementLine</li>
  88         <li>decrementBlock</li>
  89         <li>incrementBlock</li>
  90         </ul>
  91      */
  92     interface ::com::sun::star::accessibility::XAccessibleAction;
  93
  94     /** This interface gives access to the numerical value of a scroll bar,
  95         which is related to the position of the scroll bar thumb.
  96      */
  97     interface ::com::sun::star::accessibility::XAccessibleValue;
  98 };
  99
 100 }; }; }; };
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */