xref: /aoo42x/main/offapi/com/sun/star/text/Cell.idl (revision cdf0e10c)

/*************************************************************************
 *
 * 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_Cell_idl__
#define __com_sun_star_text_Cell_idl__

#ifndef __com_sun_star_text_CellProperties_idl__
#include <com/sun/star/text/CellProperties.idl>
#endif

#ifndef __com_sun_star_table_CellProperties_idl__
#include <com/sun/star/table/CellProperties.idl>
#endif

#ifndef __com_sun_star_table_XCell_idl__
#include <com/sun/star/table/XCell.idl>
#endif

#ifndef __com_sun_star_text_XText_idl__
#include <com/sun/star/text/XText.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module text {

//=============================================================================

/** represents a singe cell within a text table.

    @see com::sun::star::text::TextTable
 */
service Cell
{
    //-------------------------------------------------------------------------
    /** contains the properties of the text table cell.
  	 */
    service com::sun::star::text::CellProperties;

    //-------------------------------------------------------------------------
    /** contains properties from table cells.

        <p>All of these properties are either already availbale in the
        service
        <type scope="com::sun::star::text">CellProperties</type>,
        or get matched against one of those or are implemented
        non-functional since they serve no purpose for text tables.</p>

        <p>The complete list is as follows:</p>
        <ul>
            <li>CellStyle: optional property, not implemented.</li>
            <li>CellBackColor: matched to 'BackColor'.</li>
            <li>IsCellBackgroundTransparent: matched to 'BackTransparent'.</li>
            <li>HoriJustify: non-functional implementation.</li>
            <li>VertJustify: non-functional implementation.</li>
            <li>IsTextWrapped: non-functional implementation.</li>
            <li>ParaIndent: non-functional implementation.</li>
            <li>Orientation: non-functional implementation.</li>
            <li>RotateAngle: non-functional implementation.</li>
            <li>RotateReference: non-functional implementation.</li>
            <li>AsianVerticalMode: optional property, not implemented.</li>
            <li>TableBorder: non-functional implementation.</li>
            <li>TopBorder: already available.</li>
            <li>BottomBorder: already available.</li>
            <li>LeftBorder: already available.</li>
            <li>RightBorder: already available.</li>
            <li>NumberFormat: already available.</li>
            <li>ShadowFormat: non-functional implementation.</li>
            <li>CellProtection: non-functional implementation.</li>
        </ul>

        @since OOo 2.0
     */
    service com::sun::star::table::CellProperties;

	//-------------------------------------------------------------------------

	/** provides access to the cell contents.
	 */
	interface com::sun::star::table::XCell;

	//-------------------------------------------------------------------------

	/** provides access to formatted and unformatted text contents.
	 */
	interface com::sun::star::text::XText;

};

//=============================================================================

}; }; }; };

#endif