LibreOffice
LibreOffice 25.8 SDK API Reference
Loading...
Searching...
No Matches
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
21module com { module sun { module star { module deployment {
22
28interface XPackage
29{
33
37
38
45
67 [in] com::sun::star::task::XAbortChannel xAbortChannel,
69 [in] boolean alreadyInstalled)
70 raises (DeploymentException,
74
91 raises (DeploymentException,
94
95
109 com::sun::star::beans::Optional<
110 com::sun::star::beans::Ambiguous<boolean> > isRegistered(
111 [in] com::sun::star::task::XAbortChannel xAbortChannel,
113 raises (DeploymentException,
116
132 [in] boolean startup,
133 [in] com::sun::star::task::XAbortChannel xAbortChannel,
135 raises (DeploymentException,
140
156 [in] boolean startup,
157 [in] com::sun::star::task::XAbortChannel xAbortChannel,
159 raises (DeploymentException,
163
170 boolean isBundle();
171
185 sequence<XPackage> getBundle(
186 [in] com::sun::star::task::XAbortChannel xAbortChannel,
188 raises (DeploymentException,
192
198 string getName();
199
208 com::sun::star::beans::Optional<string> getIdentifier();
209
220 string getVersion()
222
228 string getURL();
229
238
246
253 raises (DeploymentException,
255
265 sequence<string> getUpdateInformationURLs()
275
276 ::com::sun::star::beans::StringPair getPublisherInfo()
284
296 void exportTo( [in] string destFolderURL,
297 [in] string newTitle,
298 [in] long nameClashAction,
299 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
300 raises (
302 com::sun::star::ucb::CommandFailedException,
303 com::sun::star::ucb::CommandAbortedException,
304 com::sun::star::ucb::ContentCreationException);
305
315 com::sun::star::graphic::XGraphic getIcon( [in] boolean highContrast )
317
321
336 com::sun::star::beans::Optional<string> getRegistrationDataURL()
338
344 boolean isRemoved();
345
346};
347
348}; }; }; };
349
350/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
A DeploymentException reflects a deployment error.
Definition DeploymentException.idl:28
indicates that a function call with the given arguments is not supported because the extension was re...
Definition ExtensionRemovedException.idl:31
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
This exception is thrown to indicate that a command was aborted.
Definition CommandAbortedException.idl:30
This exception is thrown if an exception situation occurred during the processing of a command and an...
Definition CommandFailedException.idl:35
Objects of this interface provide information about a package's type.
Definition XPackageTypeInfo.idl:27
Objects of this interface reflect a bound package and are issued by a PackageRegistryBackend.
Definition XPackage.idl:29
string getRepositoryName()
returns the name of the repository where this object comes from.
XPackageTypeInfo getPackageType()
returns the XPackageTypeInfo, e.g.
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.
com::sun::star::beans::Optional< string > getRegistrationDataURL()
return a URL to a directory which contains the registration data.
sequence< string > getUpdateInformationURLs()
returns a sequence of update information URLs.
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.
void exportTo([in] string destFolderURL, [in] string newTitle, [in] long nameClashAction, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
exports package to given destination URL.
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.
string getLicenseText()
returns a string containing the license text.
string getDisplayName()
returns the display name of the package, e.g.
com::sun::star::graphic::XGraphic getIcon([in] boolean highContrast)
returns an icon for a package.
boolean isRemoved()
indicates if this object represents a removed extension or extension item.
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::beans::StringPair getPublisherInfo()
returns the publisher info for the package, the strings might be empty, if there is no publisher
string getDescription()
returns a description string to describe the package.
com::sun::star::task::XAbortChannel createAbortChannel()
creates a command channel to be used to asynchronously abort a command.
string getURL()
returns the location of the package.
allows to explicitly free resources and break cyclic references.
Definition XComponent.idl:39
Use this interface to abort a command asynchronously.
Definition XAbortChannel.idl:27
defines the environment for a command.
Definition XCommandEnvironment.idl:29
broadcasts each modification made on the date data of the object which supports this interface.
Definition XModifyBroadcaster.idl:32
Java beans-like property access and introspection.
Definition Ambiguous.idl:20
Interfaces for graphic handling.
Definition EmfTools.idl:21
Universal Content Broker interfaces.
Definition modules.idl:380
the module com::sun::star is the root module of the UNO API.
Definition Ambiguous.idl:20
Definition Ambiguous.idl:20
Definition Ambiguous.idl:20