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/XInteractionRequest.hpp>
  26 #include <cppuhelper/implbase.hxx>
  27
  28 namespace comphelper {
  29
  30 class AbortContinuation;
  31 class PasswordContinuation;
  32
  33
  34 /** Selects which UNO document password request type to use. */
  35 enum class DocPasswordRequestType
  36 {
  37     Standard,    /// Uses the standard com.sun.star.task.DocumentPasswordRequest request.
  38     MS           /// Uses the com.sun.star.task.DocumentMSPasswordRequest request.
  39 };
  40
  41
  42 class COMPHELPER_DLLPUBLIC SimplePasswordRequest :
  43         public cppu::WeakImplHelper<css::task::XInteractionRequest>
  44 {
  45 public:
  46     explicit    SimplePasswordRequest( css::task::PasswordRequestMode eMode );
  47     virtual     ~SimplePasswordRequest();
  48
  49     bool         isPassword() const;
  50
  51     OUString     getPassword() const;
  52
  53 private:
  54     // XInteractionRequest
  55     virtual css::uno::Any SAL_CALL getRequest() throw( css::uno::RuntimeException, std::exception ) override;
  56     virtual css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > SAL_CALL getContinuations() throw( css::uno::RuntimeException, std::exception ) override;
  57
  58 private:
  59     css::uno::Any      maRequest;
  60     css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > maContinuations;
  61     PasswordContinuation *          mpPassword;
  62 };
  63
  64
  65 /** Implements the task.XInteractionRequest interface for requesting a password
  66     string for a document.
  67  */
  68 class COMPHELPER_DLLPUBLIC DocPasswordRequest :
  69         public cppu::WeakImplHelper<css::task::XInteractionRequest>
  70 {
  71 public:
  72     explicit            DocPasswordRequest(
  73                             DocPasswordRequestType eType,
  74                             css::task::PasswordRequestMode eMode,
  75                             const OUString& rDocumentUrl,
  76                             bool bPasswordToModify = false );
  77     virtual             ~DocPasswordRequest();
  78
  79     bool            isPassword() const;
  80
  81     OUString     getPassword() const;
  82
  83     OUString     getPasswordToModify() const;
  84     bool            getRecommendReadOnly() const;
  85
  86 private:
  87     // XInteractionRequest
  88     virtual css::uno::Any SAL_CALL getRequest() throw( css::uno::RuntimeException, std::exception ) override;
  89     virtual css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > SAL_CALL getContinuations() throw( css::uno::RuntimeException, std::exception ) override;
  90
  91 private:
  92     css::uno::Any      maRequest;
  93     css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > maContinuations;
  94     PasswordContinuation *          mpPassword;
  95 };
  96
  97
  98 } // namespace comphelper
  99
 100 #endif
 101
 102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */