xref: /aoo41x/main/offapi/com/sun/star/table/TableBorderDistances.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_table_TableBorderDistances_idl__
#define __com_sun_star_table_TableBorderDistances_idl__

#ifndef __com_sun_star_table_BorderLine_idl__
#include <com/sun/star/table/BorderLine.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module table {

//=============================================================================

/** contains the distance settings of the border lines of all cells in a cell
	range.

	<p>In a queried structure, the flags in
        <member>TableBorderDistances::Is...DistanceValid</member> indicate that not all
	lines of the boxes have the same values.</p>

	<p>In a structure which is used for setting, these flags determine
        if the corresponding distance should be set or if the old value should
	be kept.</p>
 */
published struct TableBorderDistances
{

        /** contains the distance between the top lines and other contents.
	 */
        short TopDistance;

	//-------------------------------------------------------------------------

        /** specifies whether the value of <member>TableBorder::TopDistance</member>
		is used.
	 */
        boolean IsTopDistanceValid;
        //-------------------------------------------------------------------------

        /** contains the distance between the bottom lines and other contents.
         */
        short BottomDistance;

        //-------------------------------------------------------------------------

        /** specifies whether the value of <member>TableBorder::BottomDistance</member>
                is used.
         */
        boolean IsBottomDistanceValid;
        //-------------------------------------------------------------------------

        /** contains the distance between the left lines and other contents.
         */
        short LeftDistance;

        //-------------------------------------------------------------------------

        /** specifies whether the value of <member>TableBorder::LeftDistance</member>
                is used.
         */
        boolean IsLeftDistanceValid;
        //-------------------------------------------------------------------------

        /** contains the distance between the right lines and other contents.
         */
        short RightDistance;

        //-------------------------------------------------------------------------

        /** specifies whether the value of <member>TableBorder::RightDistance</member>
                is used.
         */
        boolean IsRightDistanceValid;

};

//=============================================================================

}; }; }; };

#endif