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