offapi/com/sun/star/text/AccessibleTextFrameView.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 #ifndef __com_sun_star_text_AccessibleTextFrameView_idl__
  20 #define __com_sun_star_text_AccessibleTextFrameView_idl__
  21
  22 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  23 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  24
  25
  26 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  27
  28
  29 module com {  module sun {  module star {  module text {
  30
  31
  32 /** The accessible view of text frames.
  33
  34      @since OOo 1.1.2
  35  */
  36 service AccessibleTextFrameView
  37 {
  38     /** This interface gives access to any paragraph fragment and table
  39         fragment that is contained in a text frame and at least
  40         partially visible on the screen.
  41
  42         <ul>
  43             <li>The parent returned by
  44                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent()
  45                 is the
  46                 accessible view of a paragraph if the text frame is bound as
  47                 character, and the accessible view (or of a page in the page
  48                 preview) of the document in any other case.
  49             <li>The children returned by
  50                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  51                 all support the interface XAccessible. Calling
  52                 ::com::sun::star::accessibility::XAccessible::getAccessibleContext()
  53                 for these children returns an object that supports one of the
  54                 following services.
  55                 <ul>
  56                     <li>::com::sun::star::text::AccessibleParagraphView:
  57                         A child of this
  58                         kind is returned for every paragraph fragment that
  59                         is contained in the document body and is at least
  60                         partially visible. A paragraph fragment is the part
  61                         of a paragraph that is displayed on a certain page
  62                         or a certain column.
  63                     <li>::com::sun::star::table::AccessibleTableView:
  64                         A child of this kind is
  65                         returned for every table fragment that is contained
  66                         in the document body and is at least partially
  67                         visible. A table fragment is the part of a table
  68                         that is displayed on a certain page or a certain
  69                         column.
  70                 </ul>
  71                 <p>The logical order of paragraph and table fragments is never
  72                    changed.
  73             <li>The role is
  74                 ::com::sun::star::accessibility::AccessibleRole::TEXT_FRAME
  75             <li>The name is the one assigned to the text frame in the text
  76                 document. This means that it is not internationalized.
  77             <li>The description is the one assigned to the text frame in the
  78                 text document. This means that it is not internationalized. If
  79                 no description has been set, the description equals the name.
  80             <li>There are no relations.
  81             <li>The following states might be contained in the state set
  82                 returned by
  83                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet():
  84                 <ul>
  85                     <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
  86                         (indicates that
  87                         the document window has been closed or the graphic
  88                         is not existing any longer)
  89                     <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
  90                     <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
  91                         (always contained)
  92                     <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
  93                     <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE
  94                     <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED
  95                     <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  96                     <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSED
  97                     <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
  98                     <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
  99                 </ul>
 100             <li>The locale is the one the text document itself.
 101             <li>There are the two relations CONTENT_FLOWS_FROM and
 102                 CONTENT_FLOWS_TO supported.
 103         </ul>
 104
 105      */
 106     interface ::com::sun::star::accessibility::XAccessibleContext;
 107
 108     /** This interface describes the graphical representation of a
 109           text frame.
 110      */
 111     interface ::com::sun::star::accessibility::XAccessibleComponent;
 112
 113     /** This is the interface for listeners */
 114     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 115 };
 116
 117
 118 }; }; }; };
 119
 120 #endif
 121
 122 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */