1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XSection.idl,v $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
30 #ifndef __com_sun_star_report_XSection_idl__
31 #define __com_sun_star_report_XSection_idl__
33 #ifndef __com_sun_star_container_XChild_idl__
34 #include
<com
/sun
/star
/container
/XChild.idl
>
36 #ifndef __com_sun_star_drawing_XShapes_idl__
37 #include
<com
/sun
/star
/drawing
/XShapes.idl
>
39 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
40 #include
<com
/sun
/star
/container
/XEnumerationAccess.idl
>
42 #ifndef __com_sun_star_container_XContainer_idl__
43 #include
<com
/sun
/star
/container
/XContainer.idl
>
45 #ifndef __com_sun_star_util_Color_idl__
46 #include
<com
/sun
/star
/util
/Color.idl
>
48 #ifndef __com_sun_star_beans_XPropertySet_idl__
49 #include
<com
/sun
/star
/beans
/XPropertySet.idl
>
51 #ifndef __com_sun_star_report_XReportDefinition_idl__
52 #include
<com
/sun
/star
/report
/XReportDefinition.idl
>
54 #ifndef __com_sun_star_report_XReportComponent_idl__
55 #include
<com
/sun
/star
/report
/XReportComponent.idl
>
57 //=============================================================================
59 module com
{ module sun
{ module star
{ module report
{
61 //=============================================================================
63 /** identifies a <type>XSection</type> inside a report.
65 <p>A section acts like a container of report components. This generic
66 construction allows the definition of hierarchies of reports and their
67 dependent subreports.</p>
69 @see XReportDefinition
74 /** allows to navigate to group or report definition.
76 interface com
::sun
::star
::container
::XChild
;
77 /** allows to register listeners to be notified of changes in the container.
79 interface com
::sun
::star
::container
::XContainer
;
81 /** gives access to the elements by index.
83 interface com
::sun
::star
::drawing
::XShapes
;
85 /** creates an enumeration of the elements.
87 interface com
::sun
::star
::container
::XEnumerationAccess
;
89 /** provides generic access to the instance properties
91 interface com
::sun
::star
::beans
::XPropertySet
;
93 /** allows life-time control of sections.
95 interface com
::sun
::star
::lang
::XComponent
;
97 //-------------------------------------------------------------------------
99 /** Defines if the section should be visible in report.
101 [attribute
,bound
] boolean Visible
;
103 /** Defines the name of the section.
105 [attribute
,bound
] string Name
;
107 /** Defines the height of the section.
109 [attribute
,bound
] unsigned long Height
;
111 /** Defines the back ground color of the section.
113 [attribute
,bound
] com
::sun
::star
::util
::Color BackColor
;
115 /** determines if the back ground color is set to transparent.
117 [attribute
,bound
] boolean BackTransparent
;
119 /** Defines the expression which is executed before printing the section.
120 If the return value of the expression is <TRUE/> then the section will be printed.
122 [attribute
,bound
] string ConditionalPrintExpression
;
124 /** Specifies wether the section is printed on a separate page.
125 <p>Not valid for page header or page footer.</p>
128 [attribute
,bound
] short ForceNewPage
130 set raises
( com
::sun
::star
::lang
::IllegalArgumentException
,com
::sun
::star
::beans
::UnknownPropertyException
);
131 get raises
( com
::sun
::star
::beans
::UnknownPropertyException
);
134 /** Specifies wether the section is printed in a new row or column within a multi column report.
135 <p>Not valid for page header or page footer.</p>
138 [attribute
,bound
] short NewRowOrCol
140 set raises
( com
::sun
::star
::lang
::IllegalArgumentException
,com
::sun
::star
::beans
::UnknownPropertyException
);
141 get raises
( com
::sun
::star
::beans
::UnknownPropertyException
);
144 /** Specifies that the section is printed on one page.
145 <p>Not valid for page header or page footer.</p>
147 [attribute
,bound
] boolean KeepTogether
149 set raises
( com
::sun
::star
::lang
::IllegalArgumentException
,com
::sun
::star
::beans
::UnknownPropertyException
);
150 get raises
( com
::sun
::star
::beans
::UnknownPropertyException
);
153 /** Specifies that elements with dynamic state will be expanded vertically when then content of the element is larger than it's container.
154 If this property is disabled the content will be truncated when it's size is larger than the container.
156 [attribute
,bound
] boolean CanGrow
158 set raises
( com
::sun
::star
::lang
::IllegalArgumentException
,com
::sun
::star
::beans
::UnknownPropertyException
);
159 get raises
( com
::sun
::star
::beans
::UnknownPropertyException
);
163 <p>Represents ...</p>
166 [attribute
,bound
] boolean CanShrink
168 set raises
( com
::sun
::star
::lang
::IllegalArgumentException
,com
::sun
::star
::beans
::UnknownPropertyException
);
169 get raises
( com
::sun
::star
::beans
::UnknownPropertyException
);
172 /** Defines that the group header should be repeated on the next page when a group spans more than one page.
173 It only applies to group headers.
175 [attribute
,bound
] boolean RepeatSection
177 set raises
( com
::sun
::star
::lang
::IllegalArgumentException
,com
::sun
::star
::beans
::UnknownPropertyException
);
178 get raises
( com
::sun
::star
::beans
::UnknownPropertyException
);
181 /** Specifies the parent of the section if it is a group header or group footer.
183 [attribute
,readonly] com
::sun
::star
::report
::XGroup Group
;
185 /** Specifies the parent of the section if it is a page header or page footer.
187 [attribute
,readonly] com
::sun
::star
::report
::XReportDefinition ReportDefinition
;
190 service Section
: XSection
;
191 //=============================================================================
195 /*=============================================================================
197 =============================================================================*/