offapi/com/sun/star/report/XGroup.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: XGroup.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_XGroup_idl__
  31 #define __com_sun_star_report_XGroup_idl__
  32
  33 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  34 #include <com/sun/star/container/NoSuchElementException.idl>
  35 #endif
  36 #ifndef __com_sun_star_report_XSection_idl__
  37 #include <com/sun/star/report/XSection.idl>
  38 #endif
  39 #ifndef __com_sun_star_report_XGroups_idl__
  40 #include <com/sun/star/report/XGroups.idl>
  41 #endif
  42 #include <com/sun/star/report/XFunctions.idl>
  43 //=============================================================================
  44
  45  module com {  module sun {  module star {  module report {
  46
  47 //=============================================================================
  48
  49 /** identifies a <type>XGroup</type>.
  50     A group is always a child of the groups collection in the report.
  51     @see XReportDefinition
  52     @see XGroups
  53  */
  54 interface XGroup
  55 {
  56     /** allows access to the groups collection of the report.
  57     */
  58     interface com::sun::star::container::XChild;
  59
  60     /** allows access to the properties of the instance.
  61     */
  62     interface com::sun::star::beans::XPropertySet;
  63
  64     /** allows life-time control of group instances.
  65      */
  66     interface com::sun::star::lang::XComponent;
  67
  68     /** gives access to functions defined in the group definition.
  69     */
  70     interface XFunctionsSupplier;
  71
  72     /** Defines if the group is sorted ascending or descending.
  73         The default is <TRUE/>.
  74      */
  75     [attribute,bound] boolean SortAscending;
  76
  77     /** Defines if a group has a header.
  78     */
  79     [attribute,bound] boolean HeaderOn;
  80
  81     /** Defines if a group has a footer.
  82     */
  83     [attribute,bound] boolean FooterOn;
  84
  85     /** returns the group header.
  86         @throws <type scope="com::sun::star::container">NoSuchElementException</type>
  87             If the group has the header disabled.
  88         @see XSection
  89     */
  90
  91     [attribute,readonly] XSection Header
  92     {
  93         get raises (com::sun::star::container::NoSuchElementException);
  94     };
  95
  96     /** returns the group footer.
  97         @throws <type scope="com::sun::star::container">NoSuchElementException</type>
  98             If the group has the footer disabled.
  99         @see XSection
 100     */
 101     [attribute,readonly,bound] XSection Footer
 102     {
 103         get raises (com::sun::star::container::NoSuchElementException);
 104     };
 105
 106     /** Specifies how to group data.
 107         @see GroupOn
 108     */
 109     [attribute,bound] short GroupOn
 110     {
 111         set raises (com::sun::star::lang::IllegalArgumentException);
 112     };
 113
 114     /** Defines an interval value that rows are grouped by.
 115     */
 116     [attribute,bound] long GroupInterval;
 117
 118     /** Specifies if a group header, detail, and footer section is printed on the same page.
 119         @see KeepTogether
 120     */
 121     [attribute,bound] short KeepTogether
 122     {
 123         set raises (com::sun::star::lang::IllegalArgumentException);
 124     };
 125
 126     /** Specifies the parent of the group.
 127         @see XChild
 128     */
 129     [attribute,readonly] com::sun::star::report::XGroups Groups;
 130
 131     /** Defines either a column name or a expression.
 132     */
 133     [attribute,bound] string Expression;
 134
 135     /** Specifies that the group header should always be printed on a new column.
 136     */
 137     [attribute,bound] boolean StartNewColumn;
 138
 139     /** Specifies that the group header should always be printed on a new page and the reset of the page number to zero.
 140     */
 141     [attribute,bound] boolean ResetPageNumber;
 142 };
 143
 144 service Group : XGroup;
 145 //=============================================================================
 146
 147 }; }; }; };
 148
 149 /*=============================================================================
 150
 151 =============================================================================*/
 152 #endif