offapi/com/sun/star/sheet/AccessiblePageHeaderFooterAreasView.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_sheet_AccessiblePageHeaderFooterAreasView_idl__
  20 #define __com_sun_star_sheet_AccessiblePageHeaderFooterAreasView_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 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** The accessible view of the Header/Footer in a spreadsheet page preview
  31
  32      @since OOo 1.1.2
  33
  34  */
  35 service AccessiblePageHeaderFooterAreasView
  36 {
  37     /** This interface gives access to the three Header/Footer areas in the
  38         page preview.
  39
  40     <ul>
  41         <li>The parent returned by
  42         ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent()
  43             is the accessible spreadsheet page preview.</li>
  44         <li>The children returned by
  45             ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  46             all support the interface
  47             ::com::sun::star::accessibility::XAccessible.
  48             Calling
  49             ::com::sun::star::accessibility::XAccessible::getAccessibleContext()
  50             for these children
  51             returns an object that supports one of the following services.</li>
  52         <ul>
  53             <li>::com::sun::star::text::AccessibleHeaderFooterView:
  54                 A child where calling
  55                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  56                 an object that supports this service is returned for
  57                 every header and footer that is at least partially visible.</li>
  58         </ul>
  59         <p>The following rules apply to the children order.</p>
  60         <ul>
  61             <li>The first is the left area, than the center area and the last
  62             is the right area.</li>
  63         </ul>
  64         <li>The description is ???.</li>
  65         <li>The name is Header or Footer respectively.</li>
  66         <li>The role is ::com::sun::star::accessibility::AccessibleRole::HEADER
  67             or ::com::sun::star::accessibility::AccessibleRole::FOOTER.</li>
  68         <li>There are no relations.</li>
  69         <li>The following states are supported:
  70             <ul>
  71                 <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
  72                     is always false until the preview is closed.</li>
  73                 <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
  74                     is always false,
  75                     because the document is not editable in the page preview.
  76                     So it is left out of the list.</li>
  77                 <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
  78                     is always true.</li>
  79                 <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_LINE
  80                     makes no sense on
  81                     a document and so it is left out of the list.</li>
  82                 <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE
  83                     is always
  84                     false, because in a page preview a selection is not
  85                     possible. So it is left out of the list.</li>
  86                 <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
  87                     is always true.</li>
  88                 <li>::com::sun::star::accessibility::AccessibleStateType::RESIZABLE
  89                     is always false,
  90                     because you can resize the window of the page preview, but
  91                     not the page preview itself. So it is left out of the
  92                     list.</li>
  93                 <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE
  94                     is always false,
  95                     because in the page preview is no selection possible. So it
  96                     is left out of the list.</li>
  97                 <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED
  98                     is always false,
  99                     because in the page preview is no selection possible. So it
 100                     is left out of the list.</li>
 101                 <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
 102                     is true if the
 103                     Bounding Box lies in the Bounding Box of the parent.
 104                     Otherwise it is false.</li>
 105                 <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
 106                     is always true.</li>
 107             </ul>
 108         </li>
 109     </ul>
 110
 111      */
 112     interface ::com::sun::star::accessibility::XAccessibleContext;
 113
 114     /** This interface gives access to the visibility of the document.
 115     */
 116     interface ::com::sun::star::accessibility::XAccessibleComponent;
 117
 118     /** This is the interface for listeners */
 119     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 120 };
 121
 122
 123 }; }; }; };
 124
 125 #endif
 126
 127 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */