offapi/com/sun/star/style/ParagraphStyle.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 style {
  22
  23
  24 /** specifies a style sheet for paragraphs within a
  25     com::sun::star::text::Text.
  26  */
  27 published service ParagraphStyle
  28 {
  29     /// specifies administrative properties.
  30     service Style;
  31
  32     /** contains user defined attributes for paragraphs.
  33
  34         @see    com::sun::star::xml::ParaUserDefinedAttributesSupplier
  35      */
  36     [optional] service com::sun::star::xml::ParaUserDefinedAttributesSupplier;
  37
  38     /// specifies the style properties.
  39     service ParagraphProperties;
  40
  41     /** determines the left margin of the paragraph relative to the ParaLeftMargin
  42         of the parent style.
  43
  44         <p> If the value of ParaLeftMarginRelative is 100 the current
  45         ParaLeftMargin value is used. </p>
  46      */
  47     [property] long ParaLeftMarginRelative;
  48
  49
  50     /** determines the right margin of the paragraph relative to the ParaRightMargin
  51         of the parent style.
  52
  53         <p> If the value of ParaRightMarginRelative is 100 the current
  54         ParaRightMargin value is used. </p>
  55      */
  56     [property] long ParaRightMarginRelative;
  57
  58
  59     /** determines the top margin of the paragraph relative to the ParaTopMargin
  60         of the parent style.
  61
  62         <p> If the value of ParaTopMarginRelative is 100 the current
  63         ParaTopMargin value is used. </p>
  64      */
  65     [property] long ParaTopMarginRelative;
  66
  67
  68     /** determines the Bottom margin of the paragraph relative to the ParaBottomMargin
  69         of the parent style.
  70
  71         <p> If the value of ParaBottomMarginRelative is 100 the current
  72         ParaBottomMargin value is used. </p>
  73      */
  74     [property] long ParaBottomMarginRelative;
  75
  76     /** determines the category of a paragraph style. @see com::sun::star::style::ParagraphStyleCategory
  77      */
  78     [property] short Category;
  79
  80     [property] float CharDiffHeight;
  81
  82     /** This value contains the character height as percentage value relative to the height of
  83      the character in the parent style.
  84      */
  85     [property] short CharPropHeight;
  86
  87     /** This value contains the character height as difference in point to the height of
  88      the character in the parent style in Asian text.
  89      */
  90     [property] float CharDiffHeightAsian;
  91
  92     /** This value contains the character height as percentage value relative to the height of
  93      the character in the parent style in Asian text.
  94      */
  95     [property] short CharPropHeightAsian;
  96
  97     /** This value contains the character height as difference in point to the height of
  98      the character in the parent style in complex text.
  99      */
 100     [property] float CharDiffHeightComplex;
 101
 102     /** This value contains the character height as percentage value relative to the height of
 103      the character in the parent style in complex text.
 104      */
 105     [property] short CharPropHeightComplex;
 106
 107     /** returns the name of the page style in use
 108
 109         <P>For setting the page style you have to use the
 110         com::sun::star::text::PageDescName
 111         properties.
 112         </P>
 113     */
 114     [optional, readonly, property] string PageStyleName;
 115 };
 116
 117
 118 }; }; }; };
 119
 120 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */