offapi/com/sun/star/text/Cell.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Cell.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_text_Cell_idl__
  32 #define __com_sun_star_text_Cell_idl__
  33
  34 #ifndef __com_sun_star_text_CellProperties_idl__
  35 #include <com/sun/star/text/CellProperties.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_CellProperties_idl__
  39 #include <com/sun/star/table/CellProperties.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_table_XCell_idl__
  43 #include <com/sun/star/table/XCell.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_text_XText_idl__
  47 #include <com/sun/star/text/XText.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module text {
  53
  54 //=============================================================================
  55
  56 /** represents a singe cell within a text table.
  57
  58     @see com::sun::star::text::TextTable
  59  */
  60 service Cell
  61 {
  62     //-------------------------------------------------------------------------
  63     /** contains the properties of the text table cell.
  64        */
  65     service com::sun::star::text::CellProperties;
  66
  67     //-------------------------------------------------------------------------
  68     /** contains properties from table cells.
  69
  70         <p>All of these properties are either already availbale in the
  71         service
  72         <type scope="com::sun::star::text">CellProperties</type>,
  73         or get matched against one of those or are implemented
  74         non-functional since they serve no purpose for text tables.</p>
  75
  76         <p>The complete list is as follows:</p>
  77         <ul>
  78             <li>CellStyle: optional property, not implemented.</li>
  79             <li>CellBackColor: matched to 'BackColor'.</li>
  80             <li>IsCellBackgroundTransparent: matched to 'BackTransparent'.</li>
  81             <li>HoriJustify: non-functional implementation.</li>
  82             <li>VertJustify: non-functional implementation.</li>
  83             <li>IsTextWrapped: non-functional implementation.</li>
  84             <li>ParaIndent: non-functional implementation.</li>
  85             <li>Orientation: non-functional implementation.</li>
  86             <li>RotateAngle: non-functional implementation.</li>
  87             <li>RotateReference: non-functional implementation.</li>
  88             <li>AsianVerticalMode: optional property, not implemented.</li>
  89             <li>TableBorder: non-functional implementation.</li>
  90             <li>TopBorder: already available.</li>
  91             <li>BottomBorder: already available.</li>
  92             <li>LeftBorder: already available.</li>
  93             <li>RightBorder: already available.</li>
  94             <li>NumberFormat: already available.</li>
  95             <li>ShadowFormat: non-functional implementation.</li>
  96             <li>CellProtection: non-functional implementation.</li>
  97         </ul>
  98
  99         @since OOo 2.0.0
 100      */
 101     service com::sun::star::table::CellProperties;
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** provides access to the cell contents.
 106      */
 107     interface com::sun::star::table::XCell;
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** provides access to formatted and unformatted text contents.
 112      */
 113     interface com::sun::star::text::XText;
 114
 115 };
 116
 117 //=============================================================================
 118
 119 }; }; }; };
 120
 121 #endif
 122