1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef COMPHELPER_DOCPASSWORDREQUEST_HXX
25*b1cdbd2cSJim Jagielski #define COMPHELPER_DOCPASSWORDREQUEST_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include "comphelper/comphelperdllapi.h"
28*b1cdbd2cSJim Jagielski #include <com/sun/star/task/PasswordRequestMode.hpp>
29*b1cdbd2cSJim Jagielski #include <com/sun/star/task/XInteractionRequest.hpp>
30*b1cdbd2cSJim Jagielski #include <cppuhelper/implbase1.hxx>
31*b1cdbd2cSJim Jagielski #include <cppuhelper/weak.hxx>
32*b1cdbd2cSJim Jagielski 
33*b1cdbd2cSJim Jagielski 
34*b1cdbd2cSJim Jagielski namespace comphelper {
35*b1cdbd2cSJim Jagielski 
36*b1cdbd2cSJim Jagielski class AbortContinuation;
37*b1cdbd2cSJim Jagielski class PasswordContinuation;
38*b1cdbd2cSJim Jagielski 
39*b1cdbd2cSJim Jagielski // ============================================================================
40*b1cdbd2cSJim Jagielski 
41*b1cdbd2cSJim Jagielski /** Selects which UNO document password request type to use. */
42*b1cdbd2cSJim Jagielski enum DocPasswordRequestType
43*b1cdbd2cSJim Jagielski {
44*b1cdbd2cSJim Jagielski     DocPasswordRequestType_STANDARD,    /// Uses the standard com.sun.star.task.DocumentPasswordRequest request.
45*b1cdbd2cSJim Jagielski     DocPasswordRequestType_MS           /// Uses the com.sun.star.task.DocumentMSPasswordRequest request.
46*b1cdbd2cSJim Jagielski };
47*b1cdbd2cSJim Jagielski 
48*b1cdbd2cSJim Jagielski // ============================================================================
49*b1cdbd2cSJim Jagielski 
50*b1cdbd2cSJim Jagielski class COMPHELPER_DLLPUBLIC SimplePasswordRequest :
51*b1cdbd2cSJim Jagielski         public ::com::sun::star::task::XInteractionRequest,
52*b1cdbd2cSJim Jagielski         public ::cppu::OWeakObject
53*b1cdbd2cSJim Jagielski {
54*b1cdbd2cSJim Jagielski public:
55*b1cdbd2cSJim Jagielski     explicit    SimplePasswordRequest( com::sun::star::task::PasswordRequestMode eMode );
56*b1cdbd2cSJim Jagielski     virtual     ~SimplePasswordRequest();
57*b1cdbd2cSJim Jagielski 
58*b1cdbd2cSJim Jagielski     // XInterface / OWeakObject
59*b1cdbd2cSJim Jagielski     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType ) throw (::com::sun::star::uno::RuntimeException);
60*b1cdbd2cSJim Jagielski     virtual void SAL_CALL acquire(  ) throw ();
61*b1cdbd2cSJim Jagielski     virtual void SAL_CALL release(  ) throw ();
62*b1cdbd2cSJim Jagielski 
63*b1cdbd2cSJim Jagielski     sal_Bool            isAbort() const;
64*b1cdbd2cSJim Jagielski     sal_Bool            isPassword() const;
65*b1cdbd2cSJim Jagielski 
66*b1cdbd2cSJim Jagielski     ::rtl::OUString     getPassword() const;
67*b1cdbd2cSJim Jagielski 
68*b1cdbd2cSJim Jagielski private:
69*b1cdbd2cSJim Jagielski     // XInteractionRequest
70*b1cdbd2cSJim Jagielski     virtual ::com::sun::star::uno::Any SAL_CALL getRequest() throw( ::com::sun::star::uno::RuntimeException );
71*b1cdbd2cSJim Jagielski     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > SAL_CALL getContinuations() throw( ::com::sun::star::uno::RuntimeException );
72*b1cdbd2cSJim Jagielski 
73*b1cdbd2cSJim Jagielski private:
74*b1cdbd2cSJim Jagielski     ::com::sun::star::uno::Any      maRequest;
75*b1cdbd2cSJim Jagielski     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > maContinuations;
76*b1cdbd2cSJim Jagielski     AbortContinuation *             mpAbort;
77*b1cdbd2cSJim Jagielski     PasswordContinuation *          mpPassword;
78*b1cdbd2cSJim Jagielski };
79*b1cdbd2cSJim Jagielski 
80*b1cdbd2cSJim Jagielski // ============================================================================
81*b1cdbd2cSJim Jagielski 
82*b1cdbd2cSJim Jagielski /** Implements the task.XInteractionRequest interface for requesting a password
83*b1cdbd2cSJim Jagielski     string for a document.
84*b1cdbd2cSJim Jagielski  */
85*b1cdbd2cSJim Jagielski class COMPHELPER_DLLPUBLIC DocPasswordRequest :
86*b1cdbd2cSJim Jagielski         public ::com::sun::star::task::XInteractionRequest,
87*b1cdbd2cSJim Jagielski         public ::cppu::OWeakObject
88*b1cdbd2cSJim Jagielski {
89*b1cdbd2cSJim Jagielski public:
90*b1cdbd2cSJim Jagielski     explicit            DocPasswordRequest(
91*b1cdbd2cSJim Jagielski                             DocPasswordRequestType eType,
92*b1cdbd2cSJim Jagielski                             ::com::sun::star::task::PasswordRequestMode eMode,
93*b1cdbd2cSJim Jagielski                             const ::rtl::OUString& rDocumentName,
94*b1cdbd2cSJim Jagielski                             sal_Bool bPasswordToModify = sal_False );
95*b1cdbd2cSJim Jagielski     virtual             ~DocPasswordRequest();
96*b1cdbd2cSJim Jagielski 
97*b1cdbd2cSJim Jagielski     // XInterface / OWeakObject
98*b1cdbd2cSJim Jagielski     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType ) throw (::com::sun::star::uno::RuntimeException);
99*b1cdbd2cSJim Jagielski     virtual void SAL_CALL acquire(  ) throw ();
100*b1cdbd2cSJim Jagielski     virtual void SAL_CALL release(  ) throw ();
101*b1cdbd2cSJim Jagielski 
102*b1cdbd2cSJim Jagielski     sal_Bool            isAbort() const;
103*b1cdbd2cSJim Jagielski     sal_Bool            isPassword() const;
104*b1cdbd2cSJim Jagielski 
105*b1cdbd2cSJim Jagielski     ::rtl::OUString     getPassword() const;
106*b1cdbd2cSJim Jagielski 
107*b1cdbd2cSJim Jagielski     ::rtl::OUString     getPasswordToModify() const;
108*b1cdbd2cSJim Jagielski     sal_Bool            getRecommendReadOnly() const;
109*b1cdbd2cSJim Jagielski 
110*b1cdbd2cSJim Jagielski private:
111*b1cdbd2cSJim Jagielski     // XInteractionRequest
112*b1cdbd2cSJim Jagielski     virtual ::com::sun::star::uno::Any SAL_CALL getRequest() throw( ::com::sun::star::uno::RuntimeException );
113*b1cdbd2cSJim Jagielski     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > SAL_CALL getContinuations() throw( ::com::sun::star::uno::RuntimeException );
114*b1cdbd2cSJim Jagielski 
115*b1cdbd2cSJim Jagielski private:
116*b1cdbd2cSJim Jagielski     ::com::sun::star::uno::Any      maRequest;
117*b1cdbd2cSJim Jagielski     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > maContinuations;
118*b1cdbd2cSJim Jagielski     AbortContinuation *             mpAbort;
119*b1cdbd2cSJim Jagielski     PasswordContinuation *          mpPassword;
120*b1cdbd2cSJim Jagielski };
121*b1cdbd2cSJim Jagielski 
122*b1cdbd2cSJim Jagielski // ============================================================================
123*b1cdbd2cSJim Jagielski 
124*b1cdbd2cSJim Jagielski } // namespace comphelper
125*b1cdbd2cSJim Jagielski 
126*b1cdbd2cSJim Jagielski #endif
127*b1cdbd2cSJim Jagielski 
128