xref: /trunk/main/offapi/com/sun/star/text/TextColumns.idl (revision cdf0e10c)
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_TextColumns_idl__
28#define __com_sun_star_text_TextColumns_idl__
29
30#ifndef __com_sun_star_text_XTextColumns_idl__
31#include <com/sun/star/text/XTextColumns.idl>
32#endif
33
34#ifndef __com_sun_star_style_VerticalAlignment_idl__
35#include <com/sun/star/style/VerticalAlignment.idl>
36#endif
37
38#ifndef __com_sun_star_util_Color_idl__
39#include <com/sun/star/util/Color.idl>
40#endif
41
42//=============================================================================
43
44 module com {  module sun {  module star {  module text {
45
46//=============================================================================
47
48// DocMerge from xml: service com::sun::star::text::TextColumns
49/** provides access to columns in text (e.g., in TextFrames ).
50 */
51published service TextColumns
52{
53	// DocMerge: empty anyway
54	interface com::sun::star::text::XTextColumns;
55
56    //------------------------------------------------------------------------
57    /** determines whether the columns all have equal width. This flag is set if XTextColumns::setColumnCount() is called
58     and it is reset if XTextColumns::setColumns() is called.
59	 */
60    [readonly, property]  boolean IsAutomatic;
61    //------------------------------------------------------------------------
62    /** contains the distance between the columns. It is valid if the property IsAutomatic is set.
63 <!-- The h -->Half of this distance is set to the left and right margins of all columns,
64	except for the left margin of the first column, and the right margin of the last column.*/
65    [property]  long AutomaticDistance;
66    //------------------------------------------------------------------------
67    /** determines the width of the separator lines between the columns.
68	 */
69    [property]  long SeparatorLineWidth;
70    //------------------------------------------------------------------------
71    /** determines the color of the separator lines between the columns.
72	 */
73    [property]  com::sun::star::util::Color SeparatorLineColor;
74    //------------------------------------------------------------------------
75    /** determines the relative height of the separator lines between the columns.
76	 */
77    [property]  long SeparatorLineRelativeHeight;
78    //------------------------------------------------------------------------
79    /** determines the vertical alignment of the separator lines between the columns.
80	 */
81    [property]  com::sun::star::style::VerticalAlignment SeparatorLineVerticalAlignment;
82    //------------------------------------------------------------------------
83    /** determines whether separator lines are on.
84	 */
85    [property]  boolean SeparatorLineIsOn;
86    //------------------------------------------------------------------------
87};
88
89//=============================================================================
90
91}; }; }; };
92
93#endif
94