include/comphelper/docpasswordrequest.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_COMPHELPER_DOCPASSWORDREQUEST_HXX
  21 #define INCLUDED_COMPHELPER_DOCPASSWORDREQUEST_HXX
  22
  23 #include <comphelper/comphelperdllapi.h>
  24 #include <com/sun/star/task/PasswordRequestMode.hpp>
  25 #include <com/sun/star/task/XInteractionAbort.hpp>
  26 #include <com/sun/star/task/XInteractionRequest.hpp>
  27 #include <cppuhelper/implbase.hxx>
  28 #include <rtl/ref.hxx>
  29
  30 namespace comphelper {
  31
  32 class PasswordContinuation;
  33
  34
  35 /** Selects which UNO document password request type to use. */
  36 enum class DocPasswordRequestType
  37 {
  38     Standard,    /// Uses the standard com.sun.star.task.DocumentPasswordRequest request.
  39     MS           /// Uses the com.sun.star.task.DocumentMSPasswordRequest request.
  40 };
  41
  42
  43 class COMPHELPER_DLLPUBLIC SimplePasswordRequest :
  44         public cppu::WeakImplHelper<css::task::XInteractionRequest>
  45 {
  46 public:
  47     explicit    SimplePasswordRequest();
  48     virtual     ~SimplePasswordRequest() override;
  49
  50     bool         isPassword() const;
  51
  52     OUString     getPassword() const;
  53
  54 private:
  55     SimplePasswordRequest(SimplePasswordRequest const&) = delete;
  56     SimplePasswordRequest& operator=(SimplePasswordRequest const&) = delete;
  57
  58     // XInteractionRequest
  59     virtual css::uno::Any SAL_CALL getRequest() override;
  60     virtual css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > SAL_CALL getContinuations() override;
  61
  62 private:
  63     css::uno::Any                         maRequest;
  64     css::uno::Reference<css::task::XInteractionAbort> mxAbort;
  65     rtl::Reference<PasswordContinuation>  mxPassword;
  66 };
  67
  68
  69 /** Implements the task.XInteractionRequest interface for requesting a password
  70     string for a document.
  71  */
  72 class COMPHELPER_DLLPUBLIC DocPasswordRequest :
  73         public cppu::WeakImplHelper<css::task::XInteractionRequest>
  74 {
  75 public:
  76     explicit            DocPasswordRequest(
  77                             DocPasswordRequestType eType,
  78                             css::task::PasswordRequestMode eMode,
  79                             const OUString& rDocumentUrl,
  80                             bool bPasswordToModify = false );
  81     virtual             ~DocPasswordRequest() override;
  82
  83     bool            isPassword() const;
  84
  85     OUString     getPassword() const;
  86
  87     OUString     getPasswordToModify() const;
  88     bool            getRecommendReadOnly() const;
  89
  90 private:
  91     DocPasswordRequest(DocPasswordRequest const&) = delete;
  92     DocPasswordRequest& operator=(DocPasswordRequest const&) = delete;
  93
  94     // XInteractionRequest
  95     virtual css::uno::Any SAL_CALL getRequest() override;
  96     virtual css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > SAL_CALL getContinuations() override;
  97
  98 private:
  99     css::uno::Any                         maRequest;
 100     css::uno::Reference<css::task::XInteractionAbort> mxAbort;
 101     rtl::Reference<PasswordContinuation>  mxPassword;
 102 };
 103
 104
 105 } // namespace comphelper
 106
 107 #endif
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */