LibreOffice
LibreOffice 7.3 SDK API Reference
XPackage.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#ifndef _com_sun_star_deployment_XPackage_idl
21#define _com_sun_star_deployment_XPackage_idl
22
37
38
39module com { module sun { module star { module deployment {
40
46interface XPackage
47{
51
55
56
63
85 [in] com::sun::star::task::XAbortChannel xAbortChannel,
87 [in] boolean alreadyInstalled)
88 raises (DeploymentException,
92
109 raises (DeploymentException,
112
113
127 com::sun::star::beans::Optional<
128 com::sun::star::beans::Ambiguous<boolean> > isRegistered(
129 [in] com::sun::star::task::XAbortChannel xAbortChannel,
131 raises (DeploymentException,
134
150 [in] boolean startup,
151 [in] com::sun::star::task::XAbortChannel xAbortChannel,
153 raises (DeploymentException,
158
174 [in] boolean startup,
175 [in] com::sun::star::task::XAbortChannel xAbortChannel,
177 raises (DeploymentException,
181
188 boolean isBundle();
189
203 sequence<XPackage> getBundle(
204 [in] com::sun::star::task::XAbortChannel xAbortChannel,
206 raises (DeploymentException,
210
216 string getName();
217
226 com::sun::star::beans::Optional<string> getIdentifier();
227
238 string getVersion()
240
246 string getURL();
247
254 string getDisplayName()
256
262 string getDescription()
264
270 string getLicenseText()
271 raises (DeploymentException,
273
283 sequence<string> getUpdateInformationURLs()
294 ::com::sun::star::beans::StringPair getPublisherInfo()
301 XPackageTypeInfo getPackageType();
302
314 void exportTo( [in] string destFolderURL,
315 [in] string newTitle,
316 [in] long nameClashAction,
317 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
318 raises (
320 com::sun::star::ucb::CommandFailedException,
321 com::sun::star::ucb::CommandAbortedException,
322 com::sun::star::ucb::ContentCreationException);
323
333 com::sun::star::graphic::XGraphic getIcon( [in] boolean highContrast )
335
338 string getRepositoryName();
339
354 com::sun::star::beans::Optional<string> getRegistrationDataURL()
356
362 boolean isRemoved();
363
364};
365
366}; }; }; };
367
368#endif
369
370/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
A DeploymentException reflects a deployment error.
Definition: DeploymentException.idl:33
indicates that a function call with the given arguments is not supported because the extension was re...
Definition: ExtensionRemovedException.idl:36
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
This exception is thrown to indicate that a command was aborted.
Definition: CommandAbortedException.idl:34
This exception is thrown if an exception situation occurred during the processing of a command and an...
Definition: CommandFailedException.idl:40
Objects of this interface provide information about a package's type.
Definition: XPackageTypeInfo.idl:33
Objects of this interface reflect a bound package and are issued by a PackageRegistryBackend.
Definition: XPackage.idl:47
com::sun::star::beans::Optional< string > getIdentifier()
returns the unique extension identifier.
string getName()
returns the file name of the package.
void revokePackage([in] boolean startup, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
revokes this XPackage.
boolean isBundle()
reflects whether this package is a bundle of one or more packages, e.g.
long checkPrerequisites([in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv, [in] boolean alreadyInstalled)
checks if the package can be installed.
boolean checkDependencies([in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
checks if the dependencies for this package are still satisfied
void registerPackage([in] boolean startup, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
registers this XPackage.
string getVersion()
returns the textual version representation of the package.
com::sun::star::beans::Optional< com::sun::star::beans::Ambiguous< boolean > > isRegistered([in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
determines whether the package is currently registered, i.e.
sequence< XPackage > getBundle([in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
Gets packages of the bundle.
com::sun::star::task::XAbortChannel createAbortChannel()
creates a command channel to be used to asynchronously abort a command.
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:43
Use this interface to abort a command asynchronously.
Definition: XAbortChannel.idl:31
defines the environment for a command.
Definition: XCommandEnvironment.idl:36
broadcasts each modification made on the date data of the object which supports this interface.
Definition: XModifyBroadcaster.idl:38
Definition: Accessible.idl:22