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