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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20  module com {  module sun {  module star {  module report {
  21
  22
  23 /** identifies a XGroup.
  24     A group is always a child of the groups collection in the report.
  25     @see XReportDefinition
  26     @see XGroups
  27  */
  28 interface XGroup
  29 {
  30     /** allows access to the groups collection of the report.
  31     */
  32     interface com::sun::star::container::XChild;
  33
  34     /** allows access to the properties of the instance.
  35     */
  36     interface com::sun::star::beans::XPropertySet;
  37
  38     /** allows life-time control of group instances.
  39      */
  40     interface com::sun::star::lang::XComponent;
  41
  42     /** gives access to functions defined in the group definition.
  43     */
  44     interface XFunctionsSupplier;
  45
  46     /** Defines if the group is sorted ascending or descending.
  47         The default is `TRUE`.
  48      */
  49     [attribute,bound] boolean SortAscending;
  50
  51     /** Defines if a group has a header.
  52     */
  53     [attribute,bound] boolean HeaderOn;
  54
  55     /** Defines if a group has a footer.
  56     */
  57     [attribute,bound] boolean FooterOn;
  58
  59     /** returns the group header.
  60         @throws com::sun::star::container::NoSuchElementException
  61             If the group has the header disabled.
  62         @see XSection
  63     */
  64
  65     [attribute,readonly] XSection Header
  66     {
  67         get raises (com::sun::star::container::NoSuchElementException);
  68     };
  69
  70     /** returns the group footer.
  71         @throws com::sun::star::container::NoSuchElementException
  72             If the group has the footer disabled.
  73         @see XSection
  74     */
  75     [attribute,readonly,bound] XSection Footer
  76     {
  77         get raises (com::sun::star::container::NoSuchElementException);
  78     };
  79
  80     /** Specifies how to group data.
  81         @see GroupOn
  82     */
  83     [attribute,bound] short GroupOn
  84     {
  85         set raises (com::sun::star::lang::IllegalArgumentException);
  86     };
  87
  88     /** Defines an interval value that rows are grouped by.
  89     */
  90     [attribute,bound] long GroupInterval;
  91
  92     /** Specifies if a group header, detail, and footer section is printed on the same page.
  93         @see KeepTogether
  94     */
  95     [attribute,bound] short KeepTogether
  96     {
  97         set raises (com::sun::star::lang::IllegalArgumentException);
  98     };
  99
 100     /** Specifies the parent of the group.
 101         @see XChild
 102     */
 103     [attribute,readonly] com::sun::star::report::XGroups Groups;
 104
 105     /** Defines either a column name or an expression.
 106     */
 107     [attribute,bound] string Expression;
 108
 109     /** Specifies that the group header should always be printed on a new column.
 110     */
 111     [attribute,bound] boolean StartNewColumn;
 112
 113     /** Specifies that the group header should always be printed on a new page and the reset of the page number to zero.
 114     */
 115     [attribute,bound] boolean ResetPageNumber;
 116 };
 117
 118
 119 }; }; }; };
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */