xref: /AOO41X/main/offapi/com/sun/star/text/HoriOrientationFormat.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_HoriOrientationFormat_idl__
24#define __com_sun_star_text_HoriOrientationFormat_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module text {
30
31//=============================================================================
32
33// DocMerge from xml: struct com::sun::star::text::HoriOrientationFormat
34/** describes the horizontal orientation of an object.
35
36
37
38    <p>If <code>HorizontalOrientation == HORI_NONE</code>, then the value
39    "XPos" describes the distance from the left border of the context.
40    Otherwise "XPos" is ignored.
41
42    </p>
43    <p>The following flags are used to adapt the position of the object
44    to odd and even pages. If "PositionToggle" is set, then the
45    horizontal position is mirrored.</p>
46 */
47published struct HoriOrientationFormat
48{
49    // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::XPos
50    /** contains the distance from the left border. Only valid if
51        the property HorizontalOrientation contains the value HORI_NONE.
52     */
53    long XPos;
54
55    //-------------------------------------------------------------------------
56
57    // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::HorizontalOrientation
58    /** determines the horizontal alignment of an object.
59        The values refer to com::sun::star::HoriOrientation.
60     */
61    short HorizontalOrientation;
62
63    //-------------------------------------------------------------------------
64
65    // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::HorizontalRelation
66    /** determines the reference position of the horizontal alignment.@see com::sun::star::text::RelOrientation
67     */
68    short HorizontalRelation;
69
70    //-------------------------------------------------------------------------
71
72    // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::PositionToggle
73    /** determines if the orientation toggles between left and right pages.
74     */
75    boolean PositionToggle;
76
77};
78
79//=============================================================================
80
81}; }; }; };
82
83#endif
84