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