diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/task | |
parent | Initial commit. (diff) | |
download | libreoffice-upstream.tar.xz libreoffice-upstream.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/task')
47 files changed, 2754 insertions, 0 deletions
diff --git a/offapi/com/sun/star/task/AsyncJob.idl b/offapi/com/sun/star/task/AsyncJob.idl new file mode 100644 index 000000000..6482cf7e4 --- /dev/null +++ b/offapi/com/sun/star/task/AsyncJob.idl @@ -0,0 +1,51 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_AsyncJob_idl__ +#define __com_sun_star_task_AsyncJob_idl__ + +#include <com/sun/star/task/XAsyncJob.idl> +#include <com/sun/star/util/XCloseable.idl> + + +module com { module sun { module star { module task { + +/** Represent an asynchronous job, which can be executed by the global + theJobExecutor instance. + + @see Job + + @since OOo 1.1.2 + */ +published service AsyncJob +{ + /** used to initialize and execute this job. + */ + interface com::sun::star::task::XAsyncJob; + + /** should be supported to handle environment termination gracefully. + */ + [optional] interface com::sun::star::util::XCloseable; +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/ClassifiedInteractionRequest.idl b/offapi/com/sun/star/task/ClassifiedInteractionRequest.idl new file mode 100644 index 000000000..bfc323b95 --- /dev/null +++ b/offapi/com/sun/star/task/ClassifiedInteractionRequest.idl @@ -0,0 +1,45 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__ +#define __com_sun_star_task_ClassifiedInteractionRequest_idl__ + +#include <com/sun/star/uno/Exception.idl> + +#include <com/sun/star/task/InteractionClassification.idl> + + + + module com { module sun { module star { module task { + +/** A classified interaction request. + */ +published exception ClassifiedInteractionRequest: com::sun::star::uno::Exception +{ + /** The classification of the request. + */ + com::sun::star::task::InteractionClassification Classification; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl b/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl new file mode 100644 index 000000000..a7a95a9af --- /dev/null +++ b/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl @@ -0,0 +1,51 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_DocumentMSPasswordRequest_idl__ +#define __com_sun_star_task_DocumentMSPasswordRequest_idl__ + +#include <com/sun/star/task/PasswordRequest.idl> + + + +module com { module sun { module star { module task { + +/** this request specifies the mode in which the password for Microsoft Office file format encryption should be asked + + <P> + It is supported by InteractionHandler service, and can + be used to interact for a document password. Continuations for using with + the mentioned service are Abort and Approve. + </P> + + @since OOo 3.2 +*/ +published exception DocumentMSPasswordRequest: PasswordRequest +{ + /** the name of the document (more properly, the URL of the document) + */ + string Name; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl b/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl new file mode 100644 index 000000000..64fca4e97 --- /dev/null +++ b/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl @@ -0,0 +1,54 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_DocumentMSPasswordRequest2_idl__ +#define __com_sun_star_task_DocumentMSPasswordRequest2_idl__ + +#include <com/sun/star/task/DocumentMSPasswordRequest.idl> + + + +module com { module sun { module star { module task { + +/** this request specifies if a password for opening or modifying of an encrypted Microsoft Office document is requested. + + <P> + It is supported by InteractionHandler service, and can + be used to interact for a document password. Continuations for using with + the mentioned service are Abort and Approve. + </P> + + @see com::sun::star::task::PasswordRequest + @see com::sun::star::task::DocumentMSPasswordRequest + + @since OOo 3.3 +*/ +exception DocumentMSPasswordRequest2 : DocumentMSPasswordRequest +{ + /** specifies if the requested password is for opening a document or for modifying it. + */ + boolean IsRequestPasswordToModify; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/DocumentMacroConfirmationRequest.idl b/offapi/com/sun/star/task/DocumentMacroConfirmationRequest.idl new file mode 100644 index 000000000..667ad5f48 --- /dev/null +++ b/offapi/com/sun/star/task/DocumentMacroConfirmationRequest.idl @@ -0,0 +1,69 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_DocumentMacroConfirmationRequest_idl__ +#define __com_sun_star_task_DocumentMacroConfirmationRequest_idl__ + +#include <com/sun/star/task/ClassifiedInteractionRequest.idl> +#include <com/sun/star/embed/XStorage.idl> +#include <com/sun/star/security/DocumentSignatureInformation.idl> + + +module com { module sun { module star { module task { + + +/** describes the request to approve or deny the execution of macros contained in + a document. + */ +exception DocumentMacroConfirmationRequest : ClassifiedInteractionRequest +{ + /** specifies the URL of the document which contains macros whose execution + should be approved or rejected. + */ + string DocumentURL; + + /** refers to the storage related to the last committed version of the + document. + + This storage is necessary e.g. for displaying the existing signatures to + the user, to allow him a decision whether or not to trust those signatures + and thus the signed macros. + + @see ::com::sun::star::security::XDocumentDigitalSignatures::showScriptingContentSignatures + */ + ::com::sun::star::embed::XStorage + DocumentStorage; + + /** contains information about the ODF version of the document + */ + string DocumentVersion; + + /** contains information about the signatures in the document + */ + sequence< ::com::sun::star::security::DocumentSignatureInformation > + DocumentSignatureInformation; +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/DocumentPasswordRequest.idl b/offapi/com/sun/star/task/DocumentPasswordRequest.idl new file mode 100644 index 000000000..0829d24ab --- /dev/null +++ b/offapi/com/sun/star/task/DocumentPasswordRequest.idl @@ -0,0 +1,51 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_DocumentPasswordRequest_idl__ +#define __com_sun_star_task_DocumentPasswordRequest_idl__ + +#include <com/sun/star/task/PasswordRequest.idl> + + + +module com { module sun { module star { module task { + +/** this request specifies the mode in which the password should be asked + + <P> + It is supported by InteractionHandler service, and can + be used to interact for a document password. Continuations for using with + the mentioned service are Abort and Approve. + </P> + + @since OOo 1.1.2 +*/ +published exception DocumentPasswordRequest: PasswordRequest +{ + /** the name of the document (more properly, the URL of the document) + */ + string Name; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/DocumentPasswordRequest2.idl b/offapi/com/sun/star/task/DocumentPasswordRequest2.idl new file mode 100644 index 000000000..9fcc19a81 --- /dev/null +++ b/offapi/com/sun/star/task/DocumentPasswordRequest2.idl @@ -0,0 +1,54 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_DocumentPasswordRequest2_idl__ +#define __com_sun_star_task_DocumentPasswordRequest2_idl__ + +#include <com/sun/star/task/DocumentPasswordRequest.idl> + + + +module com { module sun { module star { module task { + +/** this request specifies if a password for opening or modifying a document is requested. + + <P> + It is supported by InteractionHandler service, and can + be used to interact for a document password. Continuations for using with + the mentioned service are Abort and Approve. + </P> + + @see com::sun::star::task::PasswordRequest + @see com::sun::star::task::DocumentPasswordRequest + + @since OOo 3.3 +*/ +exception DocumentPasswordRequest2 : DocumentPasswordRequest +{ + /** specifies if the requested password is for opening a document or for modifying it. + */ + boolean IsRequestPasswordToModify; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/ErrorCodeIOException.idl b/offapi/com/sun/star/task/ErrorCodeIOException.idl new file mode 100644 index 000000000..20011c3a4 --- /dev/null +++ b/offapi/com/sun/star/task/ErrorCodeIOException.idl @@ -0,0 +1,43 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_ErrorCodeIOException_idl__ +#define __com_sun_star_task_ErrorCodeIOException_idl__ + +#include <com/sun/star/io/IOException.idl> + + + module com { module sun { module star { module task { + + +/** IOException that carries a legacy error code (not only I/O related). + */ +exception ErrorCodeIOException : com::sun::star::io::IOException +{ + /** specifies the error code; see tools/errcode.hxx for details. + */ + + long ErrCode; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/ErrorCodeRequest.idl b/offapi/com/sun/star/task/ErrorCodeRequest.idl new file mode 100644 index 000000000..01703e099 --- /dev/null +++ b/offapi/com/sun/star/task/ErrorCodeRequest.idl @@ -0,0 +1,45 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_ErrorCodeRequest_idl__ +#define __com_sun_star_task_ErrorCodeRequest_idl__ + +#include <com/sun/star/uno/Exception.idl> + + + module com { module sun { module star { module task { + + +/** represents a general error exception. + It can be used to transport the error code information. + E.g. that can be useful for interactions. + + @since OOo 1.1.2 + */ +published exception ErrorCodeRequest : com::sun::star::uno::Exception +{ + /** specifies the error code. */ + long ErrCode; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/InteractionClassification.idl b/offapi/com/sun/star/task/InteractionClassification.idl new file mode 100644 index 000000000..47405e401 --- /dev/null +++ b/offapi/com/sun/star/task/InteractionClassification.idl @@ -0,0 +1,63 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_InteractionClassification_idl__ +#define __com_sun_star_task_InteractionClassification_idl__ + + + + module com { module sun { module star { module task { + +/** A classification of interaction requests. + + @see com::sun::star::task::ClassifiedInteractionRequest + This is the base of classified interaction requests. + */ +published enum InteractionClassification +{ + /** An error. + */ + ERROR, + + /** A warning, less severe than an error. + */ + WARNING, + + /** Some information for the client/user (which will typically lead to the + selection of an + com::sun::star::task::XInteractionApprove + continuation). + */ + INFO, + + /** A query for the client/user (which will typically lead to the + selection of an + com::sun::star::task::XInteractionApprove or + com::sun::star::task::XInteractionDisapprove + continuation). + */ + QUERY + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/InteractionHandler.idl b/offapi/com/sun/star/task/InteractionHandler.idl new file mode 100644 index 000000000..48f8dd736 --- /dev/null +++ b/offapi/com/sun/star/task/InteractionHandler.idl @@ -0,0 +1,171 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_InteractionHandler_idl__ +#define __com_sun_star_task_InteractionHandler_idl__ + +module com { module sun { module star { + module task { published interface XInteractionHandler2; }; + module awt { published interface XWindow; }; +}; }; }; + +module com { module sun { module star { module task { + +/** An interaction request handler that lets the user handle requests via GUI dialogs. + + <p>The interaction handler service has a number of <a href="#built_in_handler">built-in handlers</a>, responsible + for a lot of well known interactions. Additionally, there's a configuration module which allows to + <a href="#configuring_handlers">configure additional handlers</a>, responsible for arbitrary requests.</a></p> + + <a name="built_in_handler"></a> + <h3>Built-in Handlers</h3> + The following well-known requests can be dealt with by the built-in handlers: + <UL> + <LI>com::sun::star::ucb::AuthenticationRequest</LI> + <LI>com::sun::star::ucb::CertificateValidationRequest</LI> + <LI>com::sun::star::ucb::InteractiveAugmentedIOException*</LI> + <LI>com::sun::star::ucb::InteractiveFileIOException*</LI> + <LI>com::sun::star::ucb::InteractiveIOException*</LI> + <LI>com::sun::star::ucb::InteractiveNetworkConnectException*</LI> + <LI>com::sun::star::ucb::InteractiveNetworkException*</LI> + <LI>com::sun::star::ucb::InteractiveNetworkGeneralException*</LI> + <LI>com::sun::star::ucb::InteractiveNetworkOffLineException*</LI> + <LI>com::sun::star::ucb::InteractiveNetworkReadException*</LI> + <LI>com::sun::star::ucb::InteractiveNetworkResolveNameException*</LI> + <LI>com::sun::star::ucb::InteractiveNetworkWriteException*</LI> + <LI>com::sun::star::ucb::InteractiveWrongMediumException*</LI> + <LI>com::sun::star::task::PasswordRequest</LI> + <LI>com::sun::star::java::WrongJavaVersionException*</LI> + <LI>com::sun::star::task::DocumentMacroConfirmationRequest</LI> + </UL> + The requests marked with an asterisk are only handled if (a) their + continuations match certain restrictions (see below), and (b) the + necessary resource strings are available (this can be exploited by + applications that carry only a subset of all resource files with + them).</P> + + <P>The continuation restrictions are as follows: Let <VAR>C</VAR> be the + subset of the provided continuations that are of type + com::sun::star::task::XInteractionApprove, + com::sun::star::task::XInteractionDisapprove, + com::sun::star::task::XInteractionRetry, or + com::sun::star::task::XInteractionAbort (or of a + derived type). All other continuations are ignored for these requests. + The request is only handled if the set <VAR>C</VAR> is any of the + following: + <UL> + <LI>Abort</LI> + <LI>Retry, Abort</LI> + <LI>Approve</LI> + <LI>Approve, Abort</LI> + <LI>Approve, Disapprove</LI> + <LI>Approve, Disapprove, Abort</LI> + </UL></P> + + <P>An + com::sun::star::ucb::InteractiveAugmentedIOException + carries with it a sequence of arguments, which should be + com::sun::star::beans::PropertyValues. The following + details which properties are interpreted by the interaction handler, + depending on the request's + com::sun::star::ucb::IOErrorCode: + <DL> + <DT><code>"Uri"</code></DT> + <DD>All error codes except + com::sun::star::ucb::IOErrorCode::DIFFERENT_DEVICES. + The URI of the involved resource (a `string`).</DD> + + <DT><code>"ResourceName"</code></DT> + <DD>All error codes except + com::sun::star::ucb::IOErrorCode::DIFFERENT_DEVICES. + A name for the involved resource (a `string`) that might be + more meaningful to the user than the URI. For example, a + (platform-dependent) path notation for file system resources.</DD> + + <DT><code>"ResourceType"</code></DT> + <DD>com::sun::star::ucb::IOErrorCode::DEVICE_NOT_READY + and + com::sun::star::ucb::IOErrorCode::NOT_EXISTING + only. An identifier for the type of resource involved (a + `string`). Currently understood values are + <code>"volume"</code> (e.g., a file system volume) and + <code>"folder"</code> (i.e., a resource that contains other + resources).</DD> + + <DT><code>"Removable"</code></DT> + <DD>com::sun::star::ucb::IOErrorCode::NOT_EXISTING + only. A flag indicating whether the resource resides on a storage + medium that can be removed by the user (a `boolean`).</DD> + + <DT><code>"Folder"</code></DT> + <DD>com::sun::star::ucb::IOErrorCode::CANT_CREATE + only. The name of the folder in which a resource cannot be created (a + `string`).</DD> + + <DT><code>"Volume"</code> and <code>"OtherVolume"</code></DT> + <DD>com::sun::star::ucb::IOErrorCode::DIFFERENT_DEVICES + only. The names of the two volumes involved (two + `string`s).</DD> + </DL></P> + + <a name="configuring_handlers"></a> + <h3>Configuring additional Handlers</h3> + + <p>It is possible to configure additional interaction handlers, to which certain requests can be delegated. The + configuration node <code>/org.openoffice.Interaction/InteractionHandlers</code> is evaluated and respected + by the <code>InteractionHandler</code> implementation.</p> + + <p>A custom interaction handler can declare itself responsible for an arbitrary number of UNO types, specified + by full-qualified type name. Also, for each type, it can specify whether it is responsible for only this particular + type, or all possibly existent derived types.</p> + + <p>Whenever the <code>InteractionHandler</code> encounters a request it cannot fulfill itself, it will examine + the configuration, to find a handler implementation for the request, and delegate it to the first matching + handler.</p> + + <p>If multiple custom interaction handlers declare themselves responsible for the same request type, it is not + defined which handler will actually be invoked. Thus, when deploying a custom interaction handler, ensure + that the types you specify are general enough to cover all requests you want to handle, but also specific + enough to not cover requests which other handlers might be interested in.</p> + */ +published service InteractionHandler : XInteractionHandler2 +{ + /** Creates an instance. + + @param parent denotes the parent window for any GUI dialogs the + interaction handler pops up; may be null. + */ + createWithParent([in] com::sun::star::awt::XWindow parent); + + /** Creates an instance with an additional context. + + @param parent denotes the parent window for any GUI dialogs the + interaction handler pops up; may be null. + + @param context is a textual description of the current context (used, + e.g., as a first line of text in error boxes). + */ + createWithParentAndContext([in] com::sun::star::awt::XWindow parent, [in] string context); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/InteractionRequestStringResolver.idl b/offapi/com/sun/star/task/InteractionRequestStringResolver.idl new file mode 100644 index 000000000..29a5c8a13 --- /dev/null +++ b/offapi/com/sun/star/task/InteractionRequestStringResolver.idl @@ -0,0 +1,39 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_InteractionRequestStringResolver_idl__ +#define __com_sun_star_task_InteractionRequestStringResolver_idl__ + +module com { module sun { module star { + module task { interface XInteractionRequestStringResolver; }; +}; }; }; + +module com { module sun { module star { module task { + +/* An interaction request string resolver that obtains human readable strings + from an XInteractionRequest. + */ +/* published */ +service InteractionRequestStringResolver : XInteractionRequestStringResolver; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/Job.idl b/offapi/com/sun/star/task/Job.idl new file mode 100644 index 000000000..414975e52 --- /dev/null +++ b/offapi/com/sun/star/task/Job.idl @@ -0,0 +1,51 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_Job_idl__ +#define __com_sun_star_task_Job_idl__ + +#include <com/sun/star/task/XJob.idl> +#include <com/sun/star/util/XCloseable.idl> + + +module com { module sun { module star { module task { + +/** Represent a synchronous job, which can be executed by the global + theJobExecutor instance. + + @see AsyncJob + + @since OOo 1.1.2 + */ +published service Job +{ + /** used to initialize and execute this job. + */ + interface com::sun::star::task::XJob; + + /** should be supported to handle environment termination gracefully. + */ + [optional] interface com::sun::star::util::XCloseable; +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/JobExecutor.idl b/offapi/com/sun/star/task/JobExecutor.idl new file mode 100644 index 000000000..14d5b581c --- /dev/null +++ b/offapi/com/sun/star/task/JobExecutor.idl @@ -0,0 +1,39 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_JobExecutor_idl__ +#define __com_sun_star_task_JobExecutor_idl__ + +#include <com/sun/star/task/XJobExecutor.idl> + + +module com { module sun { module star { module task { + +/** + A legacy (single-instance) service-variant of theJobExecutor singleton. + + @deprecated Use theJobExecutor singleton instead. + */ +published service JobExecutor : XJobExecutor; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/MasterPasswordRequest.idl b/offapi/com/sun/star/task/MasterPasswordRequest.idl new file mode 100644 index 000000000..fcc88d08b --- /dev/null +++ b/offapi/com/sun/star/task/MasterPasswordRequest.idl @@ -0,0 +1,47 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_MasterPasswordRequest_idl__ +#define __com_sun_star_task_MasterPasswordRequest_idl__ + +#include <com/sun/star/task/PasswordRequest.idl> + + + +module com { module sun { module star { module task { + +/** this request specifies the mode in which the password should be asked + + <P> + It is supported by InteractionHandler service, and can + be used to interact for a master password. Continuations for using with + the mentioned service are Abort and Approve. + </P> + + @since OOo 1.1.2 +*/ +published exception MasterPasswordRequest: PasswordRequest +{ +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/NoMasterException.idl b/offapi/com/sun/star/task/NoMasterException.idl new file mode 100644 index 000000000..91c7f7250 --- /dev/null +++ b/offapi/com/sun/star/task/NoMasterException.idl @@ -0,0 +1,44 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_NoMasterException_idl__ +#define __com_sun_star_task_NoMasterException_idl__ + +#include <com/sun/star/uno/RuntimeException.idl> +#include <com/sun/star/task/PasswordRequestMode.idl> + + + +module com { module sun { module star { module task { + +/** is thrown when a master password is needed but not available/correct. + */ +published exception NoMasterException: com::sun::star::uno::RuntimeException +{ + /** specifies the mode in which password should be queried. + */ + PasswordRequestMode Mode; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/OfficeRestartManager.idl b/offapi/com/sun/star/task/OfficeRestartManager.idl new file mode 100644 index 000000000..a28ff4a01 --- /dev/null +++ b/offapi/com/sun/star/task/OfficeRestartManager.idl @@ -0,0 +1,42 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_OfficeRestartManager_idl__ +#define __com_sun_star_task_OfficeRestartManager_idl__ + + +module com { module sun { module star { module task { + +interface XRestartManager; + + +/** This singleton is intended to allow to restart the office asynchronously. + + @since OOo 3.3 + */ +singleton OfficeRestartManager : XRestartManager; + + +}; }; }; }; + + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/PDFExportException.idl b/offapi/com/sun/star/task/PDFExportException.idl new file mode 100644 index 000000000..798b5f623 --- /dev/null +++ b/offapi/com/sun/star/task/PDFExportException.idl @@ -0,0 +1,43 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_PDFExportException_idl__ +#define __com_sun_star_task_PDFExportException_idl__ + +#include <com/sun/star/uno/Exception.idl> + + module com { module sun { module star { module task { + + +/** is an exception that provides information on an error during PDF export. + */ +published exception PDFExportException: com::sun::star::uno::Exception +{ + /** contains a number of errors that occurred during PDFExport + */ + sequence< long > ErrorCodes; +}; + + +}; }; }; }; + +/*=========================================================================== +===========================================================================*/ +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/PasswordContainer.idl b/offapi/com/sun/star/task/PasswordContainer.idl new file mode 100644 index 000000000..530b912e2 --- /dev/null +++ b/offapi/com/sun/star/task/PasswordContainer.idl @@ -0,0 +1,55 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_PasswordContainer_idl__ +#define __com_sun_star_task_PasswordContainer_idl__ + +module com { module sun { module star { + module task { + published interface XPasswordContainer2; + }; +}; }; }; + +module com { module sun { module star { module task { +/** this service is kind of storage that allows to store passwords + and to retrieve already stored. + + <p> + A password can be stored for the session period or persistently. + The persistent way is only possible if configuration allows to use storage. + It stores passwords encrypted with a super password. An interaction + is used to ask a user for a super password. + To allow such an interaction, an object that implements XInteractionHandler + interface should be provided. For this purpose InteractionHandler + service can be used. + </p> + + <p> + In case no interaction handler is provided all passwords are stored + for the session period. In case an interaction handler is provided, but + the super password interaction does not return super password ( for any reason ), + NoMasterException exception is thrown to let user use + non-persistent way explicitly. + </p> +*/ +published service PasswordContainer : com::sun::star::task::XPasswordContainer2; + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/PasswordContainerInteractionHandler.idl b/offapi/com/sun/star/task/PasswordContainerInteractionHandler.idl new file mode 100644 index 000000000..e973a5464 --- /dev/null +++ b/offapi/com/sun/star/task/PasswordContainerInteractionHandler.idl @@ -0,0 +1,50 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_PasswordContainerInteractionHandler_idl__ +#define __com_sun_star_task_PasswordContainerInteractionHandler_idl__ + +module com { module sun { module star { + module task { published interface XInteractionHandler; }; +}; }; }; + +module com { module sun { module star { module task { + +/** An interaction request handler that uses the + com::sun::star::task::PasswordContainer service to + handle com::sun::star::ucb::AuthenticationRequest. + + If the password container contains credentials matching the authentication + request, the service implementation selects the + com::sun::star::ucb::XInteractionSupplyAuthentication + continuation, that should be supplied with the interaction request. + + If the password container does not contain credentials matching the + authentication request, the service implementation selects no continuation. + + @since OOo 3.3 + */ +published service PasswordContainerInteractionHandler + : com::sun::star::task::XInteractionHandler; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/PasswordRequest.idl b/offapi/com/sun/star/task/PasswordRequest.idl new file mode 100644 index 000000000..855e1210a --- /dev/null +++ b/offapi/com/sun/star/task/PasswordRequest.idl @@ -0,0 +1,52 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_PasswordRequest_idl__ +#define __com_sun_star_task_PasswordRequest_idl__ + +#include <com/sun/star/task/ClassifiedInteractionRequest.idl> +#include <com/sun/star/task/PasswordRequestMode.idl> + + + +module com { module sun { module star { module task { + +/** this request specifies the mode in which the password should be asked + + <P> + It is supported by InteractionHandler service, and can + be used to interact for a password. Continuations for using with + the mentioned service are Abort and Approve. + </P> +*/ +published exception PasswordRequest: ClassifiedInteractionRequest +{ + /** the mode in which password should be asked + + @see com::sun::star::task::PasswordRequestMode + */ + PasswordRequestMode Mode; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/PasswordRequestMode.idl b/offapi/com/sun/star/task/PasswordRequestMode.idl new file mode 100644 index 000000000..7f2dbf319 --- /dev/null +++ b/offapi/com/sun/star/task/PasswordRequestMode.idl @@ -0,0 +1,67 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_PasswordRequestMode_idl__ +#define __com_sun_star_task_PasswordRequestMode_idl__ + + + +module com { module sun { module star { module task { + +/** the mode in which a password should be asked + @see PasswordRequest + */ +published enum PasswordRequestMode +{ + + /** Password creation. + + <P> + The password is asked for the first time, + so it should be entered twice. + </P> + */ + PASSWORD_CREATE, + + + /** Ask for a password. + + <P> + Just ask for a password. + </P> + */ + PASSWORD_ENTER, + + + /** Wrong password was entered, ask again. + + <P> + A wrong password was entered, notify user + and ask again. + </P> + */ + PASSWORD_REENTER + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/StatusIndicatorFactory.idl b/offapi/com/sun/star/task/StatusIndicatorFactory.idl new file mode 100644 index 000000000..cc2c7497d --- /dev/null +++ b/offapi/com/sun/star/task/StatusIndicatorFactory.idl @@ -0,0 +1,43 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_StatusIndicatorFactory_idl__ +#define __com_sun_star_task_StatusIndicatorFactory_idl__ + +#include <com/sun/star/awt/XWindow.idl> +#include <com/sun/star/frame/XFrame.idl> +#include <com/sun/star/task/XStatusIndicatorFactory.idl> + + + module com { module sun { module star { module task { + +/** + @since LibreOffice 4.1 + */ +service StatusIndicatorFactory : XStatusIndicatorFactory +{ + createWithFrame( [in] com::sun::star::frame::XFrame Frame, [in] boolean DisableReschedule, [in] boolean AllowParentShow ); + + createWithWindow( [in] com::sun::star::awt::XWindow ParentWindow, [in] boolean DisableReschedule, [in] boolean AllowParentShow ); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/UnsupportedOverwriteRequest.idl b/offapi/com/sun/star/task/UnsupportedOverwriteRequest.idl new file mode 100644 index 000000000..840f26912 --- /dev/null +++ b/offapi/com/sun/star/task/UnsupportedOverwriteRequest.idl @@ -0,0 +1,51 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_UnsupportedOverwriteRequest_idl__ +#define __com_sun_star_task_UnsupportedOverwriteRequest_idl__ + +#include <com/sun/star/task/ClassifiedInteractionRequest.idl> + + + +module com { module sun { module star { module task { + +/** this request is used in case a content can't keep files from overwriting + + <P> + It is supported by InteractionHandler service, and can + be used in case a content can not keep files from overwriting and + user specifies to do so. Continuations for using with + the mentioned service are Abort and Approve. + </P> + + @since OOo 1.1.2 +*/ +published exception UnsupportedOverwriteRequest: ClassifiedInteractionRequest +{ + /** the name of the target that might be overwritten, can be empty. + */ + string Name; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/UrlRecord.idl b/offapi/com/sun/star/task/UrlRecord.idl new file mode 100644 index 000000000..d5e3f7934 --- /dev/null +++ b/offapi/com/sun/star/task/UrlRecord.idl @@ -0,0 +1,43 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_UrlRecord_idl__ +#define __com_sun_star_task_UrlRecord_idl__ + +#include <com/sun/star/task/UserRecord.idl> + + +module com { module sun { module star { module task { + +/* List of users with their passwords for the url pattern. +*/ +published struct UrlRecord +{ + /// The URL for which these passwords where given. + string Url; + + // The list of user/password records for the given URL. + sequence<UserRecord> UserList; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/UserRecord.idl b/offapi/com/sun/star/task/UserRecord.idl new file mode 100644 index 000000000..f04a4176d --- /dev/null +++ b/offapi/com/sun/star/task/UserRecord.idl @@ -0,0 +1,41 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_UserRecord_idl__ +#define __com_sun_star_task_UserRecord_idl__ + + +module com { module sun { module star { module task { + +/* Specifies user/password entries for UrlRecord. +*/ +published struct UserRecord +{ + /// specifies the user name. + string UserName; + + /// specifies the passwords for the given user. + sequence<string> Passwords; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XAbortChannel.idl b/offapi/com/sun/star/task/XAbortChannel.idl new file mode 100644 index 000000000..bd0643814 --- /dev/null +++ b/offapi/com/sun/star/task/XAbortChannel.idl @@ -0,0 +1,42 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XAbortChannel_idl__ +#define __com_sun_star_task_XAbortChannel_idl__ + +#include <com/sun/star/uno/XInterface.idl> + + +module com { module sun { module star { module task { + +/** Use this interface to abort a command asynchronously. + For example, have a look at com::sun::star::deployment::XPackageManager. +*/ +interface XAbortChannel +{ + /** sends an abort notification to all commands + associated with this channel. + */ + void sendAbort(); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XAsyncJob.idl b/offapi/com/sun/star/task/XAsyncJob.idl new file mode 100644 index 000000000..1750b5e36 --- /dev/null +++ b/offapi/com/sun/star/task/XAsyncJob.idl @@ -0,0 +1,74 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_XAsyncJob_idl__ +#define __com_sun_star_task_XAsyncJob_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/beans/NamedValue.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + + +module com { module sun { module star { module task { + + published interface XJobListener; + +/** specifies a job which must be executed asynchronously + + <p> + Instead of XJob the implementation of this interface + must be aware, that execution can be made real asynchronous (e.g. by using + threads). Because the environment wish to have creation and using of threads + under control, it's not allowed for a real job implementation to use such mechanism + by itself. The outside code decide, if it's possible and how it can be made + asynchronous. In some special cases it can be, that asynchronous jobs will be executed + synchronously. + </p> + + @see XJob +*/ +published interface XAsyncJob : com::sun::star::uno::XInterface +{ + /** executes the job asynchronously + + @param Arguments + are arguments for executing the job. Their semantics is completely implementation dependent. Usually, + a concrete implementation of a job specifies in its service descriptions which parameters are allowed + (or expected). This values are persistent by the configuration of theJobExecutor + which use this asynchronous job. It's possible to write it back by called listener + function XJobListener::jobFinished(). + + @param Listener + specifies a listener which should be notified on events. May be `NULL`. + + @throws com::sun::star::lang::IllegalArgumentException + if some of given arguments doesn't fill out the service specification or + was corrupt so the service couldn't work correctly + */ + void executeAsync( + [in] sequence< com::sun::star::beans::NamedValue > Arguments, + [in] XJobListener Listener) + raises( com::sun::star::lang::IllegalArgumentException ); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XInteractionApprove.idl b/offapi/com/sun/star/task/XInteractionApprove.idl new file mode 100644 index 000000000..1fba7fc5d --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionApprove.idl @@ -0,0 +1,39 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XInteractionApprove_idl__ +#define __com_sun_star_task_XInteractionApprove_idl__ + +#include <com/sun/star/task/XInteractionContinuation.idl> + + + + module com { module sun { module star { module task { + +/** An interaction continuation specifying "approval". + */ +published interface XInteractionApprove: com::sun::star::task::XInteractionContinuation +{ +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XInteractionAskLater.idl b/offapi/com/sun/star/task/XInteractionAskLater.idl new file mode 100644 index 000000000..af884aae9 --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionAskLater.idl @@ -0,0 +1,42 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_XInteractionAskLater_idl__ +#define __com_sun_star_task_XInteractionAskLater_idl__ + +#include <com/sun/star/task/XInteractionContinuation.idl> + + +module com { module sun { module star { module task { + + +/** specifies a continuation where the user does not actually decide the question + she was confronted with, but postpones the decision to a later time. + */ +interface XInteractionAskLater : com::sun::star::task::XInteractionContinuation +{ +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XInteractionDisapprove.idl b/offapi/com/sun/star/task/XInteractionDisapprove.idl new file mode 100644 index 000000000..d16bbc514 --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionDisapprove.idl @@ -0,0 +1,39 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XInteractionDisapprove_idl__ +#define __com_sun_star_task_XInteractionDisapprove_idl__ + +#include <com/sun/star/task/XInteractionContinuation.idl> + + + + module com { module sun { module star { module task { + +/** An interaction continuation specifying "disapproval". + */ +published interface XInteractionDisapprove: com::sun::star::task::XInteractionContinuation +{ +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XInteractionPassword.idl b/offapi/com/sun/star/task/XInteractionPassword.idl new file mode 100644 index 000000000..cc1c925be --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionPassword.idl @@ -0,0 +1,52 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XInteractionPassword_idl__ +#define __com_sun_star_task_XInteractionPassword_idl__ + +#include <com/sun/star/task/XInteractionContinuation.idl> + + +module com { module sun { module star { module task { + +/** A continuation to get a password from interaction helper. + + @since OOo 1.1.2 +*/ +published interface XInteractionPassword : ::com::sun::star::task::XInteractionContinuation +{ + /** Store result password to the continuation. + + @param aPasswd the result password. + + */ + void setPassword( [in] string aPasswd ); + + /** Get result password from the continuation. + + @returns the stored password. + */ + string getPassword(); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XInteractionPassword2.idl b/offapi/com/sun/star/task/XInteractionPassword2.idl new file mode 100644 index 000000000..7160184ab --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionPassword2.idl @@ -0,0 +1,61 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XInteractionPassword2_idl__ +#define __com_sun_star_task_XInteractionPassword2_idl__ + +#include <com/sun/star/task/XInteractionPassword.idl> + + +module com { module sun { module star { module task { + +/** A continuation to get a password from interaction helper, extends + XInteractionPassword with possibility to provide password + to modify. + + @since OOo 3.3 +*/ +published interface XInteractionPassword2 : ::com::sun::star::task::XInteractionPassword +{ + /** stores "password to modify" to the continuation. + */ + void setPasswordToModify( [in] string aPasswd ); + + /** gets "password to modify" from the continuation. + */ + string getPasswordToModify(); + + /** stores "recommend readonly" to the continuation. It specifies whether + the document should be loaded readonly per default. + */ + void setRecommendReadOnly( [in] boolean bReadOnly ); + + /** gets "recommend readonly" from the continuation. It specifies whether + the document should be loaded readonly per default. + */ + boolean getRecommendReadOnly(); + + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl b/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl new file mode 100644 index 000000000..389bc55e8 --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl @@ -0,0 +1,63 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XInteractionRequestStringResolver_idl__ +#define __com_sun_star_task_XInteractionRequestStringResolver_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/beans/Optional.idl> + +#include <com/sun/star/task/XInteractionRequest.idl> + + + module com { module sun { module star { module task { + + +/** Obtains human readable strings from an XInteractionRequest. + */ +/* published */ +interface XInteractionRequestStringResolver : com::sun::star::uno::XInterface +{ + + /** Obtains a string containing a human readable message from an + informational interaction request. + + <p>An informational interaction request contains not more than one + interaction continuation (user has no choice; request is just + informational). The supplies continuation must either be a + XInteractionAbort or XInteractionApprove + + @param Request the interaction request for that the message shall + be obtained. + + @returns the message string or an empty + com::sun::star::beans::Optional. + */ + com::sun::star::beans::Optional< string > + getStringFromInformationalRequest( + [in] com::sun::star::task::XInteractionRequest Request ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XJob.idl b/offapi/com/sun/star/task/XJob.idl new file mode 100644 index 000000000..8300306a9 --- /dev/null +++ b/offapi/com/sun/star/task/XJob.idl @@ -0,0 +1,79 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_XJob_idl__ +#define __com_sun_star_task_XJob_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/beans/NamedValue.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + + +module com { module sun { module star { module task { + +/** specifies a job which is to be executed synchronously + + <p> + Instead of XAsyncJob the implementation of this interface + will be executed synchronously every time. That means: they can be sure that the + current stack context will be blocked till this job finish it's work. + </p> + + @see XAsyncJob +*/ +published interface XJob : com::sun::star::uno::XInterface +{ + /** executes the job synchronously + + @param Arguments + are arguments for executing the job. Their semantics is completely implementation dependent. Usually, + a concrete implementation of a job specifies in its service descriptions which parameters are allowed + (or expected). This values are persistent by the configuration of theJobExecutor + which use this synchronous job. It's possible to write it back by use special protocol + in return value. + + @return + the result of the job. The concrete semantics is service-dependent. + But it should be possible to + <ul> + <li>deregister the job</li> + <li>let him registered although execution was successful(!)</li> + <li>make some job specific data persistent inside the job configuration which + is provided by the executor.</li> + </ul> + + @throws com::sun::star::lang::IllegalArgumentException + if some of given arguments doesn't fill out the service specification or + was corrupt so the service couldn't work correctly + + @throws com::sun::star::uno::Exception + to notify the executor about failed operation; otherwise the return value + indicates a successful finishing. + */ + any execute( + [in] sequence< com::sun::star::beans::NamedValue > Arguments ) + raises( com::sun::star::lang::IllegalArgumentException , + com::sun::star::uno::Exception ); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XJobExecutor.idl b/offapi/com/sun/star/task/XJobExecutor.idl new file mode 100644 index 000000000..b27468cf4 --- /dev/null +++ b/offapi/com/sun/star/task/XJobExecutor.idl @@ -0,0 +1,63 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_XJobExecutor_idl__ +#define __com_sun_star_task_XJobExecutor_idl__ + +#include <com/sun/star/uno/XInterface.idl> + + +module com { module sun { module star { module task { + +/** starts action for any triggered event from outside + + <p> + If somewhere from outside trigger an event on this interface + it will be used to find any registered service inside configuration + of this executor. If somewhere could be found it will be + started and controlled by this instance. After it finish his work + it's possible to deactivate further startups or let him run again if + a new event will be detected later. + </p> + + @see theJobExecutor + */ +published interface XJobExecutor : com::sun::star::uno::XInterface +{ + /** trigger event to start registered jobs + + <p> + Jobs are registered in configuration and will be started by executor + automatically, if they are registered for triggered event. + The meaning of given string <var>Event</var> mustn't be known. Because + for the executor it's enough to use it for searching a registered job + inside his own configuration. So no special events will be defined here. + </p> + + @param Event + describe the event for which jobs can be registered and should be started + */ + void trigger( [in] string Event ); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XJobListener.idl b/offapi/com/sun/star/task/XJobListener.idl new file mode 100644 index 000000000..9b4068282 --- /dev/null +++ b/offapi/com/sun/star/task/XJobListener.idl @@ -0,0 +1,62 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_XJobListener_idl__ +#define __com_sun_star_task_XJobListener_idl__ + +#include <com/sun/star/lang/XEventListener.idl> + + +module com { module sun { module star { module task { + + published interface XAsyncJob; + +/** listener on finish states of asynchronous job execution + */ +published interface XJobListener : com::sun::star::lang::XEventListener +{ + /** indicates that the job is done + + @param Job + identifies the asynchronous job so that theJobExecutor + can differ between more than ones. + + @param Result + should be the same like for the synchronous mode on XJob::execute(). + It provides information about success or failure of job execution. It's possible too, + to use special protocol (which depends from real implementation) between + theJobExecutor and a real job. So it can be possible to: + + <ul> + <li>deregister the job</li> + <li>let him registered although execution was successful(!)</li> + <li>make some job specific data persistent inside the job configuration which + is provided by the executor.</li> + </ul> + */ + void jobFinished( + [in] XAsyncJob Job, + [in] any Result); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XMasterPasswordHandling.idl b/offapi/com/sun/star/task/XMasterPasswordHandling.idl new file mode 100644 index 000000000..9c79189f4 --- /dev/null +++ b/offapi/com/sun/star/task/XMasterPasswordHandling.idl @@ -0,0 +1,91 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XMasterPasswordHandling_idl__ +#define __com_sun_star_task_XMasterPasswordHandling_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/task/XInteractionHandler.idl> + + + +module com { module sun { module star { module task { + +/** allows to change the master password, or let it be requested and checked. +*/ +published interface XMasterPasswordHandling : com::sun::star::uno::XInterface +{ + /** allows to check the user authorization. + + <p> + This call let the master password be requested from user using the + provided interaction handler. + </p> + + <p> + The call will use the standard interaction handler service + InteractionHandler if no handler is provided. + </p> + + */ + boolean authorizateWithMasterPassword( [in] XInteractionHandler xHandler ); + + /** allows to change the master password. + + <p> + If there is still no master password, the user will be asked to provide + the new one. + </p> + + <p> + The call will use the standard interaction handler service + InteractionHandler if no handler is provided. + </p> + */ + boolean changeMasterPassword( [in] XInteractionHandler xHandler ); + + /** let the master password and all the related stored passwords be + removed. + */ + void removeMasterPassword(); + + /** allows to detect whether there is already a master password + */ + boolean hasMasterPassword(); + + /** allows to specify whether persistent storing of passwords is allowed + + <p> + After the storing is forbidden the master password and all the stored + passwords are removed. + </p> + */ + boolean allowPersistentStoring( [in] boolean bAllow ); + + /** allows to detect whether persistent storing of passwords is allowed + */ + boolean isPersistentStoringAllowed(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XMasterPasswordHandling2.idl b/offapi/com/sun/star/task/XMasterPasswordHandling2.idl new file mode 100644 index 000000000..edb962eaa --- /dev/null +++ b/offapi/com/sun/star/task/XMasterPasswordHandling2.idl @@ -0,0 +1,53 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XMasterPasswordHandling2_idl__ +#define __com_sun_star_task_XMasterPasswordHandling2_idl__ + +#include <com/sun/star/task/XInteractionHandler.idl> +#include <com/sun/star/task/XMasterPasswordHandling.idl> + + +module com { module sun { module star { module task { + +/** allows to change the master password, or let it be requested and checked. +*/ +published interface XMasterPasswordHandling2 : XMasterPasswordHandling +{ + /** allows to let the default password be used + + <p> + Please use this method with care. Using of default master password let + the passwords be stored non-encrypted. If a master password is predefined + in the algorithm it is no more an encryption, it is just an encoding. + </p> + */ + boolean useDefaultMasterPassword( [in] XInteractionHandler xHandler ); + + /** allows to detect whether the default master password is used + */ + boolean isDefaultMasterPasswordUsed(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XPasswordContainer.idl b/offapi/com/sun/star/task/XPasswordContainer.idl new file mode 100644 index 000000000..a105deabd --- /dev/null +++ b/offapi/com/sun/star/task/XPasswordContainer.idl @@ -0,0 +1,122 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XPasswordContainer_idl__ +#define __com_sun_star_task_XPasswordContainer_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/task/UrlRecord.idl> +#include <com/sun/star/task/XInteractionHandler.idl> + + + +module com { module sun { module star { module task { + +/** Allows to save passwords with URL-pattern, to use them later. +*/ +published interface XPasswordContainer : com::sun::star::uno::XInterface +{ + /** Save passwords into the container. + + @param Url URL-pattern, that will be used later to retrieve + passwords. + + @param UserName The username. + + @param Passwords The password-list. + + @param Handler The handler to get super password to en/decrypt passwords + + + */ + void add( [in] string Url, [in] string UserName, [in] sequence<string> Passwords, [in] XInteractionHandler Handler ); + + /** Save passwords into the container, and store them in the file. + + @param Url URL-pattern, that will be used later to retrieve + passwords. + + @param UserName The username. + + @param Passwords The password-list. + + @param Handler The handler to get super password to en/decrypt passwords + + + */ + void addPersistent( [in] string Url, [in] string UserName, [in] sequence<string> Passwords, [in] XInteractionHandler Handler ); + + /** Find users with passwords for the url pattern. + + @param Url URL-pattern to retrieve password for. + + @param Handler The handler to get super password to en/decrypt passwords + + @returns Best matched url-pattern with user-records list. + */ + UrlRecord find( [in] string Url, [in] XInteractionHandler Handler ); + + /** Find passwords for the url pattern and username. + + @param Url URL-pattern to retrieve passwords for. + + @param UserName Username to retrieve passwords for. + + @param Handler The handler to get super password to en/decrypt passwords + + @returns Best matched url-pattern for the username. + */ + UrlRecord findForName( [in] string Url, [in] string UserName , [in] XInteractionHandler Handler ); + + /** Remove passwords for the url pattern and username. + + @param Url URL-pattern to remove passwords for. + + @param UserName Username to remove passwords for. + + */ + void remove( [in] string Url, [in] string UserName ); + + + /** Remove passwords for the url pattern and username from the file. + + @param Url URL-pattern to remove passwords for. + + @param UserName Username to remove passwords for. + + */ + void removePersistent( [in] string Url, [in] string UserName ); + + /** Clean the file. + */ + void removeAllPersistent(); + + /** Get all records from the file. + + @returns List of url-records. + */ + sequence<UrlRecord> getAllPersistent( [in] XInteractionHandler Handler ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XPasswordContainer2.idl b/offapi/com/sun/star/task/XPasswordContainer2.idl new file mode 100644 index 000000000..a3702924c --- /dev/null +++ b/offapi/com/sun/star/task/XPasswordContainer2.idl @@ -0,0 +1,59 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XPasswordContainer2_idl__ +#define __com_sun_star_task_XPasswordContainer2_idl__ + +#include <com/sun/star/task/XMasterPasswordHandling2.idl> +#include <com/sun/star/task/XPasswordContainer.idl> +#include <com/sun/star/task/XUrlContainer.idl> + +module com { module sun { module star { module task { + +/** + Provides a unified interface for the PasswordContainer service to implement. + + @since LibreOffice 4.0 +*/ +published interface XPasswordContainer2 +{ + /** handles passwords + + <p> + Use this interface to store or retrieve passwords. + </p> + */ + interface com::sun::star::task::XPasswordContainer; + + /** handles passwords + + <p> + Use this interface to store or retrieve passwords. + </p> + */ + interface com::sun::star::task::XMasterPasswordHandling2; + + interface com::sun::star::task::XUrlContainer; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XRestartManager.idl b/offapi/com/sun/star/task/XRestartManager.idl new file mode 100644 index 000000000..662909529 --- /dev/null +++ b/offapi/com/sun/star/task/XRestartManager.idl @@ -0,0 +1,80 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_task_XRestartManager_idl__ +#define __com_sun_star_task_XRestartManager_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/task/XInteractionHandler.idl> +#include <com/sun/star/uno/Exception.idl> + + +module com { module sun { module star { module task { + +/** allows to try to restart the office. + + @since OOo 3.3 +*/ +published interface XRestartManager : com::sun::star::uno::XInterface +{ + /** let the office restart asynchronously + @param xInteractionHandler + the com::sun::star::task::InteractionHandler + service implementation, that is used in case a problem is detected + during requesting the restart. + + @throws com::sun::star::uno::Exception + to notify the caller about possible failures + */ + void requestRestart( + [in] com::sun::star::task::XInteractionHandler xInteractionHandler ) + raises( com::sun::star::uno::Exception ); + + /** allows to get info whether the restart has been requested and provide + the initialization status. + + <p> + The office has to call this method just before the main loop has been + started, with the `TRUE` as argument, so that the implementation + knows that the office is initialized. If the method returns `TRUE`, + the office should restart without starting the main loop. + </p> + + @param bInitialized + specifies whether the office process is initialized already, + if the caller does not have this information, he should provide + `FALSE`. + + @returns + `TRUE` if the office restart has been requested, + `FALSE` otherwise + + @throws com::sun::star::uno::Exception + to notify the caller about possible failures + */ + boolean isRestartRequested( + [in] boolean bInitialized ) + raises( com::sun::star::uno::Exception ); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XStatusIndicator.idl b/offapi/com/sun/star/task/XStatusIndicator.idl new file mode 100644 index 000000000..2ab623476 --- /dev/null +++ b/offapi/com/sun/star/task/XStatusIndicator.idl @@ -0,0 +1,115 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XStatusIndicator_idl__ +#define __com_sun_star_task_XStatusIndicator_idl__ + +#include <com/sun/star/uno/XInterface.idl> + + + module com { module sun { module star { module task { + +/** controls a status indicator which displays progress of + longer actions to the user + + <p> + Such objects are provided by a XStatusIndicatorFactory. + </p> + + @see XStatusIndicatorFactory + */ +published interface XStatusIndicator: com::sun::star::uno::XInterface +{ + /** initialize and start the progress + + <p> + It activates a new created or reactivate an already used indicator + (must be finished by calling XStatusIndicator::end() + before!). By the way it's possible to set first progress description + and the possible range of progress value. That means that a progress + can runs from 0 to <var>Range</var>. + </p> + + @param Text + initial value for progress description for showing + Value can be updated by calling XStatusIndicator::setText(). + + @param Range + means the maximum value of the progress which can be set by + calling XStatusIndicator::setValue(). + */ + void start( + [in] string Text, + [in] long Range); + + /** stop the progress + + <p> + Further calls of XStatusIndicator::setText(), + XStatusIndicator::setValue() or + XStatusIndicator::reset() must be ignored. + Only XStatusIndicator::start() can reactivate this + indicator. + It's not allowed to destruct the indicator inside this method. + The instance must be gone by using ref count or disposing. + </p> + */ + void end(); + + /** update progress description + + <p> + Initial value can be set during starting of the progress by calling + XStatusIndicator::start(). + Stopped indicators must ignore this call. + </p> + + @param Text + new value for progress description which should be shown now + */ + void setText( [in] string Text ); + + /** update progress value + + <p> + Wrong values must be ignored and stopped indicators must ignore this + call generally. + </p> + + @param Value + new value for progress which should be shown now + Must fit the range [0..Range] which was set during + XStatusIndicator::start(). + */ + void setValue( [in] long Value ); + + /** clear progress value and description + + <p> + Calling of setValue(0) and setText("") should do the same. + Stopped indicators must ignore this call. + </p> + */ + void reset(); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XStatusIndicatorFactory.idl b/offapi/com/sun/star/task/XStatusIndicatorFactory.idl new file mode 100644 index 000000000..93222c41a --- /dev/null +++ b/offapi/com/sun/star/task/XStatusIndicatorFactory.idl @@ -0,0 +1,51 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XStatusIndicatorFactory_idl__ +#define __com_sun_star_task_XStatusIndicatorFactory_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/task/XStatusIndicator.idl> + + + module com { module sun { module star { module task { + +/** provides multiple, probably parallel running, status indicator objects + + <p> + A possible factory is the com::sun::star::frame::Frame + service. + </p> + + @see com::sun::star::frame::Frame + */ +published interface XStatusIndicatorFactory: com::sun::star::uno::XInterface +{ + /** create a new status indicator instance + + @returns + the new indicator + */ + com::sun::star::task::XStatusIndicator createStatusIndicator(); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl new file mode 100644 index 000000000..6162744f0 --- /dev/null +++ b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl @@ -0,0 +1,47 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XStatusIndicatorSupplier_idl__ +#define __com_sun_star_task_XStatusIndicatorSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/task/XStatusIndicator.idl> + + + + module com { module sun { module star { module task { + +/** use XStatusIndicatorFactory instead of this + + @deprecated + */ +published interface XStatusIndicatorSupplier: com::sun::star::uno::XInterface +{ + /** use XStatusIndicatorFactory::createStatusIndicator() + instead of this + + @deprecated + */ + com::sun::star::task::XStatusIndicator getStatusIndicator(); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/XUrlContainer.idl b/offapi/com/sun/star/task/XUrlContainer.idl new file mode 100644 index 000000000..0f9de8f33 --- /dev/null +++ b/offapi/com/sun/star/task/XUrlContainer.idl @@ -0,0 +1,73 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_task_XUrlContainer_idl__ +#define __com_sun_star_task_XUrlContainer_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/task/XInteractionHandler.idl> + + + +module com { module sun { module star { module task { + +/** Allows to store and retrieve URLs. URLs can be stored persistently or + until end of OOo session. + + @since OOo 3.2 +*/ +published interface XUrlContainer : com::sun::star::uno::XInterface +{ + /** Add a URL to the container. + + @param Url URL to add to the container + @param MakePersistent indicates whether the URL shall be stored + persistently or just in memory (until end of + OOo session) + */ + void addUrl( [in] string Url, [in] boolean MakePersistent ); + + /** Lookup a URL in the container. + + @param Url URL to lookup. + @returns Best matched URL or empty string. + */ + string findUrl( [in] string Url ); + + /** Remove a URL from the container. + + @param Url URL to remove. + */ + void removeUrl( [in] string Url ); + + /** Get all URLs. + + @param OnlyPersistent Only URLs that are stored persistently shall + be returned. + @returns List of URLs. + */ + sequence<string> getUrls( [in] boolean OnlyPersistent ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/task/theJobExecutor.idl b/offapi/com/sun/star/task/theJobExecutor.idl new file mode 100644 index 000000000..6189938ae --- /dev/null +++ b/offapi/com/sun/star/task/theJobExecutor.idl @@ -0,0 +1,43 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +#ifndef __com_sun_star_task_theJobExecutor_idl__ +#define __com_sun_star_task_theJobExecutor_idl__ + +#include <com/sun/star/task/XJobExecutor.idl> + + +module com { module sun { module star { module task { + +/** + Generic job execution singleton + + <p> + Can start registered uno services on triggered events and handle there + own configuration and there lifetime. Such events are simple strings + which meaning doesn't matter for any real service implementation of this + specification. But triggered events must be available inside the + configuration and some Jobs or AsyncJobs must be registered for that. + </p> + + Prior to LibreOffice 4.3, this singleton was only available as a + (single-instance) JobExecutor service. + + @see Job + @see AsyncJob + + @since LibreOffice 4.3 + */ +published singleton theJobExecutor : XJobExecutor; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |