xref: /AOO41X/main/offapi/com/sun/star/text/RelOrientation.idl (revision 2a413f170de95afb9972effe5557e28dd83e2121)
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_RelOrientation_idl__
24#define __com_sun_star_text_RelOrientation_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module text {
30
31//=============================================================================
32
33// DocMerge from idl: constants com::sun::star::text::RelOrientation
34/** These values define the reference position of relative orientations.
35 */
36published constants RelOrientation
37{
38    //-------------------------------------------------------------------------
39
40    // DocMerge from idl: value com::sun::star::text::RelOrientation::FRAME
41    /** paragraph, including margins
42     */
43    const short FRAME = 0;
44
45    //-------------------------------------------------------------------------
46
47    // DocMerge from idl: value com::sun::star::text::RelOrientation::PRINT_AREA
48    /** paragraph, without margins
49     */
50    const short PRINT_AREA = 1;
51
52    //-------------------------------------------------------------------------
53
54    // DocMerge from idl: value com::sun::star::text::RelOrientation::CHAR
55    /** at a character
56     */
57    const short CHAR = 2;
58
59    //-------------------------------------------------------------------------
60
61    // DocMerge from idl: value com::sun::star::text::RelOrientation::PAGE_LEFT
62    /** inside the left page margin
63     */
64    const short PAGE_LEFT = 3;
65
66    //-------------------------------------------------------------------------
67
68    // DocMerge from idl: value com::sun::star::text::RelOrientation::PAGE_RIGHT
69    /** inside the right page margin
70     */
71    const short PAGE_RIGHT = 4;
72
73    //-------------------------------------------------------------------------
74
75    // DocMerge from idl: value com::sun::star::text::RelOrientation::FRAME_LEFT
76    /** inside the left paragraph margin
77     */
78    const short FRAME_LEFT = 5;
79
80    //-------------------------------------------------------------------------
81
82    // DocMerge from idl: value com::sun::star::text::RelOrientation::FRAME_RIGHT
83    /** inside the right paragraph margin
84     */
85    const short FRAME_RIGHT = 6;
86
87    //-------------------------------------------------------------------------
88
89    // DocMerge from idl: value com::sun::star::text::RelOrientation::PAGE_FRAME
90    /** page includes margins for page-anchored frames identical with
91                <const>RelOrientation::FRAME</const>
92     */
93    const short PAGE_FRAME = 7;
94
95    //-------------------------------------------------------------------------
96
97    // DocMerge from idl: value com::sun::star::text::RelOrientation::PAGE_PRINT_AREA
98    /** page without borders (for page anchored frames identical with
99                <const>RelOrientation::PRINT_AREA</const>).
100
101<!-- JRH: does not make sense -->
102     */
103    const short PAGE_PRINT_AREA = 8;
104
105        /** at the top of the text line, only sensible for vertical orientation.
106
107            @since OpenOffice 2.0
108         */
109        const short TEXT_LINE = 9;
110
111};
112
113//=============================================================================
114
115}; }; }; };
116
117#endif
118