ucb/source/ucp/tdoc/tdoc_passwordrequest.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 #pragma once
  21
  22 #include <com/sun/star/task/PasswordRequestMode.hpp>
  23
  24 #include <ucbhelper/interactionrequest.hxx>
  25
  26 namespace tdoc_ucp
  27 {
  28 /*
  29         @usage:
  30
  31         uno::Reference< ucb::XCommandEnvironment > Environment = ...;
  32
  33         if ( Environment.is() )
  34         {
  35             uno::Reference< task::XInteractionHandler > xIH
  36                 = Environment->getInteractionHandler();
  37             if ( xIH.is() )
  38             {
  39                 rtl::Reference< DocumentPasswordRequest > xRequest
  40                     = new DocumentPasswordRequest(
  41                         task::PasswordRequestMode_PASSWORD_ENTER,
  42                         m_xIdentifier->getContentIdentifier() );
  43                 xIH->handle( xRequest.get() );
  44
  45                 rtl::Reference< ucbhelper::InteractionContinuation > xSelection
  46                     = xRequest->getSelection();
  47
  48                 if ( xSelection.is() )
  49                 {
  50                     // Handler handled the request.
  51                     uno::Reference< task::XInteractionAbort > xAbort(
  52                         xSelection.get(), uno::UNO_QUERY );
  53                     if ( xAbort.is() )
  54                     {
  55                         // @@@
  56                     }
  57
  58                     uno::Reference< task::XInteractionRetry > xRetry(
  59                         xSelection.get(), uno::UNO_QUERY );
  60                     if ( xRetry.is() )
  61                     {
  62                         // @@@
  63                     }
  64
  65                     uno::Reference< task::XInteractionPassword > xPassword(
  66                         xSelection.get(), uno::UNO_QUERY );
  67                     if ( xPassword.is() )
  68                     {
  69                         OUString aPassword = xPassword->getPassword();
  70
  71                         // @@@
  72                     }
  73                 }
  74             }
  75         }
  76
  77     */
  78
  79 class DocumentPasswordRequest : public ucbhelper::InteractionRequest
  80 {
  81 public:
  82     DocumentPasswordRequest(css::task::PasswordRequestMode eMode, const OUString& rDocumentName);
  83 };
  84
  85 } // namespace tdoc_ucp
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */