offapi/com/sun/star/report/XSection.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSection.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  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.
  17  *
  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).
  23  *
  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.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_report_XSection_idl__
  31 #define __com_sun_star_report_XSection_idl__
  32
  33 #ifndef __com_sun_star_container_XChild_idl__
  34 #include <com/sun/star/container/XChild.idl>
  35 #endif
  36 #ifndef __com_sun_star_drawing_XShapes_idl__
  37 #include <com/sun/star/drawing/XShapes.idl>
  38 #endif
  39 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  40 #include <com/sun/star/container/XEnumerationAccess.idl>
  41 #endif
  42 #ifndef __com_sun_star_container_XContainer_idl__
  43 #include <com/sun/star/container/XContainer.idl>
  44 #endif
  45 #ifndef __com_sun_star_util_Color_idl__
  46 #include <com/sun/star/util/Color.idl>
  47 #endif
  48 #ifndef __com_sun_star_beans_XPropertySet_idl__
  49 #include <com/sun/star/beans/XPropertySet.idl>
  50 #endif
  51 #ifndef __com_sun_star_report_XReportDefinition_idl__
  52 #include <com/sun/star/report/XReportDefinition.idl>
  53 #endif
  54 #ifndef __com_sun_star_report_XReportComponent_idl__
  55 #include <com/sun/star/report/XReportComponent.idl>
  56 #endif
  57 //=============================================================================
  58
  59  module com {  module sun {  module star {  module report {
  60  interface XGroup;
  61 //=============================================================================
  62
  63 /** identifies a <type>XSection</type> inside a report.
  64
  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>
  68
  69     @see XReportDefinition
  70     @see XGroup
  71  */
  72 interface XSection
  73 {
  74     /** allows to navigate to group or report definition.
  75     */
  76     interface com::sun::star::container::XChild;
  77     /** allows to register listeners to be notified of changes in the container.
  78     */
  79     interface com::sun::star::container::XContainer;
  80
  81     /** gives access to the elements by index.
  82     */
  83     interface com::sun::star::drawing::XShapes;
  84
  85     /** creates an enumeration of the elements.
  86     */
  87     interface com::sun::star::container::XEnumerationAccess;
  88
  89     /** provides generic access to the instance properties
  90     */
  91     interface com::sun::star::beans::XPropertySet;
  92
  93     /** allows life-time control of sections.
  94      */
  95     interface com::sun::star::lang::XComponent;
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** Defines if the section should be visible in report.
 100     */
 101     [attribute,bound] boolean Visible;
 102
 103     /** Defines the name of the section.
 104     */
 105     [attribute,bound] string Name;
 106
 107     /** Defines the height of the section.
 108     */
 109     [attribute,bound] unsigned long Height;
 110
 111     /** Defines the back ground color of the section.
 112     */
 113     [attribute,bound] com::sun::star::util::Color BackColor;
 114
 115     /** determines if the back ground color is set to transparent.
 116      */
 117     [attribute,bound] boolean BackTransparent;
 118
 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.
 121     */
 122     [attribute,bound] string ConditionalPrintExpression;
 123
 124     /** Specifies wether the section is printed on a separate page.
 125         <p>Not valid for page header or page footer.</p>
 126         @see ForceNewPage
 127     */
 128     [attribute,bound] short ForceNewPage
 129     {
 130         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
 131         get raises ( com::sun::star::beans::UnknownPropertyException );
 132     };
 133
 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>
 136         @see ForceNewPage
 137     */
 138     [attribute,bound] short NewRowOrCol
 139     {
 140         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
 141         get raises ( com::sun::star::beans::UnknownPropertyException );
 142     };
 143
 144     /** Specifies that the section is printed on one page.
 145     <p>Not valid for page header or page footer.</p>
 146     */
 147     [attribute,bound] boolean KeepTogether
 148     {
 149         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
 150         get raises ( com::sun::star::beans::UnknownPropertyException );
 151     };
 152
 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.
 155     */
 156     [attribute,bound] boolean CanGrow
 157     {
 158         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
 159         get raises ( com::sun::star::beans::UnknownPropertyException );
 160     };
 161
 162 /**
 163   <p>Represents ...</p>
 164
 165  */
 166     [attribute,bound] boolean CanShrink
 167     {
 168         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
 169         get raises ( com::sun::star::beans::UnknownPropertyException );
 170     };
 171
 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.
 174     */
 175     [attribute,bound] boolean RepeatSection
 176     {
 177         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
 178         get raises ( com::sun::star::beans::UnknownPropertyException );
 179     };
 180
 181     /** Specifies the parent of the section if it is a group header or group footer.
 182     */
 183     [attribute,readonly] com::sun::star::report::XGroup Group;
 184
 185     /** Specifies the parent of the section if it is a page header or page footer.
 186     */
 187     [attribute,readonly] com::sun::star::report::XReportDefinition ReportDefinition;
 188 };
 189
 190 service Section : XSection;
 191 //=============================================================================
 192
 193 }; }; }; };
 194
 195 /*=============================================================================
 196
 197 =============================================================================*/
 198 #endif