xref: /trunk/main/offapi/com/sun/star/text/LineNumberingProperties.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_text_LineNumberingProperties_idl__
#define __com_sun_star_text_LineNumberingProperties_idl__

#ifndef __com_sun_star_text_XLineNumberingProperties_idl__
#include <com/sun/star/text/XLineNumberingProperties.idl>
#endif

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

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

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

// DocMerge from xml: service com::sun::star::text::LineNumberingProperties
/** provides access to the settings of the line numbering.
 */
published service LineNumberingProperties
{
	//-------------------------------------------------------------------------

	/** If <TRUE/>, line numbering is used.
	 */
	[property] boolean IsOn;

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

	/** The name of the character style that is used for the line number.
	 */
	[property] string CharStyleName;

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

	/** If <TRUE/>, empty lines are counted.
	 */
	[property] boolean CountEmptyLines;

	//-------------------------------------------------------------------------
	/** If <TRUE/>, lines in frames are included in counting.
	 */
	[property] boolean CountLinesInFrames;

	//-------------------------------------------------------------------------
	/** specifies the distance between the line number and the start or
		end of the text area.
	 */
	[property] long Distance;

	//-------------------------------------------------------------------------
	/** Line numbers are shown on every <var>Interval</var>th line.
	 */
	[property] short Interval;

	//-------------------------------------------------------------------------
	/** specifies the string that is used for the line separator.
	 */
	[property] string SeparatorText;

	//-------------------------------------------------------------------------
	/** The line separator is shown every <var>SeparatorInterval</var>th line.
	 */
	[property] short SeparatorInterval;

	//-------------------------------------------------------------------------
	/** specifies the position of the line number (constant LineNumberPositions
		left/right/inside/outside).
	 */
	[property] short NumberPosition;

	//-------------------------------------------------------------------------
	/** specifies the type of the numbering.
	 */
	[property] short NumberingType;

    //-------------------------------------------------------------------------
    /** specifies if the line numbering should start from the
        beginning at each page.

        <p>If set to <FALSE/> the line numbering will be continous.</p>

        @since OOo 2.0
     */
    [optional, property] boolean RestartAtEachPage;

};

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

}; }; }; };

#endif