diff options
author | Vladimir Glazounov <vg@openoffice.org> | 2003-04-24 16:47:09 +0000 |
---|---|---|
committer | Vladimir Glazounov <vg@openoffice.org> | 2003-04-24 16:47:09 +0000 |
commit | cad6ad71cf9b2f4422ebe41ae98caeca44717869 (patch) | |
tree | 19ebdfe1034e96fc35a861e9d460a3a3078c02b2 /offapi/com/sun/star/text/AccessibleFootnoteView.idl | |
parent | 10567433603d35724b6b808155e90e10488411b7 (diff) |
INTEGRATION: CWS uaa02 (1.1.2); FILE ADDED
2003/04/16 12:22:40 mt 1.1.2.2: #108656# removed 'drafts'
2003/04/14 15:58:07 dvo 1.1.2.1: #108917# move accessible text service description from drafts module
Diffstat (limited to 'offapi/com/sun/star/text/AccessibleFootnoteView.idl')
-rw-r--r-- | offapi/com/sun/star/text/AccessibleFootnoteView.idl | 157 |
1 files changed, 157 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/AccessibleFootnoteView.idl b/offapi/com/sun/star/text/AccessibleFootnoteView.idl new file mode 100644 index 000000000000..eab63834d594 --- /dev/null +++ b/offapi/com/sun/star/text/AccessibleFootnoteView.idl @@ -0,0 +1,157 @@ +/************************************************************************* + * + * $RCSfile: AccessibleFootnoteView.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: vg $ $Date: 2003-04-24 17:47:09 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_text_AccessibleFootnoteView_idl__ +#define __com_sun_star_text_AccessibleFootnoteView_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 footnotes. + + */ +service AccessibleFootnoteView +{ + /** This interface gives access to any paragraph fragment and table + fragment that is contained in a footnote and is at least + partially visible on the screen. + + <ul> + <li>The parent returned by <type>getAccessibleParent</type> + 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 <type>getAccessibleChild</type> all + support the interface XAccessible. Calling + <type>getAccessibleContext</type> for these children returns + an object that supports one of the following services. + <ul> + <li><type>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>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 <type>FOOTNOTE</type> + <li>The name is "footnote" (or the equivalent term + in application's language) with a number appended. + <li>The description is footnote" (or the equivalent term + in application's language) with the footnote number or + character appended in the format that is specified in the + footnote settings. + <li>There are no relations. <em>TODO: One might specify a relation + to the footnote anchor's paragraph.</em> + <li>The following states might be contained in the state set + returned by <type>getAccessibleStateSet</type>: + <ul> + <li><type>DEFUNC</type> (indicates that the document + window has been closed or the footnote is + not existing any longer) + <li><type>EDITABLE</type> + <li><type>ENABLED</type> (always contained) + <li><type>OPAQUE</type> + <li><type>SHOWING</type> + <li><type>VISIBLE</type> + </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 + footnote. + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** This is the interface for listeners */ + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; +}; + +//============================================================================= + +}; }; }; }; + +#endif |