blob: 7d2645163088e36933c7a23b5ff20d9b442fac38 [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_text_AccessibleTextDocumentPageView_idl__
#define __com_sun_star_text_AccessibleTextDocumentPageView_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_XAccessibleSelection_idl__
#include <com/sun/star/accessibility/XAccessibleSelection.idl>
#endif
#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
#endif
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
/** The accessible page preview of a text document.
@since OpenOffice 1.1.2
*/
published service AccessibleTextDocumentPageView
{
/** This interface gives access to page that are visible in the
page preview of a text document.
<ul>
<li>The children returned by
<method scope="::com::sun::star::accessibility"
>XAccessibleContext::getAccessibleChild</type> all support
the interface XAccessible. Calling
<method scope="::com::sun::star::accessibility"
>XAccessible::getAccessibleContext</type> for these children
returns an object that supports one of the service
<type scope="::com::sun::star::text"
>AccessiblePageView</type>.
<li>The role is <const scope="::com::sun::star::accessibility"
>AccessibleRole::DOCUMENT</const>.
<li>The name is "document view" (or the equivalent term
in application's language).
<li>The description also is "document view" (or the equivalent term
in application's language).
<li>There are no relation sets.
<li>The following states might be contained in the state set
returned by <method scope="::com::sun::star::accessibility"
>XAccessibleContext::getAccessibleStateSet</method>:
<ul>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::DEFUNC</const> (indicates that
the document window has been closed)
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::ENABLED</const> (always
contained)
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::OPAQUE</const> (always
contained)
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::SHOWING</const>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::VISIBLE</const>
</ul>
<li>The locale is the application's locale.
</ul>
*/
interface ::com::sun::star::accessibility::XAccessibleContext;
/** This interface describes the graphical representation of a text
document view.
*/
interface ::com::sun::star::accessibility::XAccessibleComponent;
/** This is the interface for listeners
*/
interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
};
//=============================================================================
}; }; }; };
#endif