LibreOffice LibreOffice 25.8 SDK API Reference

Loading...
Searching...
No Matches
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
20 module com { module sun { module star { module report {
21
22
28 interface XGroup
29{
32 interface com::sun::star::container::XChild;
33
36 interface com::sun::star::beans::XPropertySet;
37
40 interface com::sun::star::lang::XComponent;
41
44 interface XFunctionsSupplier;
45
49 [attribute,bound] boolean SortAscending;
50
53 [attribute,bound] boolean HeaderOn;
54
57 [attribute,bound] boolean FooterOn;
58
64
65 [attribute,readonly] XSection Header
66 {
67 get raises (com::sun::star::container::NoSuchElementException);
68 };
69
75 [attribute,readonly,bound] XSection Footer
76 {
77 get raises (com::sun::star::container::NoSuchElementException);
78 };
79
83 [attribute,bound] short GroupOn
84 {
85 set raises (com::sun::star::lang::IllegalArgumentException);
86 };
87
90 [attribute,bound] long GroupInterval;
91
95 [attribute,bound] short KeepTogether
96 {
97 set raises (com::sun::star::lang::IllegalArgumentException);
98 };
99
103 [attribute,readonly] com::sun::star::report::XGroups Groups;
104
107 [attribute,bound] string Expression;
108
111 [attribute,bound] boolean StartNewColumn;
112
115 [attribute,bound] boolean ResetPageNumber;
116};
117
118
119}; }; }; };
120
121/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition NoSuchElementException.idl:31
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition XPropertySet.idl:46
com::sun::star::container::XChild
provides access to the parent of the object.
Definition XChild.idl:31
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition XComponent.idl:39
com::sun::star::report::XGroup
identifies a XGroup.
Definition XGroup.idl:29
com::sun::star::report::XGroup::Expression
string Expression
Defines either a column name or an expression.
Definition XGroup.idl:107
com::sun::star::report::XGroup::XFunctionsSupplier
interface XFunctionsSupplier
gives access to functions defined in the group definition.
Definition XGroup.idl:44
com::sun::star::report::XGroup::FooterOn
boolean FooterOn
Defines if a group has a footer.
Definition XGroup.idl:57
com::sun::star::report::XGroup::Groups
com::sun::star::report::XGroups Groups
Specifies the parent of the group.
Definition XGroup.idl:103
com::sun::star::report::XGroup::GroupOn
short GroupOn
Specifies how to group data.
Definition XGroup.idl:86
com::sun::star::report::XGroup::Footer
XSection Footer
returns the group footer.
Definition XGroup.idl:78
com::sun::star::report::XGroup::KeepTogether
short KeepTogether
Specifies if a group header, detail, and footer section is printed on the same page.
Definition XGroup.idl:98
com::sun::star::report::XGroup::SortAscending
boolean SortAscending
Defines if the group is sorted ascending or descending.
Definition XGroup.idl:49
com::sun::star::report::XGroup::GroupInterval
long GroupInterval
Defines an interval value that rows are grouped by.
Definition XGroup.idl:90
com::sun::star::report::XGroup::Header
XSection Header
returns the group header.
Definition XGroup.idl:68
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:115
com::sun::star::report::XGroup::StartNewColumn
boolean StartNewColumn
Specifies that the group header should always be printed on a new column.
Definition XGroup.idl:111
com::sun::star::report::XGroup::HeaderOn
boolean HeaderOn
Defines if a group has a header.
Definition XGroup.idl:53
com::sun::star::report::XGroups
This interface specifies the groups collections of the report definition.
Definition XGroups.idl:29
com::sun::star::report::XSection
identifies a XSection inside a report.
Definition XSection.idl:33
com
Definition Ambiguous.idl:20