LibreOffice LibreOffice 25.8 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
20module com { module sun { module star { module sdbc {
21published interface XConnection;
22};};};};
23
24 module com { module sun { module star { module report {
25
26 interface XSection;
27 interface XGroups;
28
40 interface XReportDefinition
41{
44 interface com::sun::star::frame::XModel;
45
48 interface com::sun::star::frame::XLoadable;
49
52 interface com::sun::star::embed::XVisualObject;
53
56 interface com::sun::star::document::XStorageBasedDocument;
57
60 interface com::sun::star::document::XViewDataSupplier;
61
64 interface com::sun::star::util::XCloseable;
65
68 interface com::sun::star::ui::XUIConfigurationManagerSupplier;
69
70 interface com::sun::star::document::XDocumentSubStorageSupplier;
71
77 interface com::sun::star::style::XStyleFamiliesSupplier;
78
87 interface com::sun::star::util::XModifiable2;
88
91 interface XReportComponent;
92
95 interface XFunctionsSupplier;
96
103 com::sun::star::document::XEventBroadcaster getEventBroadcaster()
104 raises( ::com::sun::star::lang::DisposedException,
105 ::com::sun::star::uno::Exception );
106
109 sequence<string> getAvailableMimeTypes()
110 raises( ::com::sun::star::lang::DisposedException,
111 ::com::sun::star::uno::Exception );
112
113
116 [attribute,bound] string MimeType
117 {
118 set raises (com::sun::star::lang::IllegalArgumentException);
119 };
120
123 [attribute,bound] string Caption;
124
128 [attribute,bound] short GroupKeepTogether
129 {
130 set raises (com::sun::star::lang::IllegalArgumentException);
131 };
132
136 [attribute,bound] short PageHeaderOption;
137
141 [attribute,bound] short PageFooterOption;
142
143
159 [attribute,bound] string Command;
160
170 [attribute,bound] long CommandType;
171
186 [attribute,bound] string Filter;
187
198 [attribute,bound] boolean EscapeProcessing;
199
202 [attribute,bound] com::sun::star::sdbc::XConnection ActiveConnection
203 {
204 set raises (com::sun::star::lang::IllegalArgumentException);
205 };
206
210 [attribute,bound] string DataSourceName;
211
215 [attribute,bound] boolean ReportHeaderOn;
216
220 [attribute,bound] boolean ReportFooterOn;
221
225 [attribute,bound] boolean PageHeaderOn;
226
230 [attribute,bound] boolean PageFooterOn;
231
234 [attribute,readonly] com::sun::star::report::XGroups Groups;
235
241 [attribute,readonly] com::sun::star::report::XSection ReportHeader
242 {
243 get raises (com::sun::star::container::NoSuchElementException);
244 };
245
251 [attribute,readonly] com::sun::star::report::XSection PageHeader
252 {
253 get raises (com::sun::star::container::NoSuchElementException);
254 };
255
259 [attribute,readonly] com::sun::star::report::XSection Detail;
260
266 [attribute,readonly] com::sun::star::report::XSection PageFooter
267 {
268 get raises (com::sun::star::container::NoSuchElementException);
269 };
270
276 [attribute,readonly] com::sun::star::report::XSection ReportFooter
277 {
278 get raises (com::sun::star::container::NoSuchElementException);
279 };
280};
281
282
283}; }; }; };
284
285/* 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::document::XDocumentSubStorageSupplier
through this interface documents can provide access to their substorages
Definition: XDocumentSubStorageSupplier.idl:31
com::sun::star::document::XEventBroadcaster
makes it possible to register listeners which are called whenever a document event (see EventObject) ...
Definition: XEventBroadcaster.idl:30
com::sun::star::document::XStorageBasedDocument
allows to initialize document with a storage, to store document to a storage, and to set document to ...
Definition: XStorageBasedDocument.idl:27
com::sun::star::document::XViewDataSupplier
gives access to some properties describing all open views to a document
Definition: XViewDataSupplier.idl:34
com::sun::star::embed::XVisualObject
represents common visualization functionality for embedded objects.
Definition: XVisualObject.idl:27
com::sun::star::frame::XLoadable
offers a simple way to initialize a component or load it from a URL.
Definition: XLoadable.idl:33
com::sun::star::frame::XModel
represents a component which is created from a URL and arguments.
Definition: XModel.idl:51
com::sun::star::report::XFunctionsSupplier
specifies the functions supplier which are located in a report definition or a group.
Definition: XFunctionsSupplier.idl:26
com::sun::star::report::XGroups
This interface specifies the groups collections of the report definition.
Definition: XGroups.idl:29
com::sun::star::report::XReportComponent
describes a component which may be part of a report.
Definition: XReportComponent.idl:28
com::sun::star::report::XReportDefinition
identifies a XReportComponent as being a (sub-) report.
Definition: XReportDefinition.idl:41
com::sun::star::report::XReportDefinition::CommandType
long CommandType
specifies the type of the command to be executed to retrieve a result set.
Definition: XReportDefinition.idl:170
com::sun::star::report::XReportDefinition::PageHeaderOption
short PageHeaderOption
Represents the location of the page header.
Definition: XReportDefinition.idl:136
com::sun::star::report::XReportDefinition::Caption
string Caption
Represents the title of the report in print preview.
Definition: XReportDefinition.idl:123
com::sun::star::report::XReportDefinition::Filter
string Filter
specifies an additional filter to optionally use.
Definition: XReportDefinition.idl:186
com::sun::star::report::XReportDefinition::PageFooterOn
boolean PageFooterOn
Defines that the page footer is on.
Definition: XReportDefinition.idl:230
com::sun::star::report::XReportDefinition::Groups
com::sun::star::report::XGroups Groups
Represents the groups of the report.
Definition: XReportDefinition.idl:234
com::sun::star::report::XReportDefinition::ReportFooterOn
boolean ReportFooterOn
Defines that the report footer is on.
Definition: XReportDefinition.idl:220
com::sun::star::report::XReportDefinition::Command
string Command
is the command which should be executed, the type of command depends on the CommandType.
Definition: XReportDefinition.idl:159
com::sun::star::report::XReportDefinition::Detail
com::sun::star::report::XSection Detail
returns the detail section.
Definition: XReportDefinition.idl:259
com::sun::star::report::XReportDefinition::EscapeProcessing
boolean EscapeProcessing
specifies if the Command should be analyzed on the client side before sending it to the database serv...
Definition: XReportDefinition.idl:198
com::sun::star::report::XReportDefinition::PageHeaderOn
boolean PageHeaderOn
Defines that the page header is on.
Definition: XReportDefinition.idl:225
com::sun::star::report::XReportDefinition::getEventBroadcaster
com::sun::star::document::XEventBroadcaster getEventBroadcaster()
makes it possible to register listeners which are called whenever a document event occurs.
com::sun::star::report::XReportDefinition::ReportHeaderOn
boolean ReportHeaderOn
Defines that the report header is on.
Definition: XReportDefinition.idl:215
com::sun::star::report::XReportDefinition::DataSourceName
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:210
com::sun::star::report::XReportDefinition::PageFooterOption
short PageFooterOption
Represents the location of the page footer.
Definition: XReportDefinition.idl:141
com::sun::star::report::XSection
identifies a XSection inside a report.
Definition: XSection.idl:33
com::sun::star::sdbc::XConnection
represents a connection (session) with a specific database.
Definition: XConnection.idl:50
com::sun::star::style::XStyleFamiliesSupplier
This interface provides access to the style families within the container document.
Definition: XStyleFamiliesSupplier.idl:28
com::sun::star::ui::XUIConfigurationManagerSupplier
allows to retrieve the user interface configuration manager related to an object.
Definition: XUIConfigurationManagerSupplier.idl:29
com::sun::star::util::XCloseable
makes it possible to release any objects in an ordered manner by using a two-step mechanism
Definition: XCloseable.idl:52
com::sun::star::util::XModifiable2
allows to control modifiable state change.
Definition: XModifiable2.idl:35
com
Definition: Ambiguous.idl:20