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