1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_report_XGroup_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_report_XGroup_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_NoSuchElementException_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/container/NoSuchElementException.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_report_XSection_idl__ 30*b1cdbd2cSJim Jagielski#include <com/sun/star/report/XSection.idl> 31*b1cdbd2cSJim Jagielski#endif 32*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_report_XGroups_idl__ 33*b1cdbd2cSJim Jagielski#include <com/sun/star/report/XGroups.idl> 34*b1cdbd2cSJim Jagielski#endif 35*b1cdbd2cSJim Jagielski#include <com/sun/star/report/XFunctions.idl> 36*b1cdbd2cSJim Jagielski//============================================================================= 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski module com { module sun { module star { module report { 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski//============================================================================= 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski/** identifies a <type>XGroup</type>. 43*b1cdbd2cSJim Jagielski A group is always a child of the groups collection in the report. 44*b1cdbd2cSJim Jagielski @see XReportDefinition 45*b1cdbd2cSJim Jagielski @see XGroups 46*b1cdbd2cSJim Jagielski */ 47*b1cdbd2cSJim Jagielskipublished interface XGroup 48*b1cdbd2cSJim Jagielski{ 49*b1cdbd2cSJim Jagielski /** allows access to the groups collection of the report. 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielski interface com::sun::star::container::XChild; 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski /** allows access to the properties of the instance. 54*b1cdbd2cSJim Jagielski */ 55*b1cdbd2cSJim Jagielski interface com::sun::star::beans::XPropertySet; 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski /** allows life-time control of group instances. 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielski interface com::sun::star::lang::XComponent; 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski /** gives access to functions defined in the group definition. 62*b1cdbd2cSJim Jagielski */ 63*b1cdbd2cSJim Jagielski interface XFunctionsSupplier; 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski /** Defines if the group is sorted ascending or descending. 66*b1cdbd2cSJim Jagielski The default is <TRUE/>. 67*b1cdbd2cSJim Jagielski */ 68*b1cdbd2cSJim Jagielski [attribute,bound] boolean SortAscending; 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski /** Defines if a group has a header. 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski [attribute,bound] boolean HeaderOn; 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski /** Defines if a group has a footer. 75*b1cdbd2cSJim Jagielski */ 76*b1cdbd2cSJim Jagielski [attribute,bound] boolean FooterOn; 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski /** returns the group header. 79*b1cdbd2cSJim Jagielski @throws <type scope="com::sun::star::container">NoSuchElementException</type> 80*b1cdbd2cSJim Jagielski If the group has the header disabled. 81*b1cdbd2cSJim Jagielski @see XSection 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski [attribute,readonly] XSection Header 85*b1cdbd2cSJim Jagielski { 86*b1cdbd2cSJim Jagielski get raises (com::sun::star::container::NoSuchElementException); 87*b1cdbd2cSJim Jagielski }; 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski /** returns the group footer. 90*b1cdbd2cSJim Jagielski @throws <type scope="com::sun::star::container">NoSuchElementException</type> 91*b1cdbd2cSJim Jagielski If the group has the footer disabled. 92*b1cdbd2cSJim Jagielski @see XSection 93*b1cdbd2cSJim Jagielski */ 94*b1cdbd2cSJim Jagielski [attribute,readonly,bound] XSection Footer 95*b1cdbd2cSJim Jagielski { 96*b1cdbd2cSJim Jagielski get raises (com::sun::star::container::NoSuchElementException); 97*b1cdbd2cSJim Jagielski }; 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski /** Specifies how to group data. 100*b1cdbd2cSJim Jagielski @see GroupOn 101*b1cdbd2cSJim Jagielski */ 102*b1cdbd2cSJim Jagielski [attribute,bound] short GroupOn 103*b1cdbd2cSJim Jagielski { 104*b1cdbd2cSJim Jagielski set raises (com::sun::star::lang::IllegalArgumentException); 105*b1cdbd2cSJim Jagielski }; 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski /** Defines an interval value that rows are grouped by. 108*b1cdbd2cSJim Jagielski */ 109*b1cdbd2cSJim Jagielski [attribute,bound] long GroupInterval; 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski /** Specifies if a group header, detail, and footer section is printed on the same page. 112*b1cdbd2cSJim Jagielski @see KeepTogether 113*b1cdbd2cSJim Jagielski */ 114*b1cdbd2cSJim Jagielski [attribute,bound] short KeepTogether 115*b1cdbd2cSJim Jagielski { 116*b1cdbd2cSJim Jagielski set raises (com::sun::star::lang::IllegalArgumentException); 117*b1cdbd2cSJim Jagielski }; 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski /** Specifies the parent of the group. 120*b1cdbd2cSJim Jagielski @see XChild 121*b1cdbd2cSJim Jagielski */ 122*b1cdbd2cSJim Jagielski [attribute,readonly] com::sun::star::report::XGroups Groups; 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski /** Defines either a column name or a expression. 125*b1cdbd2cSJim Jagielski */ 126*b1cdbd2cSJim Jagielski [attribute,bound] string Expression; 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski /** Specifies that the group header should always be printed on a new column. 129*b1cdbd2cSJim Jagielski */ 130*b1cdbd2cSJim Jagielski [attribute,bound] boolean StartNewColumn; 131*b1cdbd2cSJim Jagielski 132*b1cdbd2cSJim Jagielski /** Specifies that the group header should always be printed on a new page and the reset of the page number to zero. 133*b1cdbd2cSJim Jagielski */ 134*b1cdbd2cSJim Jagielski [attribute,bound] boolean ResetPageNumber; 135*b1cdbd2cSJim Jagielski}; 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielskiservice Group : XGroup; 138*b1cdbd2cSJim Jagielski//============================================================================= 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski}; }; }; }; 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski/*============================================================================= 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski=============================================================================*/ 145*b1cdbd2cSJim Jagielski#endif 146