ucb/source/ucp/tdoc/tdoc_passwordrequest.hxx

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