ucb/source/ucp/tdoc/tdoc_passwordrequest.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: tdoc_passwordrequest.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_TDOC_PASSWORDREQUEST_HXX
  32 #define INCLUDED_TDOC_PASSWORDREQUEST_HXX
  33
  34 #include "com/sun/star/task/PasswordRequestMode.hpp"
  35 #include "com/sun/star/task/XInteractionPassword.hpp"
  36
  37 #include "ucbhelper/interactionrequest.hxx"
  38
  39 namespace tdoc_ucp {
  40
  41     /*
  42         @usage:
  43
  44         uno::Reference< ucb::XCommandEnvironment > Environment = ...;
  45
  46         if ( Environment.is() )
  47         {
  48             uno::Reference< task::XInteractionHandler > xIH
  49                 = Environment->getInteractionHandler();
  50             if ( xIH.is() )
  51             {
  52                 rtl::Reference< DocumentPasswordRequest > xRequest
  53                     = new DocumentPasswordRequest(
  54                         task::PasswordRequestMode_PASSWORD_ENTER,
  55                         m_xIdentifier->getContentIdentifier() );
  56                 xIH->handle( xRequest.get() );
  57
  58                 rtl::Reference< ucbhelper::InteractionContinuation > xSelection
  59                     = xRequest->getSelection();
  60
  61                 if ( xSelection.is() )
  62                 {
  63                     // Handler handled the request.
  64                     uno::Reference< task::XInteractionAbort > xAbort(
  65                         xSelection.get(), uno::UNO_QUERY );
  66                     if ( xAbort.is() )
  67                     {
  68                         // @@@
  69                     }
  70
  71                     uno::Reference< task::XInteractionRetry > xRetry(
  72                         xSelection.get(), uno::UNO_QUERY );
  73                     if ( xRetry.is() )
  74                     {
  75                         // @@@
  76                     }
  77
  78                     uno::Reference< task::XInteractionPassword > xPassword(
  79                         xSelection.get(), uno::UNO_QUERY );
  80                     if ( xPassword.is() )
  81                     {
  82                         rtl::OUString aPassword = xPassword->getPassword();
  83
  84                         // @@@
  85                     }
  86                 }
  87             }
  88         }
  89
  90     */
  91
  92     class DocumentPasswordRequest : public ucbhelper::InteractionRequest
  93     {
  94     public:
  95         DocumentPasswordRequest(
  96             com::sun::star::task::PasswordRequestMode eMode,
  97             const rtl::OUString & rDocumentName );
  98     };
  99
 100 } // namespace tdoc_ucp
 101
 102 #endif /* !INCLUDED_TDOC_PASSWORDREQUEST_HXX */
 103