xref: /AOO41X/main/offapi/com/sun/star/text/VertOrientationFormat.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_VertOrientationFormat_idl__
24#define __com_sun_star_text_VertOrientationFormat_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::VertOrientationFormat
34/** describes the vertical orientation of an object.
35
36
37
38    <p>If <code>VerticalOrientation == VERT_NONE</code>, then the value "YPos"
39    describes the distance from the top of the context. Otherwise "YPos"
40    is ignored.
41    </p>
42 */
43published struct VertOrientationFormat
44{
45    // DocMerge from xml: field com::sun::star::text::VertOrientationFormat::YPos
46    /** contains the distance from top. Only valid if the property
47        VerticalOrientation contains the value VERT_NONE.
48     */
49    long YPos;
50
51    //-------------------------------------------------------------------------
52
53    // DocMerge from xml: field com::sun::star::text::VertOrientationFormat::VerticalOrientation
54    /** determines the vertical alignment of an object.
55        The values refer to com::sun::star::VertOrientation.
56     */
57    short VerticalOrientation;
58
59    //-------------------------------------------------------------------------
60
61    // DocMerge from xml: field com::sun::star::text::VertOrientationFormat::VerticalRelation
62    /** determines the reference position of the vertical alignment.@see com::sun::star::text::RelOrientation
63     */
64    short VerticalRelation;
65
66};
67
68//=============================================================================
69
70}; }; }; };
71
72
73#endif
74