offapi/com/sun/star/table/TableBorder.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: TableBorder.idl,v $
  10  * $Revision: 1.8 $
  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
  31 #ifndef __com_sun_star_table_TableBorder_idl__
  32 #define __com_sun_star_table_TableBorder_idl__
  33
  34 #ifndef __com_sun_star_table_BorderLine_idl__
  35 #include <com/sun/star/table/BorderLine.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module table {
  41
  42 //=============================================================================
  43
  44 /** contains the style settings of the border lines of all cells in a cell
  45     range.
  46
  47     <p>In a queried structure, the flags in
  48     <member>TableBorder::Is...LineValid</member> indicate that not all
  49     lines of the boxes have the same values.</p>
  50
  51     <p>In a structure which is used for setting, these flags determine
  52     if the corresponding line should be set or if the old value should
  53     be kept.</p>
  54  */
  55 published struct TableBorder
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** determines the line style at the top edge.
  60      */
  61     com::sun::star::table::BorderLine TopLine;
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** specifies whether the value of <member>TableBorder::TopLine</member>
  66         is used.
  67      */
  68     boolean IsTopLineValid;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** determines the line style at the bottom edge.
  73      */
  74     com::sun::star::table::BorderLine BottomLine;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** specifies whether the value of
  79         <member>TableBorder::BottomLine</member> is used.
  80      */
  81     boolean IsBottomLineValid;
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** determines the line style at the left edge.
  86      */
  87     com::sun::star::table::BorderLine LeftLine;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** specifies whether the value of <member>TableBorder::LeftLine</member>
  92         is used.
  93      */
  94     boolean IsLeftLineValid;
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** determines the line style at the right edge.
  99      */
 100     com::sun::star::table::BorderLine RightLine;
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** specifies whether the value of <member>TableBorder::RightLine</member>
 105         is used.
 106      */
 107     boolean IsRightLineValid;
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** determines the line style of horizontal lines for the inner part
 112         of a cell range.
 113      */
 114     com::sun::star::table::BorderLine HorizontalLine;
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** specifies whether the value of
 119         <member>TableBorder::HorizontalLine</member> is used.
 120      */
 121     boolean IsHorizontalLineValid;
 122
 123     //-------------------------------------------------------------------------
 124
 125     /** determines the line style of vertical lines for the inner part
 126         of a cell range.
 127      */
 128     com::sun::star::table::BorderLine VerticalLine;
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** specifies whether the value of
 133         <member>TableBorder::VerticalLine</member> is used.
 134      */
 135     boolean IsVerticalLineValid;
 136
 137     //-------------------------------------------------------------------------
 138
 139     /** contains the distance between the lines and other contents.
 140      */
 141     short Distance;
 142
 143     //-------------------------------------------------------------------------
 144
 145     /** specifies whether the value of <member>TableBorder::Distance</member>
 146         is used.
 147      */
 148     boolean IsDistanceValid;
 149
 150 };
 151
 152 //=============================================================================
 153
 154 }; }; }; };
 155
 156 #endif
 157