basctl/source/inc/docsignature.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef BASCTL_DOCSIGNATURE_HXX
  20 #define BASCTL_DOCSIGNATURE_HXX
  21
  22 #include <com/sun/star/frame/XModel.hpp>
  23
  24 #include <boost/scoped_ptr.hpp>
  25
  26 //........................................................................
  27 namespace basctl
  28 {
  29 //........................................................................
  30
  31     class ScriptDocument;
  32     //====================================================================
  33     //= DocumentSignature
  34     //====================================================================
  35     /// encapsulates (actions on) the signature/state of a document
  36     class DocumentSignature
  37     {
  38     public:
  39         /** creates a DocumentSignature instance for the given document
  40
  41             If the given ScriptDocument instance refers to the application, or to a document
  42             which does not support being signed, the DocumentSignature instance is invalid afterwards.
  43         */
  44         explicit DocumentSignature (ScriptDocument const&);
  45         ~DocumentSignature();
  46
  47         /** determines whether the instance is valid
  48
  49             An instance is valid if and only if it has been constructed with a document
  50             which supports signatures.
  51         */
  52         bool    supportsSignatures() const;
  53
  54         /** signs the scripting content inside the document
  55
  56             @precond
  57                 isValid returns <TRUE/>
  58         */
  59         void        signScriptingContent() const;
  60
  61         /** retrieves the state of the signature of the scripting content inside the document
  62
  63             If the instance is not valid, then SIGNATURESTATE_NOSIGNATURES is returned.
  64         */
  65         sal_uInt16  getScriptingSignatureState() const;
  66
  67     private:
  68         DocumentSignature();        // not implemented
  69
  70     private:
  71         struct Impl;
  72         boost::scoped_ptr<Impl> m_pImpl;
  73     };
  74
  75 //........................................................................
  76 } // namespace basctl
  77 //........................................................................
  78
  79 #endif // BASCTL_DOCSIGNATURE_HXX
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */