offapi/com/sun/star/table/TableRow.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: TableRow.idl,v $
  10  * $Revision: 1.10 $
  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_table_TableRow_idl__
  32 #define __com_sun_star_table_TableRow_idl__
  33
  34 #ifndef __com_sun_star_table_XCellRange_idl__
  35 #include <com/sun/star/table/XCellRange.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_XPropertySet_idl__
  39 #include <com/sun/star/beans/XPropertySet.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module table {
  45
  46 //=============================================================================
  47
  48 /** represents a special cell range containing all cells of a single
  49     specific row in a table or spreadsheet.
  50  */
  51 published service TableRow
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     /** provides access to the cells of this row.
  56
  57         @see com::sun::star::table::CellRange
  58      */
  59     interface com::sun::star::table::XCellRange;
  60
  61     //-------------------------------------------------------------------------
  62
  63 //!published service PropertySet
  64     /** provides access to the cell properties of all cells of this row.
  65      */
  66     interface com::sun::star::beans::XPropertySet;
  67
  68     //=========================================================================
  69
  70     /** contains the height of the row (in 1/100 mm).
  71
  72         <p>When hidden, it returns the height which the row would have,
  73         if it were visible. </p>
  74      */
  75     [property] long Height;
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** is <TRUE/>, if the row always keeps its optimal height.
  80      */
  81     [property] boolean OptimalHeight;
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** is <TRUE/>, if the row is visible.
  86      */
  87     [property] boolean IsVisible;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** is <TRUE/>, if there is a manual vertical page break attached
  92         to the row.
  93      */
  94     [property] boolean IsStartOfNewPage;
  95
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; };
 101
 102 #endif
 103