diff options
Diffstat (limited to 'offapi/com/sun/star/task')
46 files changed, 3402 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 000000000000..eed753549b75 --- /dev/null +++ b/offapi/com/sun/star/task/AsyncJob.idl @@ -0,0 +1,66 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_task_AsyncJob_idl__ +#define __com_sun_star_task_AsyncJob_idl__ + +#ifndef __com_sun_star_task_XAsyncJob_idl__ +#include <com/sun/star/task/XAsyncJob.idl> +#endif + +#ifndef __com_sun_star_util_XCloseable_idl__ +#include <com/sun/star/util/XCloseable.idl> +#endif + +//============================================================================ + +module com { module sun { module star { module task { + +//============================================================================ +/** represent an asynchronous job, which can be executed by the global <type>JobExecutor</type> + 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 diff --git a/offapi/com/sun/star/task/ClassifiedInteractionRequest.idl b/offapi/com/sun/star/task/ClassifiedInteractionRequest.idl new file mode 100644 index 000000000000..fdd98037d6b3 --- /dev/null +++ b/offapi/com/sun/star/task/ClassifiedInteractionRequest.idl @@ -0,0 +1,63 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__ +#define __com_sun_star_task_ClassifiedInteractionRequest_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +#ifndef __com_sun_star_task_InteractionClassification_idl__ +#include <com/sun/star/task/InteractionClassification.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module task { + +//============================================================================= + +// DocMerge from xml: exception com::sun::star::task::ClassifiedInteractionRequest +/** A classified interaction request. + */ +published exception ClassifiedInteractionRequest: com::sun::star::uno::Exception +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::task::ClassifiedInteractionRequest::Classification + /** The classification of the request. + */ + com::sun::star::task::InteractionClassification Classification; + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl b/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl new file mode 100644 index 000000000000..1d453e41aa29 --- /dev/null +++ b/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl @@ -0,0 +1,64 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright IBM Corporation 2009. + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_DocumentMSPasswordRequest_idl__ +#define __com_sun_star_task_DocumentMSPasswordRequest_idl__ + +#ifndef __com_sun_star_task_PasswordRequest_idl__ +#include <com/sun/star/task/PasswordRequest.idl> +#endif + + +//============================================================================= + +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 <type>InteractionHandler</type> 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 + */ + string Name; + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl b/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl new file mode 100755 index 000000000000..94ce75683dea --- /dev/null +++ b/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl @@ -0,0 +1,68 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright IBM Corporation 2009. + * Copyright 2009 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: DocumentMSPasswordRequest.idl,v $ + * $Revision: 1.0 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#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 <type>InteractionHandler</type> 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 mofiying it. + */ + boolean IsRequestPasswordToModify; + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/DocumentMacroConfirmationRequest.idl b/offapi/com/sun/star/task/DocumentMacroConfirmationRequest.idl new file mode 100644 index 000000000000..a115e914afb8 --- /dev/null +++ b/offapi/com/sun/star/task/DocumentMacroConfirmationRequest.idl @@ -0,0 +1,79 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#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 commited 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 informations about the ODF version of the document + */ + string DocumentVersion; + + /** contains informations about the signatures in the document + */ + sequence< ::com::sun::star::security::DocumentSignatureInformation > + DocumentSignatureInformation; +}; + +//============================================================================= + +}; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/task/DocumentPasswordRequest.idl b/offapi/com/sun/star/task/DocumentPasswordRequest.idl new file mode 100644 index 000000000000..5520dc14f0ba --- /dev/null +++ b/offapi/com/sun/star/task/DocumentPasswordRequest.idl @@ -0,0 +1,63 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_DocumentPasswordRequest_idl__ +#define __com_sun_star_task_DocumentPasswordRequest_idl__ + +#ifndef __com_sun_star_task_PasswordRequest_idl__ +#include <com/sun/star/task/PasswordRequest.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module task { + +//============================================================================= +/** this request specifies the mode in wich the password should be asked + + <P> + It is supported by <type>InteractionHandler</type> 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 + */ + string Name; + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/DocumentPasswordRequest2.idl b/offapi/com/sun/star/task/DocumentPasswordRequest2.idl new file mode 100755 index 000000000000..0f49e29255f0 --- /dev/null +++ b/offapi/com/sun/star/task/DocumentPasswordRequest2.idl @@ -0,0 +1,67 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: DocumentPasswordRequest.idl,v $ + * $Revision: 1.8 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#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 <type>InteractionHandler</type> 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 mofiying it. + */ + boolean IsRequestPasswordToModify; + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/ErrorCodeIOException.idl b/offapi/com/sun/star/task/ErrorCodeIOException.idl new file mode 100644 index 000000000000..93b8aaa67d1a --- /dev/null +++ b/offapi/com/sun/star/task/ErrorCodeIOException.idl @@ -0,0 +1,56 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_ErrorCodeIOException_idl__ +#define __com_sun_star_task_ErrorCodeIOException_idl__ + +#ifndef __com_sun_star_io_IOException_idl__ +#include <com/sun/star/io/IOException.idl> +#endif + +//============================================================================ + + module com { module sun { module star { module task { + +//============================================================================ + +/** IOException that can carry error codes ( not only io related ). + It can be used to transport the error code information. + */ +exception ErrorCodeIOException : com::sun::star::io::IOException +{ + //------------------------------------------------------------------------ + /** specifies the error code. + */ + + long ErrCode; +}; + +//============================================================================ + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/ErrorCodeRequest.idl b/offapi/com/sun/star/task/ErrorCodeRequest.idl new file mode 100644 index 000000000000..fb594a8b5944 --- /dev/null +++ b/offapi/com/sun/star/task/ErrorCodeRequest.idl @@ -0,0 +1,56 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_ErrorCodeRequest_idl__ +#define __com_sun_star_task_ErrorCodeRequest_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//============================================================================= + + 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 usefull for interactions. + + @since OOo 1.1.2 + */ +published exception ErrorCodeRequest : com::sun::star::uno::Exception +{ + /** specifies the error code. */ + long ErrCode; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/FutureDocumentVersionProductUpdateRequest.idl b/offapi/com/sun/star/task/FutureDocumentVersionProductUpdateRequest.idl new file mode 100644 index 000000000000..0bef641d3ff1 --- /dev/null +++ b/offapi/com/sun/star/task/FutureDocumentVersionProductUpdateRequest.idl @@ -0,0 +1,65 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * +************************************************************************/ + +#include <com/sun/star/task/ClassifiedInteractionRequest.idl> + +#ifndef __com_sun_star_task_FutureDocumentVersionProductUpdateRequest_idl__ +#define __com_sun_star_task_FutureDocumentVersionProductUpdateRequest_idl__ + +//============================================================================= + +module com { module sun { module star { module task { + +//============================================================================= + +/** describes a request to the user to update OpenOffice.org to a newer version, since + an ODF document was encountered which conforms to an ODF version unknown to the + current OpenOffice.org version. + + <p>An interaction request of this type usually comes with an <type>XInteractionApprove</type>, + and <type>XInteractionDisapprove</type>, and <type>XInteractionAskLater</type> continuation.</p> + */ +exception FutureDocumentVersionProductUpdateRequest : ClassifiedInteractionRequest +{ + /// specifies the URL of the document which conforms to a future ODF version + string DocumentURL; + + /** the ODF version which the document conforms to + + <p>If the request was not issued because of a too-new ODF version of the document, but because + the application detected by other means that the document was too-new, then <code>DocumentODFVersion</code> + is allowed to be empty</p> + */ + string DocumentODFVersion; +}; + +//============================================================================= + +}; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/task/InteractionClassification.idl b/offapi/com/sun/star/task/InteractionClassification.idl new file mode 100644 index 000000000000..a5449bdd09e3 --- /dev/null +++ b/offapi/com/sun/star/task/InteractionClassification.idl @@ -0,0 +1,86 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_InteractionClassification_idl__ +#define __com_sun_star_task_InteractionClassification_idl__ + + +//============================================================================= + + module com { module sun { module star { module task { + +//============================================================================= + +// DocMerge from xml: enum com::sun::star::task::InteractionClassification +/** A classification of interaction requests. + + @see com::sun::star::task::ClassifiedInteractionRequest + This is the base of classified interaction requests. + */ +published enum InteractionClassification +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::task::InteractionClassification::ERROR + /** An error. + */ + ERROR, + + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::task::InteractionClassification::WARNING + /** A warning, less severe than an error. + */ + WARNING, + + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::task::InteractionClassification::INFO + /** Some information for the client/user (which will typically lead to the + selection of an + <type scope="com::sun::star::task">XInteractionApprove</type> + continuation). + */ + INFO, + + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::task::InteractionClassification::QUERY + /** A query for the client/user (which will typically lead to the + selection of an + <type scope="com::sun::star::task">XInteractionApprove</type> or + <type scope="com::sun::star::task">XInteractionDisapprove</type> + continuation). + */ + QUERY + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/InteractionHandler.idl b/offapi/com/sun/star/task/InteractionHandler.idl new file mode 100644 index 000000000000..f772754d6d56 --- /dev/null +++ b/offapi/com/sun/star/task/InteractionHandler.idl @@ -0,0 +1,187 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_task_InteractionHandler_idl__ +#define __com_sun_star_task_InteractionHandler_idl__ + +module com { module sun { module star { + module lang { published interface XInitialization; }; + module task { published interface XInteractionHandler; }; +}; }; }; + +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 numerof 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><type scope="com::sun::star::ucb">AuthenticationRequest</type></LI> + <LI><type scope="com::sun::star::ucb">CertificateValidationRequest</type></LI> + <LI><type scope="com::sun::star::sync2">BadPartnershipException</type>*</LI> + <LI><type scope="com::sun::star::ucb">HandleCookiesRequest</type></LI> + <LI><type scope="com::sun::star::ucb">InteractiveAugmentedIOException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveCHAOSException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveFileIOException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveIOException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkConnectException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkGeneralException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkOffLineException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkReadException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkResolveNameException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkWriteException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveWrongMediumException</type>*</LI> + <LI><type scope="com::sun::star::task">PasswordRequest</type></LI> + <LI><type scope="com::sun::star::java">WrongJavaVersionException</type>*</LI> + <LI><type scope="com::sun::star::task">DocumentMacroConfirmationRequest</type></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 + <type scope="com::sun::star::task">XInteractionApprove</type>, + <type scope="com::sun::star::task">XInteractionDisapprove</type>, + <type scope="com::sun::star::task">XInteractionRetry</type>, or + <type scope="com::sun::star::task">XInteractionAbort</type> (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 + <type scope="com::sun::star::ucb">InteractiveAugmentedIOException</type> + carries with it a sequence of arguments, which should be + <type scope="com::sun::star::beans">PropertyValue</type>s. The following + details which properties are interpreted by the interaction handler, + depending on the request's + <type scope="com::sun::star::ucb">IOErrorCode</type>: + <DL> + <DT><code>"Uri"</code></DT> + <DD>All error codes except + <const scope="com::sun::star::ucb">IOErrorCode::DIFFERENT_DEVICES</const>. + The URI of the involved resource (a <atom>string</atom>).</DD> + + <DT><code>"ResourceName"</code></DT> + <DD>All error codes except + <const scope="com::sun::star::ucb">IOErrorCode::DIFFERENT_DEVICES</const>. + A name for the involved resource (a <atom>string</atom>) 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><const scope="com::sun::star::ucb">IOErrorCode::DEVICE_NOT_READY</const> + and + <const scope="com::sun::star::ucb">IOErrorCode::NOT_EXISTING</const> + only. An identifier for the type of resource involved (a + <atom>string</atom>). 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><const scope="com::sun::star::ucb">IOErrorCode::NOT_EXISTING</const> + only. A flag indicating whether the resource resides on a storage + medium that can be removed by the user (a <atom>boolean</atom>).</DD> + + <DT><code>"Folder"</code></DT> + <DD><const scope="com::sun::star::ucb">IOErrorCode::CANT_CREATE</const> + only. The name of the foler in which a resource cannot be created (a + <atom>string</atom>).</DD> + + <DT><code>"Volume"</code> and <code>"OtherVolume"</code></DT> + <DD><const scope="com::sun::star::ucb">IOErrorCode::DIFFERENT_DEVICES</const> + only. The names of the two volumes involved (two + <atom>string</atom>s).</DD> + </DL></P> + + <a name="configuring_handlers"></a> + <h3>Configurating 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> encounteres 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 themself responsible for the same request type, it is not + defined which handler will actully 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 +{ + //------------------------------------------------------------------------ + /** Handle an interaction request. + */ + interface com::sun::star::task::XInteractionHandler; + + //------------------------------------------------------------------------ + /** Initialize the interaction handler. + + <P>The arguments must be a sequence of + <type scope="com::sun::star::beans">PropertyValue</type>s. The + currently supported properties are: + <UL> + <LI><code>"Parent"</code> of type + <type scope="com::sun::star::awt">XWindow</type> denotes the + parent window for any GUI dialogs the interaction handler pops up; + it is strongly recommended that this property is supplied;</LI> + <LI><code>"Context"</code> of type <atom>string</atom> is a + textual description of the current context (used, e.g., as a first + line of text in error boxes); this property is optional.</LI> + </UL></P> + */ + interface com::sun::star::lang::XInitialization; +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/InteractionRequestStringResolver.idl b/offapi/com/sun/star/task/InteractionRequestStringResolver.idl new file mode 100644 index 000000000000..fac2a69de424 --- /dev/null +++ b/offapi/com/sun/star/task/InteractionRequestStringResolver.idl @@ -0,0 +1,46 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#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 <type>XInteractionRequest</type>. + */ +/* published */ +service InteractionRequestStringResolver : XInteractionRequestStringResolver; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/Job.idl b/offapi/com/sun/star/task/Job.idl new file mode 100644 index 000000000000..7d55dea68b56 --- /dev/null +++ b/offapi/com/sun/star/task/Job.idl @@ -0,0 +1,66 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_task_Job_idl__ +#define __com_sun_star_task_Job_idl__ + +#ifndef __com_sun_star_task_XJob_idl__ +#include <com/sun/star/task/XJob.idl> +#endif + +#ifndef __com_sun_star_util_XCloseable_idl__ +#include <com/sun/star/util/XCloseable.idl> +#endif + +//============================================================================ + +module com { module sun { module star { module task { + +//============================================================================ +/** represent a synchronous job, which can be executed by the global <type>JobExecutor</type> + 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 diff --git a/offapi/com/sun/star/task/JobExecutor.idl b/offapi/com/sun/star/task/JobExecutor.idl new file mode 100644 index 000000000000..7f6a9581e0ab --- /dev/null +++ b/offapi/com/sun/star/task/JobExecutor.idl @@ -0,0 +1,63 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_task_JobExecutor_idl__ +#define __com_sun_star_task_JobExecutor_idl__ + +#ifndef __com_sun_star_task_XJobExecutor_idl__ +#include <com/sun/star/task/XJobExecutor.idl> +#endif + +//============================================================================ + +module com { module sun { module star { module task { + +//============================================================================ +/** generic job execution service + + <p> + Can start registered uno services on triggered events and handle there + own configuration and there lifetime. Such events are simple strings + wich meaning doesn't matter for any real service implementation of this + specification. But triggered events must be available inside the + configuration and some <type>Job</type>s or <type>AsyncJob</type>s must be registered for that. + </p> + + @see Job + @see AsyncJob + */ +published service JobExecutor +{ + //------------------------------------------------------------------------ + /** start and regulate execution. + */ + interface com::sun::star::task::XJobExecutor; +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/MasterPasswordRequest.idl b/offapi/com/sun/star/task/MasterPasswordRequest.idl new file mode 100644 index 000000000000..734c4e00c1e4 --- /dev/null +++ b/offapi/com/sun/star/task/MasterPasswordRequest.idl @@ -0,0 +1,58 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_MasterPasswordRequest_idl__ +#define __com_sun_star_task_MasterPasswordRequest_idl__ + +#ifndef __com_sun_star_task_PasswordRequest_idl__ +#include <com/sun/star/task/PasswordRequest.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module task { + +//============================================================================= +/** this request specifies the mode in wich the password should be asked + + <P> + It is supported by <type>InteractionHandler</type> 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 diff --git a/offapi/com/sun/star/task/NoMasterException.idl b/offapi/com/sun/star/task/NoMasterException.idl new file mode 100644 index 000000000000..03440309db9d --- /dev/null +++ b/offapi/com/sun/star/task/NoMasterException.idl @@ -0,0 +1,59 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_MasterPasswordRequest_idl__ +#define __com_sun_star_task_MasterPasswordRequest_idl__ + +#ifndef __com_sun_star_uno_RuntimeException_idl__ +#include <com/sun/star/uno/RuntimeException.idl> +#endif + +#ifndef __com_sun_star_task_PasswordRequestMode_idl__ +#include <com/sun/star/task/PasswordRequestMode.idl> +#endif + + +//============================================================================= + +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 diff --git a/offapi/com/sun/star/task/OfficeRestartManager.idl b/offapi/com/sun/star/task/OfficeRestartManager.idl new file mode 100644 index 000000000000..9205992d169f --- /dev/null +++ b/offapi/com/sun/star/task/OfficeRestartManager.idl @@ -0,0 +1,53 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#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 + diff --git a/offapi/com/sun/star/task/PDFExportException.idl b/offapi/com/sun/star/task/PDFExportException.idl new file mode 100644 index 000000000000..8547aea76418 --- /dev/null +++ b/offapi/com/sun/star/task/PDFExportException.idl @@ -0,0 +1,52 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_PDFExportException_idl__ +#define __com_sun_star_task_PDFExportException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + + 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 occured during PDFExport + */ + sequence< long > ErrorCodes; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/task/PasswordContainer.idl b/offapi/com/sun/star/task/PasswordContainer.idl new file mode 100644 index 000000000000..e0bebf68f77d --- /dev/null +++ b/offapi/com/sun/star/task/PasswordContainer.idl @@ -0,0 +1,82 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_PasswordContainer_idl__ +#define __com_sun_star_task_PasswordContainer_idl__ + +module com { module sun { module star { + module task { + published interface XPasswordContainer; + published interface XMasterPasswordHandling; + }; +}; }; }; + +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 encripted 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 <type>XInteractionHandler</type> + interface should be provided. For this purpose <type>InteractionHandler</type> + 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 ), + <type>NoMasterException</type> exception is thrown to let user use + nonpersistent way explicitly. + </p> +*/ +published service PasswordContainer +{ + //------------------------------------------------------------------------ + /** handles passwords + + <p> + Use this interface to store\retrieve passwords. + </p> + */ + interface com::sun::star::task::XPasswordContainer; + + //------------------------------------------------------------------------ + /** handles passwords + + <p> + Use this interface to store\retrieve passwords. + </p> + */ + [optional] interface com::sun::star::task::XMasterPasswordHandling; +}; + +}; }; }; }; +#endif diff --git a/offapi/com/sun/star/task/PasswordContainerInteractionHandler.idl b/offapi/com/sun/star/task/PasswordContainerInteractionHandler.idl new file mode 100644 index 000000000000..62beab75eb30 --- /dev/null +++ b/offapi/com/sun/star/task/PasswordContainerInteractionHandler.idl @@ -0,0 +1,57 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#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 + <type scope="com::sun::star::task">PasswordContainer</type> service to + handle <type scope="com::sun::star::ucb">AuthenticationRequest</type>s. + + If the password container contains credentials matching the authentication + request, the service implementation selects the + <type scope="com::sun::star::ucb">XInteractionSupplyAuthentication</type> + 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 diff --git a/offapi/com/sun/star/task/PasswordRequest.idl b/offapi/com/sun/star/task/PasswordRequest.idl new file mode 100644 index 000000000000..e9f32c86f72b --- /dev/null +++ b/offapi/com/sun/star/task/PasswordRequest.idl @@ -0,0 +1,67 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_PasswordRequest_idl__ +#define __com_sun_star_task_PasswordRequest_idl__ + +#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__ +#include <com/sun/star/task/ClassifiedInteractionRequest.idl> +#endif + +#ifndef __com_sun_star_task_PasswordRequestMode_idl__ +#include <com/sun/star/task/PasswordRequestMode.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module task { + +//============================================================================= +/** this request specifies the mode in wich the password should be asked + + <P> + It is supported by <type>InteractionHandler</type> 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 diff --git a/offapi/com/sun/star/task/PasswordRequestMode.idl b/offapi/com/sun/star/task/PasswordRequestMode.idl new file mode 100644 index 000000000000..a7f710203f78 --- /dev/null +++ b/offapi/com/sun/star/task/PasswordRequestMode.idl @@ -0,0 +1,79 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#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 diff --git a/offapi/com/sun/star/task/UnsupportedOverwriteRequest.idl b/offapi/com/sun/star/task/UnsupportedOverwriteRequest.idl new file mode 100644 index 000000000000..ac5358fbd002 --- /dev/null +++ b/offapi/com/sun/star/task/UnsupportedOverwriteRequest.idl @@ -0,0 +1,63 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_UnsupportedOverwriteRequest_idl__ +#define __com_sun_star_task_UnsupportedOverwriteRequest_idl__ + +#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__ +#include <com/sun/star/task/ClassifiedInteractionRequest.idl> +#endif + + +//============================================================================= + +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 <type>InteractionHandler</type> 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 + diff --git a/offapi/com/sun/star/task/UrlRecord.idl b/offapi/com/sun/star/task/UrlRecord.idl new file mode 100644 index 000000000000..84a856a87510 --- /dev/null +++ b/offapi/com/sun/star/task/UrlRecord.idl @@ -0,0 +1,54 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_UrlRecord_idl__ +#define __com_sun_star_task_UrlRecord_idl__ + +#ifndef __com_sun_star_task_UserRecord_idl__ +#include <com/sun/star/task/UserRecord.idl> +#endif + +//============================================================================= + +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 diff --git a/offapi/com/sun/star/task/UserRecord.idl b/offapi/com/sun/star/task/UserRecord.idl new file mode 100644 index 000000000000..da9ba759bcbf --- /dev/null +++ b/offapi/com/sun/star/task/UserRecord.idl @@ -0,0 +1,50 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#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 <type>UrlRecord</type>. +*/ +published struct UserRecord +{ + /// specifies the user name. + string UserName; + + /// specifies the passwords for the given user. + sequence<string> Passwords; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/XAbortChannel.idl b/offapi/com/sun/star/task/XAbortChannel.idl new file mode 100644 index 000000000000..54f647bd7331 --- /dev/null +++ b/offapi/com/sun/star/task/XAbortChannel.idl @@ -0,0 +1,49 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#if ! defined INCLUDED_com_sun_star_task_XAbortChannel_idl +#define INCLUDED_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 <type scope="com::sun::star::deployment"> + XPackageManager</type>. +*/ +interface XAbortChannel +{ + /** sends an abort notification to all commands + associated with this channel. + */ + void sendAbort(); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/XAsyncJob.idl b/offapi/com/sun/star/task/XAsyncJob.idl new file mode 100644 index 000000000000..96dfe0365d9f --- /dev/null +++ b/offapi/com/sun/star/task/XAsyncJob.idl @@ -0,0 +1,92 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_task_XAsyncJob_idl__ +#define __com_sun_star_task_XAsyncJob_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_beans_NamedValue_idl__ +#include <com/sun/star/beans/NamedValue.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module task { + + published interface XJobListener; + +//============================================================================= +/** specifies a job which must be executed asynchronously + + <p> + Instead of <type>XJob</type> the implementation of this interface + must be aware, that execution can be made real asynchronous (e.g. by using + threads). Because the environment whish 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 the <type>JobExecutor</type> + which use this asynchronous job. It's possible to write it back by called listener + function <member>XJobListener::jobFinished()</member>. + + @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 + diff --git a/offapi/com/sun/star/task/XInteractionApprove.idl b/offapi/com/sun/star/task/XInteractionApprove.idl new file mode 100644 index 000000000000..be39a0b21b2f --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionApprove.idl @@ -0,0 +1,52 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XInteractionApprove_idl__ +#define __com_sun_star_task_XInteractionApprove_idl__ + +#ifndef __com_sun_star_task_XInteractionContinuation_idl__ +#include <com/sun/star/task/XInteractionContinuation.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module task { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::task::XInteractionApprove +/** An intearaction continuation specifing 'approval'. + */ +published interface XInteractionApprove: com::sun::star::task::XInteractionContinuation +{ +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/XInteractionAskLater.idl b/offapi/com/sun/star/task/XInteractionAskLater.idl new file mode 100644 index 000000000000..04db83387f37 --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionAskLater.idl @@ -0,0 +1,51 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * +************************************************************************/ + +#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 diff --git a/offapi/com/sun/star/task/XInteractionDisapprove.idl b/offapi/com/sun/star/task/XInteractionDisapprove.idl new file mode 100644 index 000000000000..f4a21cc1c2b0 --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionDisapprove.idl @@ -0,0 +1,52 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XInteractionDisapprove_idl__ +#define __com_sun_star_task_XInteractionDisapprove_idl__ + +#ifndef __com_sun_star_task_XInteractionContinuation_idl__ +#include <com/sun/star/task/XInteractionContinuation.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module task { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::task::XInteractionDisapprove +/** An interaction continuation specifing 'disapproval'. + */ +published interface XInteractionDisapprove: com::sun::star::task::XInteractionContinuation +{ +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/XInteractionPassword.idl b/offapi/com/sun/star/task/XInteractionPassword.idl new file mode 100644 index 000000000000..95309ccf5623 --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionPassword.idl @@ -0,0 +1,66 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XInteractionPassword_idl__ +#define __com_sun_star_task_XInteractionPassword_idl__ + +#ifndef __com_sun_star_task_XInteractionContinuation_idl__ +#include <com/sun/star/task/XInteractionContinuation.idl> +#endif + +//============================================================================= + +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 + diff --git a/offapi/com/sun/star/task/XInteractionPassword2.idl b/offapi/com/sun/star/task/XInteractionPassword2.idl new file mode 100644 index 000000000000..925f96f30e5a --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionPassword2.idl @@ -0,0 +1,80 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XInteractionPassword.idl,v $ + * $Revision: 1.8 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XInteractionPassword2_idl__ +#define __com_sun_star_task_XInteractionPassword2_idl__ + +#ifndef __com_sun_star_task_XInteractionPassword_idl__ +#include <com/sun/star/task/XInteractionPassword.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module task { + +//============================================================================= +/** A continuation to get a password from interaction helper, extends + <type>XInteractionPassword</type> 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 + diff --git a/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl b/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl new file mode 100644 index 000000000000..f41bbcbddb93 --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl @@ -0,0 +1,82 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XInteractionRequestStringResolver_idl__ +#define __com_sun_star_task_XInteractionRequestStringResolver_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_beans_Optional_idl__ +#include <com/sun/star/beans/Optional.idl> +#endif + +#ifndef __com_sun_star_task_XInteractionRequest_idl__ +#include <com/sun/star/task/XInteractionRequest.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module task { + +//============================================================================= + +/** Obtains human readable strings from an <type>XInteractionRequest</type>. + */ +/* 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 + <type>XInteractionAbort</type> or <type>XInteractionApprove</type> + + @param Request the interaction request for that the message shall + be obtained. + + @returns the message string or an empty + <type scope="::com::sun::star::beans">Optional</type>. + */ + com::sun::star::beans::Optional< string > + getStringFromInformationalRequest( + [in] com::sun::star::task::XInteractionRequest Request ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/task/XJob.idl b/offapi/com/sun/star/task/XJob.idl new file mode 100644 index 000000000000..759d7ca223c1 --- /dev/null +++ b/offapi/com/sun/star/task/XJob.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_task_XJob_idl__ +#define __com_sun_star_task_XJob_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_beans_NamedValue_idl__ +#include <com/sun/star/beans/NamedValue.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//============================================================================ + +module com { module sun { module star { module task { + +//============================================================================= +/** specifies a job which is to be executed synchronously + + <p> + Instead of <type>XAsyncJob</type> the implementation of this interface + will be executed synchronously everytimes. That means: they can be shure 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 the <type>JobExecutor</type> + 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 successfully(!)</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 excutor about faild operation; otherwise the return value + indicates a successfull finishing. + */ + any execute( + [in] sequence< com::sun::star::beans::NamedValue > Arguments ) + raises( com::sun::star::lang::IllegalArgumentException , + com::sun::star::uno::Exception ); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/XJobExecutor.idl b/offapi/com/sun/star/task/XJobExecutor.idl new file mode 100644 index 000000000000..d4ef207235e7 --- /dev/null +++ b/offapi/com/sun/star/task/XJobExecutor.idl @@ -0,0 +1,74 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_task_XJobExecutor_idl__ +#define __com_sun_star_task_XJobExecutor_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +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 JobExecutor + */ +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 + automaticly, 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 + */ + [oneway] void trigger( [in] string Event ); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/XJobListener.idl b/offapi/com/sun/star/task/XJobListener.idl new file mode 100644 index 000000000000..d4f27b69bd8f --- /dev/null +++ b/offapi/com/sun/star/task/XJobListener.idl @@ -0,0 +1,73 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_task_XJobListener_idl__ +#define __com_sun_star_task_XJobListener_idl__ + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif + +//============================================================================= + +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 the <type>JobExecutor</type> + can differ between more then ones. + + @param Result + should be the same like for the synchronous mode on <member>XJob::execute()</member>. + It provides information about success or failure of job execution. It's possible too, + to use special protocol (which depends from real implementation) between + <type>JobExecutor</type> and a real job. So it can be possible to: + + <ul> + <li>deregister the job</li> + <li>let him registered although execution was successfully(!)</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 diff --git a/offapi/com/sun/star/task/XMasterPasswordHandling.idl b/offapi/com/sun/star/task/XMasterPasswordHandling.idl new file mode 100644 index 000000000000..bd0637210052 --- /dev/null +++ b/offapi/com/sun/star/task/XMasterPasswordHandling.idl @@ -0,0 +1,112 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XMasterPasswordHandling_idl__ +#define __com_sun_star_task_XMasterPasswordHandling_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_task_XInteractionHandler_idl__ +#include <com/sun/star/task/XInteractionHandler.idl> +#endif + + +//============================================================================= + +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 interactin handler service + <type>InteractionHandler</type> 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 + <type>InteractionHandler</type> 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 + diff --git a/offapi/com/sun/star/task/XMasterPasswordHandling2.idl b/offapi/com/sun/star/task/XMasterPasswordHandling2.idl new file mode 100644 index 000000000000..201ed9081cdb --- /dev/null +++ b/offapi/com/sun/star/task/XMasterPasswordHandling2.idl @@ -0,0 +1,70 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XMasterPasswordHandling2_idl__ +#define __com_sun_star_task_XMasterPasswordHandling2_idl__ + +#ifndef __com_sun_star_task_XInteractionHandler_idl__ +#include <com/sun/star/task/XInteractionHandler.idl> +#endif + +#ifndef __com_sun_star_task_XMasterPasswordHandling_idl__ +#include <com/sun/star/task/XMasterPasswordHandling.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module task { + +//============================================================================= +/** allows to change the master password, or let it be requested and checked. +*/ +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 nonencrypted. If a masterpassword 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 + diff --git a/offapi/com/sun/star/task/XPasswordContainer.idl b/offapi/com/sun/star/task/XPasswordContainer.idl new file mode 100644 index 000000000000..20aaf752a8e5 --- /dev/null +++ b/offapi/com/sun/star/task/XPasswordContainer.idl @@ -0,0 +1,147 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XPasswordContainer_idl__ +#define __com_sun_star_task_XPasswordContainer_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_task_UrlRecord_idl__ +#include <com/sun/star/task/UrlRecord.idl> +#endif + +#ifndef __com_sun_star_task_XInteractionHandler_idl__ +#include <com/sun/star/task/XInteractionHandler.idl> +#endif + + +//============================================================================= + +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 in to the container. + + @param Url URL-pattern, that will be used later to retrieve + passwords. + + @param UseName The username. + + @param Passwords The password-list. + + @param Handler The handler to get superpassword to en/decript passwords + + + */ + void add( [in] string Url, [in] string UserName, [in] sequence<string> Passwords, [in] XInteractionHandler Handler ); + + //------------------------------------------------------------------------- + /** Save passwords in to the container, and store them in the file. + + @param Url URL-pattern, that will be used later to retrieve + passwords. + + @param UseName The username. + + @param Passwords The password-list. + + @param Handler The handler to get superpassword to en/decript 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 superpassword to en/decript 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 superpassword to en/decript 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 diff --git a/offapi/com/sun/star/task/XRestartManager.idl b/offapi/com/sun/star/task/XRestartManager.idl new file mode 100644 index 000000000000..102a1044d2e8 --- /dev/null +++ b/offapi/com/sun/star/task/XRestartManager.idl @@ -0,0 +1,99 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_task_XRestartManager_idl__ +#define __com_sun_star_task_XRestartManager_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_task_XInteractionHandler_idl__ +#include <com/sun/star/task/XInteractionHandler.idl> +#endif + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//============================================================================ + +module com { module sun { module star { module task { + +//============================================================================= +/** allows to try to restart the office. + + @since OOo3.3 +*/ +published interface XRestartManager : com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------ + /** let the office restart asynchronously + @param xInteractionHandler + the <type scope="com::sun::star::task">InteractionHandler</type> + 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 + diff --git a/offapi/com/sun/star/task/XStatusIndicator.idl b/offapi/com/sun/star/task/XStatusIndicator.idl new file mode 100644 index 000000000000..d3a222d51a36 --- /dev/null +++ b/offapi/com/sun/star/task/XStatusIndicator.idl @@ -0,0 +1,130 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XStatusIndicator_idl__ +#define __com_sun_star_task_XStatusIndicator_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + + 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 <type>XStatusIndicatorFactory</type>. + </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 inidicator + (must be finished by calling <member>XStatusIndicator::end()</member> + 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 <member>XStatusIndicator::setText()</member>. + + @param Range + mewns the maximum value of the progress which can be setted by + calling <member>XStatusIndicator::setValue()</member>. + */ + [oneway] void start( + [in] string Text, + [in] long Range); + + //------------------------------------------------------------------------- + /** stop the progress + + <p> + Further calls of <member>XStatusIndicator::setText()</member>, + <member>XStatusIndicator::setValue()</member> or + <member>XStatusIndicator::reset()</member> must be ignored. + Only <member>XStatusIndicator::start()</member> 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> + */ + [oneway] void end(); + + //------------------------------------------------------------------------- + /** update progress description + + <p> + Initial value can be set during starting of the progress by calling + <member>XStatusIndicator::start()</member>. + Stopped indicators must ignore this call. + </p> + + @param Text + new value for progress description which should be shown now + */ + [oneway] void setText( [in] string Text ); + + //------------------------------------------------------------------------- + /** update progress value + + <p> + Wrong values must be ignored and stopped indicators must ignore this + call generaly. + </p> + + @param Value + new value for progress which should be shown now + Must fit the range [0..Range] which was set during + <member>XStatusIndicator::start()</member>. + */ + [oneway] 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> + */ + [oneway] void reset(); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/XStatusIndicatorFactory.idl b/offapi/com/sun/star/task/XStatusIndicatorFactory.idl new file mode 100644 index 000000000000..b7f6b0ea62c1 --- /dev/null +++ b/offapi/com/sun/star/task/XStatusIndicatorFactory.idl @@ -0,0 +1,65 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XStatusIndicatorFactory_idl__ +#define __com_sun_star_task_XStatusIndicatorFactory_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_task_XStatusIndicator_idl__ +#include <com/sun/star/task/XStatusIndicator.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module task { + +//============================================================================= +/** provides multiple, probably parallel running, status indicator objects + + <p> + A possible factory is the <type scope="com::sun::star::frame">Frame</type> + 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 diff --git a/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl new file mode 100644 index 000000000000..c7e8630e55eb --- /dev/null +++ b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl @@ -0,0 +1,61 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XStatusIndicatorSupplier_idl__ +#define __com_sun_star_task_XStatusIndicatorSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_task_XStatusIndicator_idl__ +#include <com/sun/star/task/XStatusIndicator.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module task { + +//============================================================================= +/** use <type>XStatusIndicatorFactory</type> instead of this + + @deprecated + */ +published interface XStatusIndicatorSupplier: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** use <member>XStatusIndicatorFactory::createStatusIndicator()</member> + instead of this + + @deprecated + */ + com::sun::star::task::XStatusIndicator getStatusIndicator(); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/XUrlContainer.idl b/offapi/com/sun/star/task/XUrlContainer.idl new file mode 100644 index 000000000000..ac55107c67f0 --- /dev/null +++ b/offapi/com/sun/star/task/XUrlContainer.idl @@ -0,0 +1,91 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XUrlContainer_idl__ +#define __com_sun_star_task_XUrlContainer_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_task_XInteractionHandler_idl__ +#include <com/sun/star/task/XInteractionHandler.idl> +#endif + + +//============================================================================= + +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 taht are stored persistently shall + be returned. + @returns List of URLs. + */ + sequence<string> getUrls( [in] boolean OnlyPersistent ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/makefile.mk b/offapi/com/sun/star/task/makefile.mk new file mode 100644 index 000000000000..cd9db6b5a738 --- /dev/null +++ b/offapi/com/sun/star/task/makefile.mk @@ -0,0 +1,91 @@ +#************************************************************************* +# +# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +# +# Copyright 2000, 2010 Oracle and/or its affiliates. +# Copyright IBM Corporation 2009. +# +# OpenOffice.org - a multi-platform office productivity suite +# +# This file is part of OpenOffice.org. +# +# OpenOffice.org is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License version 3 +# only, as published by the Free Software Foundation. +# +# OpenOffice.org is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License version 3 for more details +# (a copy is included in the LICENSE file that accompanied this code). +# +# You should have received a copy of the GNU Lesser General Public License +# version 3 along with OpenOffice.org. If not, see +# <http://www.openoffice.org/license.html> +# for a copy of the LGPLv3 License. +# +#************************************************************************* + +PRJ=..$/..$/..$/.. + +PRJNAME=offapi + +TARGET=csstask +PACKAGE=com$/sun$/star$/task + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + ClassifiedInteractionRequest.idl\ + DocumentMacroConfirmationRequest.idl\ + DocumentPasswordRequest.idl\ + DocumentPasswordRequest2.idl\ + DocumentMSPasswordRequest.idl\ + DocumentMSPasswordRequest2.idl\ + ErrorCodeRequest.idl\ + ErrorCodeIOException.idl\ + FutureDocumentVersionProductUpdateRequest.idl\ + InteractionClassification.idl\ + InteractionHandler.idl\ + JobExecutor.idl\ + Job.idl\ + AsyncJob.idl\ + MasterPasswordRequest.idl\ + NoMasterException.idl\ + PasswordContainer.idl\ + PasswordContainerInteractionHandler.idl\ + PasswordRequest.idl\ + PasswordRequestMode.idl\ + PDFExportException.idl\ + OfficeRestartManager.idl\ + UnsupportedOverwriteRequest.idl\ + UrlRecord.idl\ + UserRecord.idl\ + XAsyncJob.idl\ + XInteractionApprove.idl\ + XInteractionAskLater.idl\ + XInteractionDisapprove.idl\ + XInteractionPassword.idl\ + XInteractionPassword2.idl\ + XJob.idl\ + XJobExecutor.idl\ + XJobListener.idl\ + XMasterPasswordHandling.idl\ + XMasterPasswordHandling2.idl\ + XPasswordContainer.idl\ + XRestartManager.idl\ + XStatusIndicator.idl\ + XStatusIndicatorFactory.idl\ + XStatusIndicatorSupplier.idl\ + XAbortChannel.idl\ + XInteractionRequestStringResolver.idl\ + InteractionRequestStringResolver.idl\ + XUrlContainer.idl + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk |