LibreOffice
LibreOffice 5.1 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 
81  long checkPrerequisites(
82  [in] com::sun::star::task::XAbortChannel xAbortChannel,
84  [in] boolean alreadyInstalled)
85  raises (DeploymentException,
89 
104  boolean checkDependencies(
106  raises (DeploymentException,
109 
110 
124  com::sun::star::beans::Optional<
125  com::sun::star::beans::Ambiguous<boolean> > isRegistered(
126  [in] com::sun::star::task::XAbortChannel xAbortChannel,
128  raises (DeploymentException,
131 
146  void registerPackage(
147  [in] boolean startup,
148  [in] com::sun::star::task::XAbortChannel xAbortChannel,
150  raises (DeploymentException,
155 
170  void revokePackage(
171  [in] boolean startup,
172  [in] com::sun::star::task::XAbortChannel xAbortChannel,
174  raises (DeploymentException,
178 
185  boolean isBundle();
186 
200  sequence<XPackage> getBundle(
201  [in] com::sun::star::task::XAbortChannel xAbortChannel,
203  raises (DeploymentException,
207 
213  string getName();
214 
223  com::sun::star::beans::Optional<string> getIdentifier();
224 
235  string getVersion()
236  raises (ExtensionRemovedException);
237 
243  string getURL();
244 
251  string getDisplayName()
252  raises (ExtensionRemovedException);
253 
259  string getDescription()
260  raises (ExtensionRemovedException);
261 
267  string getLicenseText()
268  raises (DeploymentException,
269  ExtensionRemovedException);
270 
280  sequence<string> getUpdateInformationURLs()
281  raises (ExtensionRemovedException);
291  ::com::sun::star::beans::StringPair getPublisherInfo()
292  raises (ExtensionRemovedException);
298  XPackageTypeInfo getPackageType();
299 
311  void exportTo( [in] string destFolderURL,
312  [in] string newTitle,
313  [in] long nameClashAction,
314  [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
315  raises (
316  ExtensionRemovedException,
317  com::sun::star::ucb::CommandFailedException,
318  com::sun::star::ucb::CommandAbortedException,
319  com::sun::star::ucb::ContentCreationException);
320 
330  com::sun::star::graphic::XGraphic getIcon( [in] boolean highContrast )
331  raises (ExtensionRemovedException);
332 
335  string getRepositoryName();
336 
351  com::sun::star::beans::Optional<string> getRegistrationDataURL()
352  raises (DeploymentException, ExtensionRemovedException);
353 
359  boolean isRemoved();
360 
361 };
362 
363 }; }; }; };
364 
365 #endif
366 
367 /* 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 exclicitly 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