offapi/com/sun/star/table/TableRow.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_table_TableRow_idl__
  21 #define __com_sun_star_table_TableRow_idl__
  22
  23 #include <com/sun/star/table/XCellRange.idl>
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25
  26
  27 module com {  module sun {  module star {  module table {
  28
  29
  30 /** represents a special cell range containing all cells of a single
  31     specific row in a table or spreadsheet.
  32  */
  33 published service TableRow
  34 {
  35
  36     /** provides access to the cells of this row.
  37
  38         @see com::sun::star::table::CellRange
  39      */
  40     interface com::sun::star::table::XCellRange;
  41
  42
  43 //!published service PropertySet
  44     /** provides access to the cell properties of all cells of this row.
  45      */
  46     interface com::sun::star::beans::XPropertySet;
  47
  48
  49     /** contains the height of the row (in 1/100 mm).
  50
  51         <p>When hidden, it returns the height which the row would have,
  52         if it were visible. </p>
  53      */
  54     [property] long Height;
  55
  56
  57     /** is `TRUE`, if the row always keeps its optimal height.
  58      */
  59     [property] boolean OptimalHeight;
  60
  61
  62     /** is `TRUE`, if the row is visible.
  63      */
  64     [property] boolean IsVisible;
  65
  66
  67     /** is `TRUE`, if there is a manual vertical page break attached
  68         to the row.
  69      */
  70     [property] boolean IsStartOfNewPage;
  71
  72 };
  73
  74
  75 }; }; }; };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */