offapi/com/sun/star/text/LineNumberingProperties.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: LineNumberingProperties.idl,v $
  10  * $Revision: 1.9 $
  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 #ifndef __com_sun_star_text_LineNumberingProperties_idl__
  31 #define __com_sun_star_text_LineNumberingProperties_idl__
  32
  33 #ifndef __com_sun_star_text_XLineNumberingProperties_idl__
  34 #include <com/sun/star/text/XLineNumberingProperties.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module text {
  40
  41 //=============================================================================
  42
  43 // DocMerge from xml: service com::sun::star::text::LineNumberingProperties
  44 /** provides access to the settings of the line numbering.
  45  */
  46 published service LineNumberingProperties
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** If <TRUE/>, line numbering is used.
  51      */
  52     [property] boolean IsOn;
  53
  54     //-------------------------------------------------------------------------
  55
  56     /** The name of the character style that is used for the line number.
  57      */
  58     [property] string CharStyleName;
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** If <TRUE/>, empty lines are counted.
  63      */
  64     [property] boolean CountEmptyLines;
  65
  66     //-------------------------------------------------------------------------
  67     /** If <TRUE/>, lines in frames are included in counting.
  68      */
  69     [property] boolean CountLinesInFrames;
  70
  71     //-------------------------------------------------------------------------
  72     /** specifies the distance between the line number and the start or
  73         end of the text area.
  74      */
  75     [property] long Distance;
  76
  77     //-------------------------------------------------------------------------
  78     /** Line numbers are shown on every <var>Interval</var>th line.
  79      */
  80     [property] short Interval;
  81
  82     //-------------------------------------------------------------------------
  83     /** specifies the string that is used for the line separator.
  84      */
  85     [property] string SeparatorText;
  86
  87     //-------------------------------------------------------------------------
  88     /** The line separator is shown every <var>SeparatorInterval</var>th line.
  89      */
  90     [property] short SeparatorInterval;
  91
  92     //-------------------------------------------------------------------------
  93     /** specifies the position of the line number (constant LineNumberPositions
  94         left/right/inside/outside).
  95      */
  96     [property] short NumberPosition;
  97
  98     //-------------------------------------------------------------------------
  99     /** specifies the type of the numbering.
 100      */
 101     [property] short NumberingType;
 102
 103     //-------------------------------------------------------------------------
 104     /** specifies if the line numbering should start from the
 105         beginning at each page.
 106
 107         <p>If set to <FALSE/> the line numbering will be continous.</p>
 108
 109         @since OOo 2.0.0
 110      */
 111     [optional, property] boolean RestartAtEachPage;
 112
 113 };
 114
 115 //=============================================================================
 116
 117 }; }; }; };
 118
 119 #endif
 120