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