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                 <method scope="::com::sun::star::accessibility"
  45                 >XAccessibleContext::getAccessibleParent</method>
  46                 is either the accessible view of a text document,
  47                 a page of the accessible page preview of a text document,
  48                 or the accessible page preview of a spreadsheet document.
  49             <li>The children returned by
  50                 <method scope="::com::sun::star::accessibility"
  51                 >XAccessibleContext::getAccessibleChild</method> all
  52                 support the interface XAccessible. Calling
  53                 <method scope="::com::sun::star::accessibility"
  54                 >XAccessible::getAccessibleContext</method> for these children returns
  55                 an object that supports one of the following services.
  56                 <ul>
  57                     <li><type scope="::com::sun::star::text"
  58                         >AccessibleParagraphView</type>:
  59                         A child of this kind is returned for every paragraph
  60                         that is contained in the document body and
  61                         is at least partially visible. The child always
  62                         represents a whole paragraph (and not a fragment only),
  63                         because there are no page breaks within headers and
  64                         footers.
  65                     <li><type scope="::com::sun::star::table"
  66                         >AccessibleTableView</type>:
  67                         A child of this kind is returned for every table
  68                         that is contained in the document body
  69                         and is at least partially visible. The child always
  70                         represents a whole table (and not a fragment only),
  71                         because there are no page breaks within headers and
  72                         footers.
  73                 </ul>
  74             <p>The logical order of paragraphs and tables is never changed.
  75             <li>The role is either
  76                 <const scope="::com::sun::star::accessibility"
  77                 >AccessibleRole::HEADER</const> or
  78                 <const scope="::com::sun::star::accessibility"
  79                 >AccessibleRole::FOOTER</const>.
  80             <li>The name is "header" or "footer" (or the equivalent term
  81                 in application's language) with a number appended.
  82             <li>The description is "header" or "footer" (or the equivalent term
  83                 in application's language) with the page number appended in
  84                 the format that is specified in the page's style.
  85             <li>There are no relations.
  86             <li>The following states might be contained in the state set
  87                 returned by <method scope="::com::sun::star::accessibility"
  88                 >XAccessible::getAccessibleStateSet</type>:
  89                 <ul>
  90                     <li><const scope="::com::sun::star::accessibility"
  91                         >AccessibleStateType::DEFUNC</const> (indicates that
  92                         the document window has been closed or the header or
  93                         footer is not existing any longer)
  94                     <li><const scope="::com::sun::star::accessibility"
  95                         >AccessibleStateType::EDITABLE</const>
  96                     <li><const scope="::com::sun::star::accessibility"
  97                         >AccessibleStateType::ENABLED</const> (always contained)
  98                     <li><const scope="::com::sun::star::accessibility"
  99                         >AccessibleStateType::OPAQUE</const>
 100                     <li><const scope="::com::sun::star::accessibility"
 101                         >AccessibleStateType::SHOWING</const>
 102                     <li><const scope="::com::sun::star::accessibility"
 103                         >AccessibleStateType::VISIBLE</const>
 104                 </ul>
 105             <li>Depending of the application's region setting, the locale is
 106                 the western, Asian or complex default language of the document.
 107         </ul>
 108
 109      */
 110     interface ::com::sun::star::accessibility::XAccessibleContext;
 111
 112     /** This interface describes the graphical representation of a header
 113           or footer.
 114      */
 115     interface ::com::sun::star::accessibility::XAccessibleComponent;
 116
 117     /** This is the interface for listeners */
 118     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 119 };
 120
 121
 122 }; }; }; };
 123
 124 #endif
 125
 126 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */