offapi/com/sun/star/awt/AccessibleFixedText.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_AccessibleFixedText_idl__
  21 #define __com_sun_star_awt_AccessibleFixedText_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/XAccessibleText.idl>
  28
  29 module com { module sun { module star { module awt {
  30
  31 /** specifies accessibility support for a fixed text.
  32
  33     @since OOo 1.1.2
  34  */
  35 service AccessibleFixedText
  36 {
  37     /** This interface gives access to the structural information of a
  38         fixed text:
  39
  40         <ul>
  41         <li>Role: The role of a fixed text is
  42         com::sun::star::accessibility::AccessibleRole::LABEL.</li>
  43         <li>Name: The name of a fixed text is its localized label.</li>
  44         <li>Description: The description of a fixed text is its localized
  45             help text.</li>
  46         <li>Children: There are no children.</li>
  47         <li>Parent: The parent is the window that contains the fixed text.</li>
  48         <li>Relations: The relations supported by this service are
  49             <ul>
  50             <li>com::sun::star::accessibility::AccessibleRelationType::LABEL_FOR
  51                 is set if the object is a label for one or more target
  52                 objects.</li>
  53             </ul>
  54             </li>
  55         <li>States: The states supported by this service are
  56             <ul>
  57             <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  58                 is set if the object has already been disposed
  59                 and subsequent calls to this object result in
  60                 com::sun::star::lang::DisposedException
  61                 exceptions.</li>
  62             <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  63                 is set if the object is enabled.</li>
  64             <li>com::sun::star::accessibility::AccessibleStateType::MULTI_LINE
  65                 is set if the object contains multiple lines of text.</li>
  66             <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  67                 is set if the object is displayed on the screen.</li>
  68             <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  69                 is always set.</li>
  70             </ul>
  71             </li>
  72         </ul>
  73      */
  74     interface ::com::sun::star::accessibility::XAccessibleContext;
  75
  76     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  77
  78     interface ::com::sun::star::accessibility::XAccessibleComponent;
  79
  80     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  81
  82     /** This interface gives read-only access to the text representation
  83         of a fixed text.
  84      */
  85     interface ::com::sun::star::accessibility::XAccessibleText;
  86 };
  87
  88 }; }; }; };
  89
  90 #endif
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */