offapi/com/sun/star/table/TableBorderDistances.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: TableBorderDistances.idl,v $
  10  * $Revision: 1.4 $
  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_TableBorderDistances_idl__
  32 #define __com_sun_star_table_TableBorderDistances_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 distance 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>TableBorderDistances::Is...DistanceValid</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 distance should be set or if the old value should
  53     be kept.</p>
  54  */
  55 published struct TableBorderDistances
  56 {
  57
  58         /** contains the distance between the top lines and other contents.
  59      */
  60         short TopDistance;
  61
  62     //-------------------------------------------------------------------------
  63
  64         /** specifies whether the value of <member>TableBorder::TopDistance</member>
  65         is used.
  66      */
  67         boolean IsTopDistanceValid;
  68         //-------------------------------------------------------------------------
  69
  70         /** contains the distance between the bottom lines and other contents.
  71          */
  72         short BottomDistance;
  73
  74         //-------------------------------------------------------------------------
  75
  76         /** specifies whether the value of <member>TableBorder::BottomDistance</member>
  77                 is used.
  78          */
  79         boolean IsBottomDistanceValid;
  80         //-------------------------------------------------------------------------
  81
  82         /** contains the distance between the left lines and other contents.
  83          */
  84         short LeftDistance;
  85
  86         //-------------------------------------------------------------------------
  87
  88         /** specifies whether the value of <member>TableBorder::LeftDistance</member>
  89                 is used.
  90          */
  91         boolean IsLeftDistanceValid;
  92         //-------------------------------------------------------------------------
  93
  94         /** contains the distance between the right lines and other contents.
  95          */
  96         short RightDistance;
  97
  98         //-------------------------------------------------------------------------
  99
 100         /** specifies whether the value of <member>TableBorder::RightDistance</member>
 101                 is used.
 102          */
 103         boolean IsRightDistanceValid;
 104
 105 };
 106
 107 //=============================================================================
 108
 109 }; }; }; };
 110
 111 #endif
 112