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