office-gobmx/offapi/com/sun/star/sheet/AccessibleCell.idl
Oliver Bolte e156125847 INTEGRATION: CWS sb18 (1.4.258); FILE MERGED
2004/05/21 15:02:34 sb 1.4.258.1: #i21150# Added published flag.
2004-06-03 21:25:30 +00:00

169 lines
7 KiB
Text

/*************************************************************************
*
* $RCSfile: AccessibleCell.idl,v $
*
* $Revision: 1.5 $
*
* last change: $Author: obo $ $Date: 2004-06-03 22:25:30 $
*
* 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_sheet_AccessibleCell_idl__
#define __com_sun_star_sheet_AccessibleCell_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_XAccessibleValue_idl__
#include <com/sun/star/accessibility/XAccessibleValue.idl>
#endif
#ifndef __com_sun_star_accessibility_XAccessibleText_idl__
#include <com/sun/star/accessibility/XAccessibleText.idl>
#endif
//=============================================================================
module com { module sun { module star { module sheet {
//=============================================================================
/** The accessible view of a spreadsheet document
@since #107627#
*/
published service AccessibleCell
{
/** This interface gives access to the whole content of the cell.
<ul>
<li>The parent returned by
<method scope="::com::sun::star::accessibility"
>XAccessibleContext::getAccessibleParent</method>
is the accessible spreadsheet.</li>
<li>This object has no children.</li>
<li>The description is ???.</li>
<li>The name is something like A10 or B23 or so on.</li>
<li>The role is <const scope="::com::sun::star::accessibility"
>AccessibleRole::TABLE_CELL</const></li>
<li>There are relations between the cell and the shapes with an anchor
on this cell.</li>
<li>The following states are supported:
<ul>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::DEFUNC</const> is always false if the
parent table is showed, otherwise it is true.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::EDITABLE</const> is false if the cell
or the table is protected, otherwise it is true.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::ENABLED</const> is always true.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::MULTILINE</const> is always true.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::MULTISELECTABLE</const> is always
true.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::OPAQUE</const> is false if the cell
has no background color or graphic, otherwise it is
true.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::RESIZEABLE</const> is false if the
table is protected, otherwise is it true.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::SELECTABLE</const> is always
true.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::SELECTED</const> is true, if the
cell is selected.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::TRANSIENT</const> is always true.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::SHOWING</const>Is true if the
Bounding Box lies in Bounding Box of the parent. Otherwise
it is false.</li>
<li><const scope="::com::sun::star::accessibility"
>AccessibleStateType::VISIBLE</const>Is false if the
column/row with this cell is filtered or hidden.
Otherwise is true.</li>
</ul>
</li>
</ul>
*/
interface ::com::sun::star::accessibility::XAccessibleContext;
/** This interface gives access to the visibility of the cell.
*/
interface ::com::sun::star::accessibility::XAccessibleComponent;
/** This interface gives access to the value of the cell.
*/
interface ::com::sun::star::accessibility::XAccessibleValue;
/** This interface gives access to the text representation of the cell content.
*/
interface ::com::sun::star::accessibility::XAccessibleText;
};
//=============================================================================
}; }; }; };
#endif