LibreOffice
LibreOffice 6.2 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 
39 module com { module sun { module star { module deployment {
40 
46 interface XPackage
47 {
51 
55 
56 
62  com::sun::star::task::XAbortChannel createAbortChannel();
63 
84  long checkPrerequisites(
85  [in] com::sun::star::task::XAbortChannel xAbortChannel,
87  [in] boolean alreadyInstalled)
88  raises (DeploymentException,
92 
107  boolean checkDependencies(
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 
149  void registerPackage(
150  [in] boolean startup,
151  [in] com::sun::star::task::XAbortChannel xAbortChannel,
153  raises (DeploymentException,
158 
173  void revokePackage(
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()
239  raises (ExtensionRemovedException);
240 
246  string getURL();
247 
254  string getDisplayName()
255  raises (ExtensionRemovedException);
256 
262  string getDescription()
263  raises (ExtensionRemovedException);
264 
270  string getLicenseText()
271  raises (DeploymentException,
272  ExtensionRemovedException);
273 
283  sequence<string> getUpdateInformationURLs()
284  raises (ExtensionRemovedException);
294  ::com::sun::star::beans::StringPair getPublisherInfo()
295  raises (ExtensionRemovedException);
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 (
319  ExtensionRemovedException,
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 )
334  raises (ExtensionRemovedException);
335 
338  string getRepositoryName();
339 
354  com::sun::star::beans::Optional<string> getRegistrationDataURL()
355  raises (DeploymentException, ExtensionRemovedException);
356 
362  boolean isRemoved();
363 
364 };
365 
366 }; }; }; };
367 
368 #endif
369 
370 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Objects of this interface provide information about a package&#39;s type.
Definition: XPackageTypeInfo.idl:32
A DeploymentException reflects a deployment error.
Definition: DeploymentException.idl:32
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:42
Definition: Ambiguous.idl:22
indicates that a function call with the given arguments is not supported because the extension was re...
Definition: ExtensionRemovedException.idl:36
defines the environment for a command.
Definition: XCommandEnvironment.idl:36
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument...
Definition: IllegalArgumentException.idl:29
broadcasts each modification made on the date data of the object which supports this interface...
Definition: XModifyBroadcaster.idl:37
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 reflect a bound package and are issued by a PackageRegistryBackend.
Definition: XPackage.idl:46
This exception is thrown to indicate that a command was aborted.
Definition: CommandAbortedException.idl:34
Use this interface to abort a command asynchronously.
Definition: XAbortChannel.idl:30