xref: /aoo42x/main/basctl/source/inc/docsignature.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir #ifndef BASCTL_DOCSIGNATURE_HXX
28*cdf0e10cSrcweir #define BASCTL_DOCSIGNATURE_HXX
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir /** === begin UNO includes === **/
31*cdf0e10cSrcweir #include <com/sun/star/frame/XModel.hpp>
32*cdf0e10cSrcweir /** === end UNO includes === **/
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir #include <memory>
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir //........................................................................
37*cdf0e10cSrcweir namespace basctl
38*cdf0e10cSrcweir {
39*cdf0e10cSrcweir //........................................................................
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir     class ScriptDocument;
42*cdf0e10cSrcweir 	//====================================================================
43*cdf0e10cSrcweir 	//= DocumentSignature
44*cdf0e10cSrcweir 	//====================================================================
45*cdf0e10cSrcweir     struct DocumentSignature_Data;
46*cdf0e10cSrcweir     /// encapsulates (actions on) the signature/state of a document
47*cdf0e10cSrcweir 	class DocumentSignature
48*cdf0e10cSrcweir 	{
49*cdf0e10cSrcweir     public:
50*cdf0e10cSrcweir         /** creates a DocumentSignature instance for the given document
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir             If the given ScriptDocument instance refers to the application, or to a document
53*cdf0e10cSrcweir             which does not support being signed, the DocumentSignature instance is invalid afterwards.
54*cdf0e10cSrcweir         */
55*cdf0e10cSrcweir         DocumentSignature( const ScriptDocument& _rDocument );
56*cdf0e10cSrcweir         ~DocumentSignature();
57*cdf0e10cSrcweir 
58*cdf0e10cSrcweir         /** determines whether the instance is valid
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir             An instance is valid if and only if it has been constructed with a document
61*cdf0e10cSrcweir             which supports signatures.
62*cdf0e10cSrcweir         */
63*cdf0e10cSrcweir         bool    supportsSignatures() const;
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir         /** signs the scripting content inside the document
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir             @precond
68*cdf0e10cSrcweir                 isValid returns <TRUE/>
69*cdf0e10cSrcweir         */
70*cdf0e10cSrcweir         void        signScriptingContent() const;
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir         /** retrieves the state of the signature of the scripting content inside the document
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir             If the instance is not valid, then SIGNATURESTATE_NOSIGNATURES is returned.
75*cdf0e10cSrcweir         */
76*cdf0e10cSrcweir         sal_uInt16  getScriptingSignatureState() const;
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir     private:
79*cdf0e10cSrcweir         DocumentSignature();        // not implemented
80*cdf0e10cSrcweir 
81*cdf0e10cSrcweir     private:
82*cdf0e10cSrcweir         ::std::auto_ptr< DocumentSignature_Data >   m_pData;
83*cdf0e10cSrcweir 	};
84*cdf0e10cSrcweir 
85*cdf0e10cSrcweir //........................................................................
86*cdf0e10cSrcweir } // namespace basctl
87*cdf0e10cSrcweir //........................................................................
88*cdf0e10cSrcweir 
89*cdf0e10cSrcweir #endif // BASCTL_DOCSIGNATURE_HXX
90