| /************************************************************** |
| * |
| * 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_AccessibleEndnoteView_idl__ |
| #define __com_sun_star_text_AccessibleEndnoteView_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 text { |
| |
| //============================================================================= |
| |
| /** The accessible view of pagees. |
| |
| |
| @since OpenOffice 1.1.2 |
| */ |
| published service AccessiblePageView |
| { |
| /** This interface gives access to any page that is visible in the |
| page preview of a text document. |
| |
| <ul> |
| <li>The parent returned by |
| <method scope="::com::sun::star::accessibility" |
| >XAccessibleContext::getAccessibleParent</method> is the |
| accessible page preview of a text document. That is, the |
| object returned by |
| <method scope="::com::sun::star::accessibility" |
| >XAccessible::getAccessibleContext</method> supports |
| <type scope="::com::sun::star::text" |
| >AccessibleTextDocumentPageView</type>. |
| <li>The children returned by |
| <method scope="::com::sun::star::accessibility" |
| >XAccessibleContext::getAccessibleChild</method> all |
| support the interface XAccessible. Calling |
| <method scope="::com::sun::star::accessibility" |
| >XAccessible::getAccessibleContext</method> for these |
| children returns an object that supports one of the |
| following services. |
| <ul> |
| <li><type scope="::com::sun::star::text" |
| >AccessibleHeaderFooterView</type>: |
| A child of this kind is returned for every header |
| and footer that is conatined in the page. |
| <li><type scope="::com::sun::star::text" |
| >AccessibleFootnoteView</type>: |
| A child of this kind is returned for every footnote |
| that is conatined in the page. |
| <li><type scope="::com::sun::star::text" |
| >AccessibleEndnoteView</type>: |
| A child of this kind is returned for every endnote |
| that is conatined in the page. |
| <li><type scope="::com::sun::star::text" |
| >AccessibleParagraphView</type>: |
| A child of this kind is returned for every paragraph |
| fragment that is contained in the page. |
| A paragraph fragment is the part of a paragraph that |
| is displayed on a certain page. |
| <li><type scope="::com::sun::star::table" |
| >AccessibleTableView</type>: |
| A child of this kind is returned for every table |
| fragment that is contained in the page. |
| A table fragment is the part of a table that is |
| displayed on a certain page. |
| <li><type scope="::com::sun::star::text" |
| >AccessibleTextFrameView</type>: |
| A child of this kind is returned for every text |
| frame that is conrtained in the page. These objects |
| are children of the <type>AccessiblePageView</type> |
| regardless whether they are bound to the page, a |
| paragarph, a frame, or a character. The only |
| exception are text frames that are bound as |
| character. They are childen of the paragraph they |
| are contained in. |
| <li><type scope="::com::sun::star::text" |
| >AccessibleTextGraphicObject</type>: |
| A child of this kind is returned for every graphic that |
| is contained in the page. These objects are |
| children of the <type>AccessiblePageView</type> |
| regardless whether they are bound to a page, paragraph, |
| a frame or a character. The only exception |
| are text frames that are bound as character. They are |
| childen of the paragraph they are contained in. |
| <li><type scope="::com::sun::star::text" |
| >AccessibleTextEmbeddedObject</type>: |
| A child of this kind is returned for every embedded |
| object that is conatained in the page. |
| These objects are children of the |
| <type>AccessibleTextDocumentView</type> regardless |
| whether they are bound to a page, a paragarph, a frame, |
| or a character. They are childen of the paragraph they |
| are contained in. |
| <li><type scope="::com::sun::star::drawing" |
| >AccessibleShape</type>: |
| A child of this kind (or one of its derived |
| interfaces) is returned for every shape that is |
| contained in the page. These objects are children of |
| the <type>AccessibleTextDocumentView</type> |
| regardless whether they are bound to a page, a |
| paragraph, a frame or a character. |
| </ul> |
| <p>The following rules apply to the children order: |
| <ul> |
| <li>The logical order of paragraph and table fragments is |
| never changed. |
| <li>Headers appear immediately before the first paragraph or |
| table fragment of the header's page. |
| <li>Footnotes appear immediately after the last paragraph or |
| table fragment of the footnote's page. The logical order |
| of footnotes isn't changed. |
| <li>Endnotes appear immediately after the last footnote of |
| the endnote's page or after the last paragraph or |
| table fragment of this page if there are no footnotes. |
| The logical order of endnotes isn't changed. |
| <li>Footers appear immediately after the last endnote, |
| footnote, paragraph or table fragment of the footer's |
| page. |
| <li>Text frames, graphics, embedded objects and shapes that |
| are painted in the background appear before any other |
| children. Their order reflects the z order. |
| <li>Text frames, graphics, embedded objects and shapes |
| that are painted in the foreground appear behind any |
| other children. Their order reflects the z order, |
| with the exception of controls that appear really last, |
| but also keep the z order. |
| </ul> |
| <li>The role is <const scope="::com::sun::star::accessibility" |
| >AccessibleRole::PANEL</const> |
| <li>The name is "page" (or the equivalent term |
| in application's language) with a number appended. |
| <li>The description is "page" (or the equivalent term |
| in application's language) with the page number or |
| character appended in the format that is specified in the |
| page style. |
| <li>There are no relations.</li> |
| <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 or the endnote |
| is not existing any longer)</li> |
| <li><const scope="::com::sun::star::accessibility" |
| >AccessibleStateType::ENABLED</const> (always |
| contained)</li> |
| <li><const scope="::com::sun::star::accessibility" |
| >AccessibleStateType::OPAQUE</const> |
| <li><const scope="::com::sun::star::accessibility" |
| >AccessibleStateType::FOCUSABLE</const> |
| <li><const scope="::com::sun::star::accessibility" |
| >AccessibleStateType::FOCUSED</const> |
| <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 |
| endnote. |
| */ |
| interface ::com::sun::star::accessibility::XAccessibleComponent; |
| |
| /** This is the interface for listeners */ |
| interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |
