LibreOffice
LibreOffice 24.2 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 
20 module com { module sun { module star { module sdbc {
21 published interface XConnection;
22 };};};};
23 
24  module com { module sun { module star { module report {
25 
26  interface XSection;
27  interface XGroups;
28 
41 {
45 
49 
53 
57 
61 
65 
69 
71 
78 
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  {
119  };
120 
123  [attribute,bound] string Caption;
124 
128  [attribute,bound] short GroupKeepTogether
129  {
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  {
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 
235 
241  [attribute,readonly] com::sun::star::report::XSection ReportHeader
242  {
244  };
245 
251  [attribute,readonly] com::sun::star::report::XSection PageHeader
252  {
254  };
255 
260 
266  [attribute,readonly] com::sun::star::report::XSection PageFooter
267  {
269  };
270 
276  [attribute,readonly] com::sun::star::report::XSection ReportFooter
277  {
279  };
280 };
281 
282 
283 }; }; }; };
284 
285 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
short PageFooterOption
Represents the location of the page footer.
Definition: XReportDefinition.idl:141
This interface provides access to the style families within the container document.
Definition: XStyleFamiliesSupplier.idl:27
describes a component which may be part of a report.
Definition: XReportComponent.idl:27
boolean ReportHeaderOn
Defines that the report header is on.
Definition: XReportDefinition.idl:215
specifies the functions supplier which are located in a report definition or a group.
Definition: XFunctionsSupplier.idl:25
makes it possible to register listeners which are called whenever a document event (see EventObject) ...
Definition: XEventBroadcaster.idl:29
boolean PageFooterOn
Defines that the page footer is on.
Definition: XReportDefinition.idl:230
represents a connection (session) with a specific database.
Definition: XConnection.idl:49
Definition: Ambiguous.idl:20
allows to initialize document with a storage, to store document to a storage, and to set document to ...
Definition: XStorageBasedDocument.idl:26
represents a component which is created from a URL and arguments.
Definition: XModel.idl:50
boolean ReportFooterOn
Defines that the report footer is on.
Definition: XReportDefinition.idl:220
through this interface documents can provide access to their substorages
Definition: XDocumentSubStorageSupplier.idl:30
string Filter
specifies an additional filter to optionally use.
Definition: XReportDefinition.idl:186
com::sun::star::report::XSection Detail
returns the detail section.
Definition: XReportDefinition.idl:259
string Command
is the command which should be executed, the type of command depends on the CommandType.
Definition: XReportDefinition.idl:159
short PageHeaderOption
Represents the location of the page header.
Definition: XReportDefinition.idl:136
represents common visualization functionality for embedded objects.
Definition: XVisualObject.idl:26
identifies a XReportComponent as being a (sub-) report.
Definition: XReportDefinition.idl:40
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument...
Definition: IllegalArgumentException.idl:25
string Caption
Represents the title of the report in print preview.
Definition: XReportDefinition.idl:123
allows to control modifiable state change.
Definition: XModifiable2.idl:34
is thrown by child access methods of collections, if the addressed child does not exist...
Definition: NoSuchElementException.idl:30
gives access to some properties describing all open views to a document
Definition: XViewDataSupplier.idl:33
This interface specifies the groups collections of the report definition.
Definition: XGroups.idl:28
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
identifies a XSection inside a report.
Definition: XSection.idl:32
allows to retrieve the user interface configuration manager related to an object. ...
Definition: XUIConfigurationManagerSupplier.idl:28
com::sun::star::report::XGroups Groups
Represents the groups of the report.
Definition: XReportDefinition.idl:234
makes it possible to release any objects in an ordered manner by using a two-step mechanism ...
Definition: XCloseable.idl:51
offers a simple way to initialize a component or load it from a URL.
Definition: XLoadable.idl:32
boolean EscapeProcessing
specifies if the Command should be analyzed on the client side before sending it to the database serv...
Definition: XReportDefinition.idl:198
boolean PageHeaderOn
Defines that the page header is on.
Definition: XReportDefinition.idl:225
long CommandType
specifies the type of the command to be executed to retrieve a result set.
Definition: XReportDefinition.idl:170