xref: /AOO42X/main/offapi/com/sun/star/style/BreakType.idl (revision d7a630b93db4316516c543e21eb4f4faf6d62bb4)
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_style_BreakType_idl__
24#define __com_sun_star_style_BreakType_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module style {
30
31//=============================================================================
32
33// DocMerge from xml: enum com::sun::star::style::BreakType
34/** These enumeration values are used to specify if and how a page or
35    column break is applied.
36 */
37published enum BreakType
38{
39    //-------------------------------------------------------------------------
40
41    // DocMerge from xml: value com::sun::star::style::BreakType::NONE
42    /** No column or page break is applied.
43     */
44    NONE,
45
46    //-------------------------------------------------------------------------
47
48    // DocMerge from xml: value com::sun::star::style::BreakType::COLUMN_BEFORE
49    /** A column break is applied before the object to which it belongs.
50
51
52
53        <p>This implies that the object to which it belongs is the
54        first in its column.</p>
55     */
56    COLUMN_BEFORE,
57
58    //-------------------------------------------------------------------------
59
60    // DocMerge from xml: value com::sun::star::style::BreakType::COLUMN_AFTER
61    /** A column break is applied after the object to which it belongs.
62
63
64
65        <p>This implies that the object to which it belongs is the last
66        in its column.</p>
67     */
68    COLUMN_AFTER,
69
70    //-------------------------------------------------------------------------
71
72    // DocMerge from xml: value com::sun::star::style::BreakType::COLUMN_BOTH
73    /** A column break is applied before and after the object to which
74        it belongs.
75
76
77
78        <p>This implies that this object is the only one in its column.</p>
79     */
80    COLUMN_BOTH,
81
82    //-------------------------------------------------------------------------
83
84    // DocMerge from xml: value com::sun::star::style::BreakType::PAGE_BEFORE
85    /** A page break is applied before the object to which it belongs.
86
87
88
89        <p>This implies that the object to which it belongs is the
90        first on its page.      </p>
91     */
92    PAGE_BEFORE,
93
94    //-------------------------------------------------------------------------
95
96    // DocMerge from xml: value com::sun::star::style::BreakType::PAGE_AFTER
97    /** A page break is applied after the object to which it belongs.
98
99
100
101        <p>This implies that the object to which it belongs is the last
102        on its page.</p>
103     */
104    PAGE_AFTER,
105
106    //-------------------------------------------------------------------------
107
108    // DocMerge from xml: value com::sun::star::style::BreakType::PAGE_BOTH
109    /** A page break is applied before and after the object to which
110        it belongs.
111
112
113
114        <p>This implies that this object is the only one on its page.</p>
115     */
116    PAGE_BOTH
117
118};
119
120//=============================================================================
121
122}; }; }; };
123
124/*=============================================================================
125
126=============================================================================*/
127#endif
128