offapi/com/sun/star/table/TableBorder2.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
  10 #ifndef __com_sun_star_table_TableBorder2_idl__
  11 #define __com_sun_star_table_TableBorder2_idl__
  12
  13 #include <com/sun/star/table/BorderLine2.idl>
  14
  15
  16 module com {  module sun {  module star {  module table {
  17
  18
  19 /** contains the style settings of the border lines of all cells in a cell
  20     range.
  21
  22     TableBorder2 is nearly identical to TableBorder, except that it has
  23     members of <type>BorderLine2</type> instead of
  24     <type>BorderLine</type>.
  25
  26     <p>In a queried structure, the flags in
  27     <member>TableBorder2::Is...LineValid</member> indicate that not all
  28     lines of the boxes have the same values.</p>
  29
  30     <p>In a structure which is used for setting, these flags determine
  31     if the corresponding line should be set or if the old value should
  32     be kept.</p>
  33
  34     @since LibreOffice 3.6
  35  */
  36 published struct TableBorder2
  37 {
  38
  39     /** determines the line style at the top edge.
  40      */
  41     com::sun::star::table::BorderLine2 TopLine;
  42
  43
  44     /** specifies whether the value of
  45         <member>TableBorder2::TopLine</member> is used.
  46      */
  47     boolean IsTopLineValid;
  48
  49
  50     /** determines the line style at the bottom edge.
  51      */
  52     com::sun::star::table::BorderLine2 BottomLine;
  53
  54
  55     /** specifies whether the value of
  56         <member>TableBorder2::BottomLine</member> is used.
  57      */
  58     boolean IsBottomLineValid;
  59
  60
  61     /** determines the line style at the left edge.
  62      */
  63     com::sun::star::table::BorderLine2 LeftLine;
  64
  65
  66     /** specifies whether the value of
  67         <member>TableBorder2::LeftLine</member> is used.
  68      */
  69     boolean IsLeftLineValid;
  70
  71
  72     /** determines the line style at the right edge.
  73      */
  74     com::sun::star::table::BorderLine2 RightLine;
  75
  76
  77     /** specifies whether the value of
  78         <member>TableBorder2::RightLine</member> is used.
  79      */
  80     boolean IsRightLineValid;
  81
  82
  83     /** determines the line style of horizontal lines for the inner part
  84         of a cell range.
  85      */
  86     com::sun::star::table::BorderLine2 HorizontalLine;
  87
  88
  89     /** specifies whether the value of
  90         <member>TableBorder2::HorizontalLine</member> is used.
  91      */
  92     boolean IsHorizontalLineValid;
  93
  94
  95     /** determines the line style of vertical lines for the inner part
  96         of a cell range.
  97      */
  98     com::sun::star::table::BorderLine2 VerticalLine;
  99
 100
 101     /** specifies whether the value of
 102         <member>TableBorder2::VerticalLine</member> is used.
 103      */
 104     boolean IsVerticalLineValid;
 105
 106
 107     /** contains the distance between the lines and other contents.
 108      */
 109     short Distance;
 110
 111
 112     /** specifies whether the value of
 113         <member>TableBorder2::Distance</member> is used.
 114      */
 115     boolean IsDistanceValid;
 116
 117 };
 118
 119
 120 }; }; }; };
 121
 122 #endif
 123
 124 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */