offapi/com/sun/star/text/TableColumnSeparator.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 #ifndef __com_sun_star_text_TableColumnSeparator_idl__
  20 #define __com_sun_star_text_TableColumnSeparator_idl__
  21
  22
  23
  24  module com {  module sun {  module star {  module text {
  25
  26
  27 /** The width of the cells of a text table is defined by the position
  28     of the separator between neighboring cells.
  29
  30     <p>If cells of the table are merged, this separator is not removed, but
  31     it is hidden.
  32     </p>
  33
  34     <p>A text table or a text table row provides the separators in a
  35     sequence of TableColumnSeparators. If the table only
  36     consists of one column, then this sequence is empty.
  37
  38     </p>
  39     <p>The real width of a table depends on the environment (page style and
  40     number of text columns at the table's position, alignment, and left and
  41     right margins).  For that reason, the table column separator does not
  42     contain metric values for the column widths. The values are relative
  43     to the value of the property TextTable::TableColumnRelativeSum.
  44
  45     </p>
  46     <p>A table provides this property only if all rows have the same structure.
  47     If the table does not provide the property, then it cannot be set using.
  48     </p>
  49
  50     <p>The state of TableColumnSeparator::IsVisible and the
  51     count of the sequence must be the same in as it was in.
  52     Hidden separators cannot be moved and they cannot be overtaken by visible
  53     separators.</p>
  54
  55     @see com::sun::star::text::TextTable
  56  */
  57 published struct TableColumnSeparator
  58 {
  59     /** contains the position of the separator.
  60      */
  61     short Position;
  62
  63
  64     /** determines if the separator is visible.
  65      */
  66     boolean IsVisible;
  67
  68 };
  69
  70
  71 }; }; }; };
  72
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */