blob: 2a0d039f2bd28155dc57c45f50ea5d92de7c2ed4 [file] [log] [blame]
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef __com_sun_star_sheet_AccessiblePageHeaderFooterAreasView_idl__
#define __com_sun_star_sheet_AccessiblePageHeaderFooterAreasView_idl__
#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
#include <com/sun/star/accessibility/XAccessibleContext.idl>
#endif
#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
#include <com/sun/star/accessibility/XAccessibleComponent.idl>
#endif
#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
#endif
//=============================================================================
module com { module sun { module star { module sheet {
//=============================================================================
/** The accessible view of the Header/Footer in a spreadsheet page preview
@since OpenOffice 1.1.2
*/
published service AccessiblePageHeaderFooterAreasView
{
/** This interface gives access to the three Header/Footer areas in the
page preview.
<ul>
<li>The parent returned by <method scope="::com::sun::star::accessibility"
>XAccessibleContext::getAccessibleParent</method>
is the accessible spreadsheet page preview.</li>
<li>The children returned by
<method scope="::com::sun::star::accessibility"
>XAccessibleContext::getAccessibleChild</method> all
support the interface
<type scope="::com::sun::star::accessibility">XAccessible</type.
Calling
<method scope="::com::sun::star::accessibility"
>XAccessible::getAccessibleContext</method> for these children
returns an object that supports one of the following services.</li>
<ul>
<li><type scope="::com::sun::star::text">AccessibleHeaderFooterView</type>:
A child where calling <method scope="::com::sun::star::text"
>XAccessibleContext::getAccessibleChild</method>
an object that supports this service is returned for
every header and footer that is at least partially visible.</li>
</ul>
<p>The following rules apply to the children order.</p>
<ul>
<li>The first is the left area, than the centre area and the last
is the right area.</li>
</ul>
<li>The description is ???.</li>
<li>The name is Header or Footer respectively.</li>
<li>The role is <const scope="::com::sun::star::accessibility"
>AccessibleRole::HEADER</const> or
<const scope="::com::sun::star::accessibility"
>AccessibleRole::FOOTER</const>.</li>
<li>There are no relations.</li>
<li>The following states are supported:
<ul>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::DEFUNC</const> is always false until
the preview is closed.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::EDITABLE</const> is always false,
because the document is not editable in the page preview.
So it is left out of the list.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::ENABLED</const> is always true.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::MULTILINE</const> makes no sense on
a document and so it is left out of the list.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::MULTISELECTABLE</const> is always
false, because in a page preview a selection is not
possible. So it is left out of the list.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::OPAQUE</const> is always true.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::RESIZEABLE</const> is always false,
because you can resize the window of the page preview, but
not the page preview itself. So it is left out of the
list.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::SELECTABLE</const> is always false,
because in the page preview is no selection possible. So it
is left out of the list.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::SELECTED</const> is always false,
because in the page preview is no selection possible. So it
is left out of the list.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::SHOWING</const>Is true if the
Bounding Box lies in the Bounding Box of the parent.
Otherwise it is false.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::VISIBLE</const>Is always true.</li>
</ul>
</li>
</ul>
*/
interface ::com::sun::star::accessibility::XAccessibleContext;
/** This interface gives access to the visibility of the document.
*/
interface ::com::sun::star::accessibility::XAccessibleComponent;
/** This is the interface for listeners */
interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
};
//=============================================================================
}; }; }; };
#endif