diff options
Diffstat (limited to 'offapi/com/sun/star/text/AccessibleEndnoteView.idl')
| -rw-r--r-- | offapi/com/sun/star/text/AccessibleEndnoteView.idl | 138 |
1 files changed, 138 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/AccessibleEndnoteView.idl b/offapi/com/sun/star/text/AccessibleEndnoteView.idl new file mode 100644 index 000000000000..c242c3c806e1 --- /dev/null +++ b/offapi/com/sun/star/text/AccessibleEndnoteView.idl @@ -0,0 +1,138 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 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 endnotes. + @since OOo 1.1.2 + */ +published service AccessibleEndnoteView +{ + /** This interface gives access to any paragraph fragment and table + fragment that is contained in a endnote and is at least + partially visible on the screen. + + <ul> + <li>The parent returned by + <method scope="::com::sun::star::accessibility" + >XAccessibleContext::getAccessibleParent</method> + is either the accessible view of a text document, + a page of the accessible page preview of a text document, + or the accessible page preview of a spreadsheet document. + <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" + >AccessibleParagraphView</type>: + A child of this kind is returned for every paragraph + fragment that is contained in the document body and + is at least partially visible. 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 document body + and is at least partially visible. A table fragment is + the part of a table that is displayed on a certain page. + </ul> + <p>The logical order of paragraph and table fragments is never + changed. + <li>The role is <const scope="::com::sun::star::accessibility" + >AccessibleRole::ENDNOTE</const> + <li>The name is "endnote" (or the equivalent term + in application's language) with a number appended. + <li>The description is endnote" (or the equivalent term + in application's language) with the endnote number or + character appended in the format that is specified in the + endnote settings. + <li>There are no relations. <em>TODO: One might specify a relation + to the endnote anchor's paragraph.</em> + <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><const scope="::com::sun::star::accessibility" + >AccessibleStateType::EDITABLE</const> + <li><const scope="::com::sun::star::accessibility" + >AccessibleStateType::ENABLED</const> (always contained) + <li><const scope="::com::sun::star::accessibility" + >AccessibleStateType::OPAQUE</const> + <li><const scope="::com::sun::star::accessibility" + >AccessibleStateType::SHOWING</const> + <li><const scope="::com::sun::star::accessibility" + >AccessibleStateType::VISIBLE</const> + </ul> + <li>Depending of the application's region setting, the locale is + the western, asian or complex default language of the document. + </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 |