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

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