LibreOffice LibreOffice 25.2 SDK API Reference

XReportEngine.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 report {
34 interface XReportEngine
35{
38 interface com::sun::star::lang::XComponent;
39
42 interface com::sun::star::beans::XPropertySet;
43
50 com::sun::star::frame::XModel createDocumentModel()
51 raises( ::com::sun::star::lang::DisposedException,
52 com::sun::star::lang::IllegalArgumentException,
53 ::com::sun::star::uno::Exception );
54
65 com::sun::star::frame::XModel createDocumentAlive([in] com::sun::star::frame::XFrame frame)
66 raises( ::com::sun::star::lang::DisposedException,
67 com::sun::star::lang::IllegalArgumentException,
68 ::com::sun::star::uno::Exception );
69
78 com::sun::star::util::URL createDocument()
79 raises( ::com::sun::star::lang::DisposedException,
80 com::sun::star::lang::IllegalArgumentException,
81 ::com::sun::star::uno::Exception );
82
87 void interrupt()
88 raises( ::com::sun::star::lang::DisposedException,
89 ::com::sun::star::uno::Exception );
90
93 [attribute,bound] XReportDefinition ReportDefinition
94 {
95 set raises (com::sun::star::lang::IllegalArgumentException);
96 };
97
100 [attribute,bound] com::sun::star::sdbc::XConnection ActiveConnection
101 {
102 set raises (com::sun::star::lang::IllegalArgumentException);
103 };
104
107 [attribute] com::sun::star::task::XStatusIndicator StatusIndicator;
108
114 [attribute,bound] long MaxRows;
115};
116
117
118}; }; }; };
119
120/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
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::frame::XModel
represents a component which is created from a URL and arguments.
Definition: XModel.idl:51
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:39
com::sun::star::report::XReportDefinition
identifies a XReportComponent as being a (sub-) report.
Definition: XReportDefinition.idl:41
com::sun::star::report::XReportEngine
identifies a XReportEngine which allows the creation of OpenDocument files.
Definition: XReportEngine.idl:35
com::sun::star::report::XReportEngine::createDocumentModel
com::sun::star::frame::XModel createDocumentModel()
creates a report document.
com::sun::star::report::XReportEngine::StatusIndicator
com::sun::star::task::XStatusIndicator StatusIndicator
specifies the status indicator which shows the progress of the report generation process.
Definition: XReportEngine.idl:107
com::sun::star::report::XReportEngine::MaxRows
long MaxRows
defines the maximum number of rows which should be fetched for the report.
Definition: XReportEngine.idl:114
com::sun::star::sdbc::XConnection
represents a connection (session) with a specific database.
Definition: XConnection.idl:50
com::sun::star::task::XStatusIndicator
controls a status indicator which displays progress of longer actions to the user
Definition: XStatusIndicator.idl:33
com::sun::star::form::URL
@ URL
When the button is clicked, a URL set for the button is opened.
Definition: FormButtonType.idl:50
com
Definition: Ambiguous.idl:20
com::sun::star::report::ReportDefinition
Definition: ReportDefinition.idl:24