offapi/com/sun/star/text/TextColumns.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 #ifndef __com_sun_star_text_TextColumns_idl__
  20 #define __com_sun_star_text_TextColumns_idl__
  21
  22 #include <com/sun/star/text/XTextColumns.idl>
  23 #include <com/sun/star/style/VerticalAlignment.idl>
  24 #include <com/sun/star/util/Color.idl>
  25
  26
  27  module com {  module sun {  module star {  module text {
  28
  29 /** provides access to columns in text (e.g., in TextFrames ).
  30  */
  31 published service TextColumns
  32 {
  33     interface com::sun::star::text::XTextColumns;
  34
  35     /** determines whether the columns all have equal width. This flag is set if XTextColumns::setColumnCount() is called
  36      and it is reset if XTextColumns::setColumns() is called.
  37      */
  38     [readonly, property]  boolean IsAutomatic;
  39     /** contains the distance between the columns. It is valid if the property IsAutomatic is set.
  40  <!-- The h -->Half of this distance is set to the left and right margins of all columns,
  41     except for the left margin of the first column, and the right margin of the last column.*/
  42     [property]  long AutomaticDistance;
  43     /** determines the width of the separator lines between the columns.
  44      */
  45     [property]  long SeparatorLineWidth;
  46     /** determines the color of the separator lines between the columns.
  47      */
  48     [property]  com::sun::star::util::Color SeparatorLineColor;
  49     /** determines the relative height of the separator lines between the columns.
  50      */
  51     [property]  long SeparatorLineRelativeHeight;
  52     /** determines the vertical alignment of the separator lines between the columns.
  53      */
  54     [property]  com::sun::star::style::VerticalAlignment SeparatorLineVerticalAlignment;
  55     /** determines whether separator lines are on.
  56      */
  57     [property]  boolean SeparatorLineIsOn;
  58     /** determines the style of the separator lines between the columns.
  59         @see com::sun::star::text:ColumnSeparatorStyle
  60             for the possible values.
  61      */
  62     [property, optional]  short SeparatorLineStyle;
  63 };
  64
  65
  66 }; }; }; };
  67
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */