offapi/com/sun/star/table/TableBorder.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_table_TableBorder_idl__
  29 #define __com_sun_star_table_TableBorder_idl__
  30
  31 #ifndef __com_sun_star_table_BorderLine_idl__
  32 #include <com/sun/star/table/BorderLine.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module table {
  38
  39 //=============================================================================
  40
  41 /** contains the style settings of the border lines of all cells in a cell
  42     range.
  43
  44     <p>In a queried structure, the flags in
  45     <member>TableBorder::Is...LineValid</member> indicate that not all
  46     lines of the boxes have the same values.</p>
  47
  48     <p>In a structure which is used for setting, these flags determine
  49     if the corresponding line should be set or if the old value should
  50     be kept.</p>
  51  */
  52 published struct TableBorder
  53 {
  54     //-------------------------------------------------------------------------
  55
  56     /** determines the line style at the top edge.
  57      */
  58     com::sun::star::table::BorderLine TopLine;
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** specifies whether the value of <member>TableBorder::TopLine</member>
  63         is used.
  64      */
  65     boolean IsTopLineValid;
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** determines the line style at the bottom edge.
  70      */
  71     com::sun::star::table::BorderLine BottomLine;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** specifies whether the value of
  76         <member>TableBorder::BottomLine</member> is used.
  77      */
  78     boolean IsBottomLineValid;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** determines the line style at the left edge.
  83      */
  84     com::sun::star::table::BorderLine LeftLine;
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** specifies whether the value of <member>TableBorder::LeftLine</member>
  89         is used.
  90      */
  91     boolean IsLeftLineValid;
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** determines the line style at the right edge.
  96      */
  97     com::sun::star::table::BorderLine RightLine;
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** specifies whether the value of <member>TableBorder::RightLine</member>
 102         is used.
 103      */
 104     boolean IsRightLineValid;
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** determines the line style of horizontal lines for the inner part
 109         of a cell range.
 110      */
 111     com::sun::star::table::BorderLine HorizontalLine;
 112
 113     //-------------------------------------------------------------------------
 114
 115     /** specifies whether the value of
 116         <member>TableBorder::HorizontalLine</member> is used.
 117      */
 118     boolean IsHorizontalLineValid;
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** determines the line style of vertical lines for the inner part
 123         of a cell range.
 124      */
 125     com::sun::star::table::BorderLine VerticalLine;
 126
 127     //-------------------------------------------------------------------------
 128
 129     /** specifies whether the value of
 130         <member>TableBorder::VerticalLine</member> is used.
 131      */
 132     boolean IsVerticalLineValid;
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** contains the distance between the lines and other contents.
 137      */
 138     short Distance;
 139
 140     //-------------------------------------------------------------------------
 141
 142     /** specifies whether the value of <member>TableBorder::Distance</member>
 143         is used.
 144      */
 145     boolean IsDistanceValid;
 146
 147 };
 148
 149 //=============================================================================
 150
 151 }; }; }; };
 152
 153 #endif
 154