offapi/com/sun/star/table/TableColumn.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
  21 module com {  module sun {  module star {  module table {
  22
  23
  24 /** represents a special cell range containing all cells of a single
  25     specific column in a table or spreadsheet.
  26  */
  27 published service TableColumn
  28 {
  29
  30     /** provides access to the cells of this column.
  31
  32         @see com::sun::star::table::CellRange
  33      */
  34     interface com::sun::star::table::XCellRange;
  35
  36
  37 //!published service PropertySet
  38     /** provides access to the cell properties of all cells of this column.
  39      */
  40     interface com::sun::star::beans::XPropertySet;
  41
  42
  43     /** provides methods to access the name of the column.
  44
  45         <p>In spreadsheets, the name of a column cannot be changed.</p>
  46      */
  47     interface com::sun::star::container::XNamed;
  48
  49
  50     /** contains the width of the column (in 1/100th mm).
  51
  52         <p>When hidden, it returns the width which the column would have,
  53         if it were visible. </p>
  54      */
  55     [property] long Width;
  56
  57
  58     /** is `TRUE`, if the column always keeps its optimal width.
  59      */
  60     [property] boolean OptimalWidth;
  61
  62
  63     /** is `TRUE`, if the column is visible.
  64      */
  65     [property] boolean IsVisible;
  66
  67
  68     /** is `TRUE`, if there is a manual horizontal page break attached
  69         to the column.
  70      */
  71     [property] boolean IsStartOfNewPage;
  72
  73 };
  74
  75
  76 }; }; }; };
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */