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