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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module text {
  22
  23 /** provides access to the settings of the line numbering.
  24  */
  25 published service LineNumberingProperties
  26 {
  27
  28     /** If `TRUE`, line numbering is used.
  29      */
  30     [property] boolean IsOn;
  31
  32
  33     /** The name of the character style that is used for the line number.
  34      */
  35     [property] string CharStyleName;
  36
  37
  38     /** If `TRUE`, empty lines are counted.
  39      */
  40     [property] boolean CountEmptyLines;
  41
  42     /** If `TRUE`, lines in frames are included in counting.
  43      */
  44     [property] boolean CountLinesInFrames;
  45
  46     /** specifies the distance between the line number and the start or
  47         end of the text area.
  48      */
  49     [property] long Distance;
  50
  51     /** Line numbers are shown on every <var>Interval</var>th line.
  52      */
  53     [property] short Interval;
  54
  55     /** specifies the string that is used for the line separator.
  56      */
  57     [property] string SeparatorText;
  58
  59     /** The line separator is shown every <var>SeparatorInterval</var>th line.
  60      */
  61     [property] short SeparatorInterval;
  62
  63     /** specifies the position of the line number (constant LineNumberPositions
  64         left/right/inside/outside).
  65      */
  66     [property] short NumberPosition;
  67
  68     /** specifies the type of the numbering.
  69      */
  70     [property] short NumberingType;
  71
  72     /** specifies if the line numbering should start from the
  73         beginning at each page.
  74
  75         <p>If set to `FALSE` the line numbering will be continuous.</p>
  76
  77         @since OOo 2.0
  78      */
  79     [optional, property] boolean RestartAtEachPage;
  80
  81 };
  82
  83
  84 }; }; }; };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */