LibreOffice
LibreOffice 7.3 SDK API Reference
XReportDefinition.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_XReportDefinition_idl__
20#define __com_sun_star_report_XReportDefinition_idl__
21
41
42module com { module sun { module star { module sdbc {
43published interface XConnection;
44};};};};
45
46 module com { module sun { module star { module report {
47
48 interface XSection;
49 interface XGroups;
50
63{
67
71
75
79
83
87
91
93
100
110
114
118
126 raises( ::com::sun::star::lang::DisposedException,
127 ::com::sun::star::uno::Exception );
128
131 sequence<string> getAvailableMimeTypes()
132 raises( ::com::sun::star::lang::DisposedException,
133 ::com::sun::star::uno::Exception );
134
135
138 [attribute,bound] string MimeType
139 {
141 };
142
145 [attribute,bound] string Caption;
146
150 [attribute,bound] short GroupKeepTogether
151 {
153 };
154
158 [attribute,bound] short PageHeaderOption;
159
163 [attribute,bound] short PageFooterOption;
164
165
181 [attribute,bound] string Command;
182
192 [attribute,bound] long CommandType;
193
208 [attribute,bound] string Filter;
209
220 [attribute,bound] boolean EscapeProcessing;
221
224 [attribute,bound] com::sun::star::sdbc::XConnection ActiveConnection
225 {
227 };
228
232 [attribute,bound] string DataSourceName;
233
237 [attribute,bound] boolean ReportHeaderOn;
238
242 [attribute,bound] boolean ReportFooterOn;
243
247 [attribute,bound] boolean PageHeaderOn;
248
252 [attribute,bound] boolean PageFooterOn;
253
257
263 [attribute,readonly] com::sun::star::report::XSection ReportHeader
264 {
266 };
267
273 [attribute,readonly] com::sun::star::report::XSection PageHeader
274 {
276 };
277
282
288 [attribute,readonly] com::sun::star::report::XSection PageFooter
289 {
291 };
292
298 [attribute,readonly] com::sun::star::report::XSection ReportFooter
299 {
301 };
302};
303
304
305}; }; }; };
306
307#endif
308
309/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
through this interface documents can provide access to their substorages
Definition: XDocumentSubStorageSupplier.idl:36
makes it possible to register listeners which are called whenever a document event (see EventObject) ...
Definition: XEventBroadcaster.idl:35
allows to initialize document with a storage, to store document to a storage, and to set document to ...
Definition: XStorageBasedDocument.idl:37
gives access to some properties describing all open views to a document
Definition: XViewDataSupplier.idl:38
represents common visualization functionality for embedded objects.
Definition: XVisualObject.idl:35
offers a simple way to initialize a component or load it from a URL.
Definition: XLoadable.idl:40
represents a component which is created from a URL and arguments.
Definition: XModel.idl:59
specifies the functions supplier which are located in a report definition or a group.
Definition: XFunctionsSupplier.idl:30
This interface specifies the groups collections of the report definition.
Definition: XGroups.idl:36
describes a component which may be part of a report.
Definition: XReportComponent.idl:41
identifies a XReportComponent as being a (sub-) report.
Definition: XReportDefinition.idl:63
long CommandType
specifies the type of the command to be executed to retrieve a result set.
Definition: XReportDefinition.idl:192
short PageHeaderOption
Represents the location of the page header.
Definition: XReportDefinition.idl:158
string Caption
Represents the title of the report in print preview.
Definition: XReportDefinition.idl:145
string Filter
specifies an additional filter to optionally use.
Definition: XReportDefinition.idl:208
boolean PageFooterOn
Defines that the page footer is on.
Definition: XReportDefinition.idl:252
com::sun::star::report::XGroups Groups
Represents the groups of the report.
Definition: XReportDefinition.idl:256
boolean ReportFooterOn
Defines that the report footer is on.
Definition: XReportDefinition.idl:242
string Command
is the command which should be executed, the type of command depends on the CommandType.
Definition: XReportDefinition.idl:181
com::sun::star::report::XSection Detail
returns the detail section.
Definition: XReportDefinition.idl:281
boolean EscapeProcessing
specifies if the Command should be analyzed on the client side before sending it to the database serv...
Definition: XReportDefinition.idl:220
boolean PageHeaderOn
Defines that the page header is on.
Definition: XReportDefinition.idl:247
com::sun::star::document::XEventBroadcaster getEventBroadcaster()
makes it possible to register listeners which are called whenever a document event occurs.
boolean ReportHeaderOn
Defines that the report header is on.
Definition: XReportDefinition.idl:237
string DataSourceName
is the name of the datasource to use, this could be a named datasource or the URL of a data access co...
Definition: XReportDefinition.idl:232
short PageFooterOption
Represents the location of the page footer.
Definition: XReportDefinition.idl:163
identifies a XSection inside a report.
Definition: XSection.idl:44
represents a connection (session) with a specific database.
Definition: XConnection.idl:58
This interface provides access to the style families within the container document.
Definition: XStyleFamiliesSupplier.idl:34
allows to retrieve the user interface configuration manager related to an object.
Definition: XUIConfigurationManagerSupplier.idl:34
makes it possible to release any objects in an ordered manner by using a two-step mechanism
Definition: XCloseable.idl:57
allows to control modifiable state change.
Definition: XModifiable2.idl:41
Definition: Accessible.idl:22