offapi/com/sun/star/text/LineNumberingSettings.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_LineNumberingSettings_idl__
  28 #define __com_sun_star_text_LineNumberingSettings_idl__
  29
  30
  31 //=============================================================================
  32
  33  module com {  module sun {  module star {  module text {
  34
  35 //=============================================================================
  36
  37 /** provides access to the settings of the line numbering.
  38     @deprecated
  39
  40     Actually there never was an implementation for this service.
  41  */
  42 published service LineNumberingSettings
  43 {
  44     //-------------------------------------------------------------------------
  45
  46     /** If <TRUE/>, line numbering is used.
  47      */
  48     [property] boolean On;
  49
  50     //-------------------------------------------------------------------------
  51
  52     /** The name of the character style that is used for the line number.
  53      */
  54     [property] string CharStyle;
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** If <TRUE/>, empty lines are counted.
  59      */
  60     [property] boolean CountEmptyLines;
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** If <TRUE/>, lines in frames are included in counting.
  65      */
  66     [property] boolean CountLinesInFrames;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** specifies the distance between the line number and the start or
  71         end of the text area.
  72      */
  73     [property] long Distance;
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** Line numbers are shown on every <var>LineInterval</var>th line.
  78      */
  79     [property] short LineInterval;
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** specifies the symbol that is shown between the line numbers.
  84      */
  85     [property] string LineSeparator;
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** The line separator is shown every <var>SeparatorLineDistance</var>th line.
  90      */
  91     [property] short SeparatorLineDistance;
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** specifies the position of the line number
  96         (constant <type scope="com::sun::star::style::">LineNumberPosition</type> - left/right/inside/outside).
  97      */
  98     [property] short NumberPosition;
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** specifies the type of the numbering.
 103      */
 104     [property] short NumberingType;
 105
 106 };
 107
 108 //=============================================================================
 109
 110 }; }; }; };
 111 #endif