xref: /aoo4110/main/offapi/com/sun/star/text/XTextColumns.idl (revision b1cdbd2c)

/**************************************************************
 *
 * 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_text_XTextColumns_idl__
#define __com_sun_star_text_XTextColumns_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_text_TextColumn_idl__
#include <com/sun/star/text/TextColumn.idl>
#endif


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

 module com {  module sun {  module star {  module text {

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

// DocMerge from xml: interface com::sun::star::text::XTextColumns
/** manages columns within the object.



	<p>The values used are relative. So it is not necessary to know the
	width of the object. The sum of the relative width values depends on
	the object and is defined in "ReferenceValue."

	</p>
 */
published interface XTextColumns: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	// DocMerge from idl: method com::sun::star::text::XTextColumns::getReferenceValue
	/** @returns
				the sum of all values.

				<p>As described above, the width values are relative.
	 */
	long getReferenceValue();

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

	// DocMerge from idl: method com::sun::star::text::XTextColumns::getColumnCount
	/** @returns
				the number of columns.
	 */
	short getColumnCount();

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

	// DocMerge from xml: method com::sun::star::text::XTextColumns::setColumnCount
	/** sets the number of columns.



		<p>The minimum is 1 column.</p>
	 */
	void setColumnCount( [in] short nColumns );

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

	// DocMerge from idl: method com::sun::star::text::XTextColumns::getColumns
	/** returns the column description of the object.
				@see TextColumn
	 */
	sequence<com::sun::star::text::TextColumn> getColumns();

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

	// DocMerge from xml: method com::sun::star::text::XTextColumns::setColumns
	/** sets the descriptors of all columns.



		<p>The number of members in the sequence must be the same as the
		number of columns of the object.

		</p>@see TextColumn
	 */
	void setColumns( [in] sequence<com::sun::star::text::TextColumn> Columns );

};

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

}; }; }; };

#endif