basctl/source/inc/docsignature.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: docsignature.hxx,v $
  10  * $Revision: 1.3 $
  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 #ifndef BASCTL_DOCSIGNATURE_HXX
  31 #define BASCTL_DOCSIGNATURE_HXX
  32
  33 /** === begin UNO includes === **/
  34 #include <com/sun/star/frame/XModel.hpp>
  35 /** === end UNO includes === **/
  36
  37 #include <memory>
  38
  39 //........................................................................
  40 namespace basctl
  41 {
  42 //........................................................................
  43
  44     class ScriptDocument;
  45     //====================================================================
  46     //= DocumentSignature
  47     //====================================================================
  48     struct DocumentSignature_Data;
  49     /// encapsulates (actions on) the signature/state of a document
  50     class DocumentSignature
  51     {
  52     public:
  53         /** creates a DocumentSignature instance for the given document
  54
  55             If the given ScriptDocument instance refers to the application, or to a document
  56             which does not support being signed, the DocumentSignature instance is invalid afterwards.
  57         */
  58         DocumentSignature( const ScriptDocument& _rDocument );
  59         ~DocumentSignature();
  60
  61         /** determines whether the instance is valid
  62
  63             An instance is valid if and only if it has been constructed with a document
  64             which supports signatures.
  65         */
  66         bool    supportsSignatures() const;
  67
  68         /** signs the scripting content inside the document
  69
  70             @precond
  71                 isValid returns <TRUE/>
  72         */
  73         void        signScriptingContent() const;
  74
  75         /** retrieves the state of the signature of the scripting content inside the document
  76
  77             If the instance is not valid, then SIGNATURESTATE_NOSIGNATURES is returned.
  78         */
  79         sal_uInt16  getScriptingSignatureState() const;
  80
  81     private:
  82         DocumentSignature();        // not implemented
  83
  84     private:
  85         ::std::auto_ptr< DocumentSignature_Data >   m_pData;
  86     };
  87
  88 //........................................................................
  89 } // namespace basctl
  90 //........................................................................
  91
  92 #endif // BASCTL_DOCSIGNATURE_HXX