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