elementexport.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 .
 */
 
#pragma once
 
#include <sal/config.h>
 
#include <memory>
#include <o3tl/sorted_vector.hxx>
 
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/script/ScriptEventDescriptor.hpp>
#include <xmloff/xmlexp.hxx>
#include "propertyexport.hxx"
#include "callbacks.hxx"
#include "controlelement.hxx"
#include "valueproperties.hxx"
 
class SvXMLElementExport;
namespace xmloff
{
 
    //= OElementExport
    class OElementExport : public OPropertyExport
    {
        css::uno::Sequence< css::script::ScriptEventDescriptor >
                                m_aEvents;
 
        std::unique_ptr<SvXMLElementExport> m_pXMLElement;          // XML element doing the concrete startElement etc.
 
    public:
        OElementExport(IFormsExportContext& _rContext,
            const css::uno::Reference< css::beans::XPropertySet >& _rxProps,
            const css::uno::Sequence< css::script::ScriptEventDescriptor >& _rEvents);
        virtual ~OElementExport();
 
        void doExport();
 
    protected:
        virtual const char* getXMLElementName() const = 0;
        virtual void examine();
        virtual void exportAttributes();
        virtual void exportSubTags();
 
        void exportEvents();
 
        virtual void exportServiceNameAttribute();
 
        virtual void implStartElement(const char* _pName);
 
        virtual void implEndElement();
    };
 
    //= OControlExport
    class OControlExport
                :public OControlElement
                ,public OValuePropertiesMetaData
                ,public OElementExport
    {
    protected:
        typedef o3tl::sorted_vector<sal_Int16> Int16Set;
            // used below
 
        OUString                m_sControlId;           // the control id to use when exporting
        OUString                m_sReferringControls;   // list of referring controls (i.e. their id's)
        sal_Int16               m_nClassId;             // class id of the control we're representing
        ElementType             m_eType;                // (XML) type of the control we're representing
        CCAFlags                m_nIncludeCommon;       // common control attributes to include
        DAFlags                 m_nIncludeDatabase;     // common database attributes to include
        SCAFlags                m_nIncludeSpecial;      // special attributes to include
        EAFlags                 m_nIncludeEvents;       // events to include
        BAFlags                 m_nIncludeBindings;     // binding attributes to include
 
        std::unique_ptr<SvXMLElementExport> m_pOuterElement;        // XML element doing the concrete startElement etc. for the outer element
 
    public:
        OControlExport(IFormsExportContext& _rContext,
            const css::uno::Reference< css::beans::XPropertySet >& _rxControl,
            OUString _sControlId,
            OUString _sReferringControls,
            const css::uno::Sequence< css::script::ScriptEventDescriptor >& _rxEvents);
 
    protected:
        virtual void implStartElement(const char* _pName) override;
 
        virtual void implEndElement() override;
 
        virtual const char* getOuterXMLElementName() const;
 
        // get the name of the XML element
        virtual const char* getXMLElementName() const override;
 
        virtual void examine() override;
 
        void exportOuterAttributes();
 
        void exportInnerAttributes();
 
        virtual void exportAttributes() override;
 
        void exportSubTags() override;
 
        void exportGenericHandlerAttributes();
 
        void exportCommonControlAttributes();
 
        void exportDatabaseAttributes();
 
        void exportBindingAttributes();
 
        void exportSpecialAttributes();
 
        void exportListSourceAsAttribute();
 
        void exportListSourceAsElements();
 
        void getSequenceInt16PropertyAsSet(const OUString& _rPropertyName, Int16Set& _rOut);
 
        void exportCellBindingAttributes( bool _bIncludeListLinkageType );
 
        void exportXFormsBindAttributes();
 
        void exportXFormsListAttributes();
 
        void exportXFormsSubmissionAttributes();
 
        void exportCellListSourceRange( );
 
        void exportImagePositionAttributes();
 
        bool controlHasActiveDataBinding() const;
 
        OUString getScalarListSourceValue() const;
 
        bool controlHasUserSuppliedListEntries() const;
    };
 
    //= OColumnExport
    class OColumnExport : public OControlExport
    {
    public:
        OColumnExport(IFormsExportContext& _rContext,
            const css::uno::Reference< css::beans::XPropertySet >& _rxControl,
            const OUString& _rControlId,
            const css::uno::Sequence< css::script::ScriptEventDescriptor >& _rxEvents);
 
        virtual ~OColumnExport() override;
 
    protected:
        // OControlExport overridables
        virtual const char* getOuterXMLElementName() const override;
        virtual void exportServiceNameAttribute() override;
        virtual void exportAttributes() override;
 
        // OElementExport overridables
        virtual void examine() override;
    };
 
    //= OFormExport
    class OFormExport
                :public OControlElement
                ,public OElementExport
    {
        bool m_bCreateConnectionResourceElement;
    public:
        OFormExport(IFormsExportContext& _rContext,
            const css::uno::Reference< css::beans::XPropertySet >& _rxForm,
            const css::uno::Sequence< css::script::ScriptEventDescriptor >& _rxEvents
            );
 
    protected:
        virtual const char* getXMLElementName() const override;
        virtual void exportSubTags() override;
        virtual void exportAttributes() override;
    };
}   // namespace xmloff
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */