LibreOffice: com/sun/star/report/XGroup.idl Source File

LibreOffice LibreOffice 6.2 SDK API Reference

XGroup.idl
Go to the documentation of this file.
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 #ifndef __com_sun_star_report_XGroup_idl__
20 #define __com_sun_star_report_XGroup_idl__
21
22 #include <com/sun/star/container/NoSuchElementException.idl>
23 #include <com/sun/star/report/XSection.idl>
24 #include <com/sun/star/report/XGroups.idl>
25 #include <com/sun/star/report/XFunctions.idl>
26
27 module com { module sun { module star { module report {
28
29
35 interface XGroup
36 {
39 interface com::sun::star::container::XChild;
40
43 interface com::sun::star::beans::XPropertySet;
44
47 interface com::sun::star::lang::XComponent;
48
51 interface XFunctionsSupplier;
52
56 [attribute,bound] boolean SortAscending;
57
60 [attribute,bound] boolean HeaderOn;
61
64 [attribute,bound] boolean FooterOn;
65
72 [attribute,readonly] XSection Header
73 {
74 get raises (com::sun::star::container::NoSuchElementException);
75 };
76
82 [attribute,readonly,bound] XSection Footer
83 {
84 get raises (com::sun::star::container::NoSuchElementException);
85 };
86
90 [attribute,bound] short GroupOn
91 {
92 set raises (com::sun::star::lang::IllegalArgumentException);
93 };
94
97 [attribute,bound] long GroupInterval;
98
102 [attribute,bound] short KeepTogether
103 {
104 set raises (com::sun::star::lang::IllegalArgumentException);
105 };
106
110 [attribute,readonly] com::sun::star::report::XGroups Groups;
111
114 [attribute,bound] string Expression;
115
118 [attribute,bound] boolean StartNewColumn;
119
122 [attribute,bound] boolean ResetPageNumber;
123 };
124
125
126 }; }; }; };
127
128 #endif
129
130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::report::XGroup::Expression
string Expression
Defines either a column name or an expression.
Definition: XGroup.idl:114
com::sun::star::report::XGroup::FooterOn
boolean FooterOn
Defines if a group has a footer.
Definition: XGroup.idl:64
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:63
com::sun::star::report::XGroup
identifies a XGroup.
Definition: XGroup.idl:35
com::sun::star::report::XGroup::Groups
com::sun::star::report::XGroups Groups
Specifies the parent of the group.
Definition: XGroup.idl:110
XSection.idl
com::sun::star::report::XGroup::GroupInterval
long GroupInterval
Defines an interval value that rows are grouped by.
Definition: XGroup.idl:97
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:34
com::sun::star::report::XGroup::StartNewColumn
boolean StartNewColumn
Specifies that the group header should always be printed on a new column.
Definition: XGroup.idl:118
com::sun::star::report::XGroup::HeaderOn
boolean HeaderOn
Defines if a group has a header.
Definition: XGroup.idl:60
XFunctions.idl
com::sun::star::container::XChild
provides access to the parent of the object.
Definition: XChild.idl:36
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:42
com::sun::star::report::XFunctionsSupplier
specifies the functions supplier which are located in a report definition or a group.
Definition: XFunctionsSupplier.idl:29
com::sun::star::form::runtime::FormFeature::SortAscending
const short SortAscending
sorts the form ascending by the field which the active form control is bound to.
Definition: FormFeature.idl:91
com::sun::star::report::XGroups
This interface specifies the groups collections of the report definition.
Definition: XGroups.idl:35
com
Definition: Ambiguous.idl:22
NoSuchElementException.idl
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:29
com::sun::star::report::XGroup::ResetPageNumber
boolean ResetPageNumber
Specifies that the group header should always be printed on a new page and the reset of the page numb...
Definition: XGroup.idl:122
XGroups.idl
com::sun::star::report::XSection
identifies a XSection inside a report.
Definition: XSection.idl:43