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