diff options
Diffstat (limited to 'basctl/source/inc/docsignature.hxx')
-rw-r--r-- | basctl/source/inc/docsignature.hxx | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/basctl/source/inc/docsignature.hxx b/basctl/source/inc/docsignature.hxx new file mode 100644 index 000000000000..d4e7ba1fde00 --- /dev/null +++ b/basctl/source/inc/docsignature.hxx @@ -0,0 +1,89 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef BASCTL_DOCSIGNATURE_HXX +#define BASCTL_DOCSIGNATURE_HXX + +/** === begin UNO includes === **/ +#include <com/sun/star/frame/XModel.hpp> +/** === end UNO includes === **/ + +#include <memory> + +//........................................................................ +namespace basctl +{ +//........................................................................ + + class ScriptDocument; + //==================================================================== + //= DocumentSignature + //==================================================================== + struct DocumentSignature_Data; + /// encapsulates (actions on) the signature/state of a document + class DocumentSignature + { + public: + /** creates a DocumentSignature instance for the given document + + If the given ScriptDocument instance refers to the application, or to a document + which does not support being signed, the DocumentSignature instance is invalid afterwards. + */ + DocumentSignature( const ScriptDocument& _rDocument ); + ~DocumentSignature(); + + /** determines whether the instance is valid + + An instance is valid if and only if it has been constructed with a document + which supports signatures. + */ + bool supportsSignatures() const; + + /** signs the scripting content inside the document + + @precond + isValid returns <TRUE/> + */ + void signScriptingContent() const; + + /** retrieves the state of the signature of the scripting content inside the document + + If the instance is not valid, then SIGNATURESTATE_NOSIGNATURES is returned. + */ + sal_uInt16 getScriptingSignatureState() const; + + private: + DocumentSignature(); // not implemented + + private: + ::std::auto_ptr< DocumentSignature_Data > m_pData; + }; + +//........................................................................ +} // namespace basctl +//........................................................................ + +#endif // BASCTL_DOCSIGNATURE_HXX |