offapi/com/sun/star/text/LineNumberingSettings.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: LineNumberingSettings.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_LineNumberingSettings_idl__
  31 #define __com_sun_star_text_LineNumberingSettings_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module text {
  37
  38 //=============================================================================
  39
  40 /** provides access to the settings of the line numbering.
  41     @deprecated
  42
  43     Actually there never was an implementation for this service.
  44  */
  45 published service LineNumberingSettings
  46 {
  47     //-------------------------------------------------------------------------
  48
  49     /** If <TRUE/>, line numbering is used.
  50      */
  51     [property] boolean On;
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** The name of the character style that is used for the line number.
  56      */
  57     [property] string CharStyle;
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** If <TRUE/>, empty lines are counted.
  62      */
  63     [property] boolean CountEmptyLines;
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** If <TRUE/>, lines in frames are included in counting.
  68      */
  69     [property] boolean CountLinesInFrames;
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** specifies the distance between the line number and the start or
  74         end of the text area.
  75      */
  76     [property] long Distance;
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** Line numbers are shown on every <var>LineInterval</var>th line.
  81      */
  82     [property] short LineInterval;
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** specifies the symbol that is shown between the line numbers.
  87      */
  88     [property] string LineSeparator;
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** The line separator is shown every <var>SeparatorLineDistance</var>th line.
  93      */
  94     [property] short SeparatorLineDistance;
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** specifies the position of the line number
  99         (constant <type scope="com::sun::star::style::">LineNumberPosition</type> - left/right/inside/outside).
 100      */
 101     [property] short NumberPosition;
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** specifies the type of the numbering.
 106      */
 107     [property] short NumberingType;
 108
 109 };
 110
 111 //=============================================================================
 112
 113 }; }; }; };
 114 #endif