diff options
Diffstat (limited to 'offapi/com/sun/star/accessibility/XAccessibleTable.idl')
| -rw-r--r-- | offapi/com/sun/star/accessibility/XAccessibleTable.idl | 110 |
1 files changed, 55 insertions, 55 deletions
diff --git a/offapi/com/sun/star/accessibility/XAccessibleTable.idl b/offapi/com/sun/star/accessibility/XAccessibleTable.idl index 708233a00cd7..3afed14d1f65 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleTable.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleTable.idl @@ -1,7 +1,7 @@ /************************************************************************* * * 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 @@ -28,9 +28,9 @@ #ifndef __com_sun_star_accessibility_XAccessibleTable_idl__ #define __com_sun_star_accessibility_XAccessibleTable_idl__ -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ #include <com/sun/star/lang/IndexOutOfBoundsException.idl> #endif @@ -46,7 +46,7 @@ module com { module sun { module star { module accessibility { <code>javax.accessibility.AccessibleTable</code> and <code>javax.accessibility.AccessibleExtendedTable</code> of the Java Accessibility API (version 1.4).</p> - + <p>All <type>XAccessible</type> objects that represent cells or cell-clusters of a table have to be at the same time children of the table. This is necessary to be able to convert row and column indices @@ -54,7 +54,7 @@ module com { module sun { module star { module accessibility { <member>XAccessibleTable::getAccessibleIndex</member>, <member>XAccessibleTable::getAccessibleRow</member>, and <member>XAccessibleTable::getAccessibleColumn</member>.</p> - + <p>The range of valid coordinates for this interface are implementation dependent. However, that range includes at least the intervals from the from the first row or column with the index 0 up to the last (but not @@ -69,10 +69,10 @@ module com { module sun { module star { module accessibility { published interface XAccessibleTable : ::com::sun::star::uno::XInterface { /** Returns the number of used rows in the table. - + <p>The implementation, however, may allow the access of columns beyond this number.</p> - + @return Returns the number of used rows in the table or 0 for an empty table. @@ -80,22 +80,22 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface long getAccessibleRowCount (); /** Returns the number of used columns in the table. - + <p>The implementation, however, may allow the access of columns beyond this number.</p> - + @return Returns the number of used columns in the table or 0 for an empty table. */ long getAccessibleColumnCount (); - + /** Returns the description text of the specified row in the table. - + @param nRow The index of the row for which to retrieve the description. - + @return Returns the description text of the specified row in the table if such a description exists. Otherwise an empty string is @@ -111,10 +111,10 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface /** Returns the description text of the specified column in the table. - + @param nColumn The index of the column for which to retrieve the description. - + @return Returns the description text of the specified row in the table if such a description exists. Otherwise an empty string is @@ -129,18 +129,18 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface /** Returns the number of rows occupied by the Accessible at the specified row and column in the table. - + <p>The result differs from 1 if the specified cell spans multiple rows.</p> - + @param nRow Row index of the accessible for which to return the column extent. - + @param nColumn Column index of the accessible for which to return the column extent. - + @return Returns the row extent of the specified cell. @@ -154,18 +154,18 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface /** Returns the number of columns occupied by the Accessible at the specified row and column in the table. - + <p>The result differs from 1 if the specified cell spans multiple columns.</p> - + @param nRow Row index of the accessible for which to return the column extent. - + @param nColumn Column index of the accessible for which to return the column extent. - + @return Returns the column extent of the specified. @@ -179,10 +179,10 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface /** Returns the row headers as an <type>XAccessibleTable</type> object. - + <p>Content and size of the returned table are implementation dependent.</p> - + @return Returns allways a valid reference to an <type>XAccessibleTable</type> object. @@ -191,10 +191,10 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface /** Returns the column headers as an <type>XAccessibleTable</type> object. - + <p>Content and size of the returned table are implementation dependent.</p> - + @return Returns allways a valid reference to an <type>XAccessibleTable</type> object. @@ -203,7 +203,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface /** Returns a list of the indices of completely selected rows in a table. - + @return The returned sequence contains indices of all completely selected rows in the table. This sequence is in ascending @@ -213,7 +213,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface /** Returns a list of the indices of completely selected columns in a table. - + @return The returned sequence contains indices of all completely selected columns in the table. This sequence is in ascending @@ -223,10 +223,10 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface /** Returns a boolean value indicating whether the specified row is completely selected. - + @param nRow Index of the row for which to determine whether it is selected. - + @return Returns <TRUE/> if the specified row is selected completely and <FALSE/> otherwise. @@ -241,11 +241,11 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface /** Returns a boolean value indicating whether the specified column is completely selected. - + @param nColumn Index of the column for which to determine whether it is selected. - + @return Returns <TRUE/> if the specified column is selected completely and <FALSE/> otherwise. @@ -260,20 +260,20 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface /** Returns the <type>XAccessible</type> object at the specified row and column in the table. - + <p>This method has been renamed from the Java name <code>getAccessibleAt</code> to <member>XAccessibleTable::getAccessibleCellAt</member> to avoid ambiguities with the <member>XAccessibleComponent::getAccessibleAt</member> method when accessed, for instance, from StarBasic.</p> - + @param nRow The row index for which to retrieve the cell. - + @param nColumn The column index for which to retrieve the cell. - + @return If both row and column index are valid then the corresponding <type>XAccessible</type> object is returned that represents the @@ -287,9 +287,9 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface */ XAccessible getAccessibleCellAt ([in] long nRow, [in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); - + /** Returns the caption for the table. - + @return If the table has a caption then a reference to it is returned, else an empty reference is returned. @@ -297,7 +297,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface XAccessible getAccessibleCaption (); /** Returns the summary description of the table. - + @return Returns a reference to an implementation dependent <type>XAccessible</type> object representing the table's summary @@ -307,15 +307,15 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface /** Returns a boolean value indicating whether the accessible at the specified row and column is selected. - + @param nRow Row index of the cell for which to determine if the accessible object that spans that cell is selected. - + @param nColumn Column index of the cell for which to determine if the accessible object that spans that cell is selected. - + @return Returns <TRUE/> if the given row and column indices are valid and the specified accessible object is selected. Otherwise @@ -323,36 +323,36 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface */ boolean isAccessibleSelected ([in] long nRow, [in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); - + /** Returns the child index of the accessible object that spans the specified cell. - + <p>This is the same index that would be returned by calling <member>XAccessibleContext::getAccessibleIndexInParent</member> for that accessible object.</p> - + @param nRow Row index of the accessible object for which to return the child index. - + @param nColumn Row index of the accessible object for which to return the child index. - + @return Child index of the specified accessible object or -1 if one or both of the given indices is/are invalid. */ long getAccessibleIndex ([in] long nRow, [in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); - + /** Translate the given child index into the corresponding row index. - + @param nChildIndex Index of the child of the table for which to return the row index. - + @return Returns the row index of the cell of the specified child or the index of the first row if the child spans multiple rows. @@ -362,14 +362,14 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface */ long getAccessibleRow ([in] long nChildIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException); - + /** Translate the given child index into the corresponding column index. - + @param nChildIndex Index of the child of the table for which to return the column index. - + @return Returns the column index of the cell of the specified child or the index of the first column if the child spans multiple @@ -381,7 +381,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface long getAccessibleColumn ([in] long nChildIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException); }; - + }; }; }; }; #endif |