mediadescriptor.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#ifndef INCLUDED_UNOTOOLS_MEDIADESCRIPTOR_HXX
#define INCLUDED_UNOTOOLS_MEDIADESCRIPTOR_HXX
 
#include <sal/config.h>
 
#include <vector>
 
#include <comphelper/docpasswordrequest.hxx>
#include <comphelper/sequenceashashmap.hxx>
#include <rtl/ustring.hxx>
#include <unotools/unotoolsdllapi.h>
 
namespace com::sun::star::io {
    class XInputStream;
}
namespace comphelper { class IDocPasswordVerifier; }
 
namespace utl {
 
class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap
{
    public:
 
        static constexpr OUStringLiteral PROP_ABORTED = u"Aborted";
        static constexpr OUStringLiteral PROP_ASTEMPLATE = u"AsTemplate";
        static constexpr OUStringLiteral PROP_COMPONENTDATA = u"ComponentData";
        static constexpr OUStringLiteral PROP_DOCUMENTSERVICE = u"DocumentService";
        static constexpr OUStringLiteral PROP_ENCRYPTIONDATA = u"EncryptionData";
        static constexpr OUStringLiteral PROP_FILENAME = u"FileName";
        static constexpr OUStringLiteral PROP_FILTERNAME = u"FilterName";
        static constexpr OUStringLiteral PROP_FILTERPROVIDER = u"FilterProvider";
        static constexpr OUStringLiteral PROP_FILTEROPTIONS = u"FilterOptions";
        static constexpr OUStringLiteral PROP_FRAME = u"Frame";
        static constexpr OUStringLiteral PROP_FRAMENAME = u"FrameName";
        static constexpr OUStringLiteral PROP_HIDDEN = u"Hidden";
        static constexpr OUStringLiteral PROP_INPUTSTREAM = u"InputStream";
        static constexpr OUStringLiteral PROP_INTERACTIONHANDLER = u"InteractionHandler";
        static constexpr OUStringLiteral PROP_AUTHENTICATIONHANDLER = u"AuthenticationHandler";
        static constexpr OUStringLiteral PROP_JUMPMARK = u"JumpMark";
        static constexpr OUStringLiteral PROP_MACROEXECUTIONMODE = u"MacroExecutionMode";
        static constexpr OUStringLiteral PROP_MEDIATYPE = u"MediaType";
        static constexpr OUStringLiteral PROP_MINIMIZED = u"Minimized";
        static constexpr OUStringLiteral PROP_NOAUTOSAVE = u"NoAutoSave";
        static constexpr OUStringLiteral PROP_OPENNEWVIEW = u"OpenNewView";
        static constexpr OUStringLiteral PROP_OUTPUTSTREAM = u"OutputStream";
        static constexpr OUStringLiteral PROP_PASSWORD = u"Password";
        static constexpr OUStringLiteral PROP_POSTDATA = u"PostData";
        static constexpr OUStringLiteral PROP_PREVIEW = u"Preview";
        static constexpr OUStringLiteral PROP_READONLY = u"ReadOnly";
        static constexpr OUStringLiteral PROP_REFERRER = u"Referer";
        static constexpr OUStringLiteral PROP_REPLACEABLE = u"Replaceable";
        static constexpr OUStringLiteral PROP_SALVAGEDFILE = u"SalvagedFile";
        static constexpr OUStringLiteral PROP_SILENT = u"Silent";
        static constexpr OUStringLiteral PROP_STATUSINDICATOR = u"StatusIndicator";
        static constexpr OUStringLiteral PROP_STREAM = u"Stream";
        static constexpr OUStringLiteral PROP_STREAMFOROUTPUT = u"StreamForOutput";
        static constexpr OUStringLiteral PROP_TEMPLATENAME = u"TemplateName";
        static constexpr OUStringLiteral PROP_TITLE = u"Title";
        static constexpr OUStringLiteral PROP_TYPENAME = u"TypeName";
        static constexpr OUStringLiteral PROP_UCBCONTENT = u"UCBContent";
        static constexpr OUStringLiteral PROP_UPDATEDOCMODE = u"UpdateDocMode";
        static constexpr OUStringLiteral PROP_URL = u"URL";
        static constexpr OUStringLiteral PROP_VERSION = u"Version";
        static constexpr OUStringLiteral PROP_DOCUMENTTITLE = u"DocumentTitle";
        static constexpr OUStringLiteral PROP_MODEL = u"Model";
        static constexpr OUStringLiteral PROP_VIEWONLY = u"ViewOnly";
        static constexpr OUStringLiteral PROP_DOCUMENTBASEURL = u"DocumentBaseURL";
        static constexpr OUStringLiteral PROP_SUGGESTEDSAVEASNAME = u"SuggestedSaveAsName";
        static constexpr OUStringLiteral PROP_AUTOSAVEEVENT = u"AutoSaveEvent";
 
    // interface
    public:
 
        MediaDescriptor();
        MediaDescriptor(const css::uno::Sequence< css::beans::PropertyValue >& lSource);
 
        bool addInputStream();
 
        bool addInputStreamOwnLock();
 
        bool isStreamReadOnly() const;
 
        css::uno::Any getComponentDataEntry(
            const OUString& rName ) const;
 
        void setComponentDataEntry(
            const OUString& rName,
            const css::uno::Any& rValue );
 
        void clearComponentDataEntry(
            const OUString& rName );
 
        css::uno::Sequence< css::beans::NamedValue > requestAndVerifyDocPassword(
            comphelper::IDocPasswordVerifier& rVerifier,
            comphelper::DocPasswordRequestType eRequestType,
            const ::std::vector< OUString >* pDefaultPasswords );
 
    // helper
    private:
 
        SAL_DLLPRIVATE bool impl_openStreamWithPostData(
            const css::uno::Reference< css::io::XInputStream >& _rxPostData
            );
 
        SAL_DLLPRIVATE bool impl_openStreamWithURL(
            const OUString& sURL,
            bool bLockFile
            );
 
        SAL_DLLPRIVATE bool impl_addInputStream( bool bLockFile );
};
 
}
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */