offapi/com/sun/star/text/AccessibleHeaderFooterView.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 module com {  module sun {  module star {  module text {
  23
  24
  25 /** The accessible view of headers and footers.
  26
  27      @since OOo 1.1.2
  28
  29  */
  30 service AccessibleHeaderFooterView
  31 {
  32     /** This interface gives access to any paragraph and table that is
  33           contained in the header and footer and is at least partially visible
  34         on the screen.
  35
  36         <ul>
  37             <li>The parent returned by
  38                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent()
  39                 is either the accessible view of a text document,
  40                 a page of the accessible page preview of a text document,
  41                 or the accessible page preview of a spreadsheet document.
  42             <li>The children returned by
  43                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  44                 all support the interface XAccessible. Calling
  45                 ::com::sun::star::accessibility::XAccessible::getAccessibleContext()
  46                 for these children returns
  47                 an object that supports one of the following services.
  48                 <ul>
  49                     <li>::com::sun::star::text::AccessibleParagraphView:
  50                         A child of this kind is returned for every paragraph
  51                         that is contained in the document body and
  52                         is at least partially visible. The child always
  53                         represents a whole paragraph (and not a fragment only),
  54                         because there are no page breaks within headers and
  55                         footers.
  56                     <li>::com::sun::star::table::AccessibleTableView:
  57                         A child of this kind is returned for every table
  58                         that is contained in the document body
  59                         and is at least partially visible. The child always
  60                         represents a whole table (and not a fragment only),
  61                         because there are no page breaks within headers and
  62                         footers.
  63                 </ul>
  64             <p>The logical order of paragraphs and tables is never changed.
  65             <li>The role is either
  66                 ::com::sun::star::accessibility::AccessibleRole::HEADER or
  67                 ::com::sun::star::accessibility::AccessibleRole::FOOTER.
  68             <li>The name is "header" or "footer" (or the equivalent term
  69                 in application's language) with a number appended.
  70             <li>The description is "header" or "footer" (or the equivalent term
  71                 in application's language) with the page number appended in
  72                 the format that is specified in the page's style.
  73             <li>There are no relations.
  74             <li>The following states might be contained in the state set
  75                 returned by
  76                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet():
  77                 <ul>
  78                     <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
  79                         (indicates that
  80                         the document window has been closed or the header or
  81                         footer is not existing any longer)
  82                     <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
  83                     <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
  84                         (always contained)
  85                     <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
  86                     <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
  87                     <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
  88                 </ul>
  89             <li>Depending of the application's region setting, the locale is
  90                 the western, Asian or complex default language of the document.
  91         </ul>
  92
  93      */
  94     interface ::com::sun::star::accessibility::XAccessibleContext;
  95
  96     /** This interface describes the graphical representation of a header
  97           or footer.
  98      */
  99     interface ::com::sun::star::accessibility::XAccessibleComponent;
 100
 101     /** This is the interface for listeners */
 102     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 103 };
 104
 105
 106 }; }; }; };
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */