xmloff/source/forms/elementexport.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
  20 #pragma once
  21
  22 #include <sal/config.h>
  23
  24 #include <memory>
  25 #include <o3tl/sorted_vector.hxx>
  26
  27 #include <com/sun/star/beans/XPropertySet.hpp>
  28 #include <com/sun/star/script/ScriptEventDescriptor.hpp>
  29 #include <xmloff/xmlexp.hxx>
  30 #include "propertyexport.hxx"
  31 #include "callbacks.hxx"
  32 #include "controlelement.hxx"
  33 #include "valueproperties.hxx"
  34
  35 class SvXMLElementExport;
  36 namespace xmloff
  37 {
  38
  39     //= OElementExport
  40     class OElementExport : public OPropertyExport
  41     {
  42     protected:
  43         css::uno::Sequence< css::script::ScriptEventDescriptor >
  44                                 m_aEvents;
  45
  46         std::unique_ptr<SvXMLElementExport> m_pXMLElement;          // XML element doing the concrete startElement etc.
  47
  48     public:
  49         OElementExport(IFormsExportContext& _rContext,
  50             const css::uno::Reference< css::beans::XPropertySet >& _rxProps,
  51             const css::uno::Sequence< css::script::ScriptEventDescriptor >& _rEvents);
  52         virtual ~OElementExport();
  53
  54         void doExport();
  55
  56     protected:
  57         /// get the name of the XML element
  58         virtual const char* getXMLElementName() const = 0;
  59         /// examine the element we're exporting
  60         virtual void examine();
  61         /// export the attributes
  62         virtual void exportAttributes();
  63         /// export any sub tags
  64         virtual void exportSubTags();
  65
  66         /** exports the events (as script:events tag)
  67         */
  68         void exportEvents();
  69
  70         /** add the service-name attribute to the export context
  71         */
  72         virtual void exportServiceNameAttribute();
  73
  74         /// start the XML element
  75         virtual void implStartElement(const char* _pName);
  76
  77         /// ends the XML element
  78         virtual void implEndElement();
  79     };
  80
  81     //= OControlExport
  82     /** Helper class for handling xml elements representing a form control
  83     */
  84     class OControlExport
  85                 :public OControlElement
  86                 ,public OValuePropertiesMetaData
  87                 ,public OElementExport
  88     {
  89     protected:
  90         typedef o3tl::sorted_vector<sal_Int16> Int16Set;
  91             // used below
  92
  93         OUString                m_sControlId;           // the control id to use when exporting
  94         OUString                m_sReferringControls;   // list of referring controls (i.e. their id's)
  95         sal_Int16               m_nClassId;             // class id of the control we're representing
  96         ElementType             m_eType;                // (XML) type of the control we're representing
  97         CCAFlags                m_nIncludeCommon;       // common control attributes to include
  98         DAFlags                 m_nIncludeDatabase;     // common database attributes to include
  99         SCAFlags                m_nIncludeSpecial;      // special attributes to include
 100         EAFlags                 m_nIncludeEvents;       // events to include
 101         BAFlags                 m_nIncludeBindings;     // binding attributes to include
 102
 103         std::unique_ptr<SvXMLElementExport> m_pOuterElement;        // XML element doing the concrete startElement etc. for the outer element
 104
 105     public:
 106         /** constructs an object capable of exporting controls
 107
 108             <p>You need at least two pre-requisites from outside: The control to be exported needs to have a class id
 109             assigned, and you need the list control-ids of all the controls referring to this one as LabelControl.<br/>
 110             This information can't be collected when known only the control itself and not it's complete context.</p>
 111
 112             @param _rControlId
 113                 the control id to use when exporting the control
 114             @param _rReferringControls
 115                 the comma-separated list of control-ids of all the controls referring to this one as LabelControl
 116         */
 117         OControlExport(IFormsExportContext& _rContext,
 118             const css::uno::Reference< css::beans::XPropertySet >& _rxControl,
 119             OUString _sControlId,
 120             OUString _sReferringControls,
 121             const css::uno::Sequence< css::script::ScriptEventDescriptor >& _rxEvents);
 122
 123     protected:
 124         /// start the XML element
 125         virtual void implStartElement(const char* _pName) override;
 126
 127         /// ends the XML element
 128         virtual void implEndElement() override;
 129
 130         /// get the name of the outer XML element
 131         virtual const char* getOuterXMLElementName() const;
 132
 133         // get the name of the XML element
 134         virtual const char* getXMLElementName() const override;
 135
 136         /** examine the control. Some kind of CtorImpl.
 137         */
 138         virtual void examine() override;
 139
 140         /// exports the attributes for the outer element
 141         void exportOuterAttributes();
 142
 143         /// exports the attributes for the inner element
 144         void exportInnerAttributes();
 145
 146         /// export the attributes
 147         virtual void exportAttributes() override;
 148
 149         /** writes everything which needs to be represented as sub tag
 150         */
 151         void exportSubTags() override;
 152
 153         /** adds the attributes which are handled via generic IPropertyHandlers
 154
 155             <p>In the future, this really should be *all* attributes, instead of this shitload of
 156             hand-crafted code we have currently...</p>
 157         */
 158         void exportGenericHandlerAttributes();
 159
 160         /** adds common control attributes to the XMLExport context given
 161
 162             <p>The attribute list of the context is not cleared initially, this is the responsibility of the caller.</p>
 163         */
 164         void exportCommonControlAttributes();
 165
 166         /** adds database attributes to the XMLExport context given
 167
 168             <p>The attribute list of the context is not cleared initially, this is the responsibility of the caller.</p>
 169         */
 170         void exportDatabaseAttributes();
 171
 172         /** adds the XML attributes which are related to binding controls to
 173             external values and/or list sources
 174         */
 175         void exportBindingAttributes();
 176
 177         /** adds attributes which are special to a control type to the export context's attribute list
 178         */
 179         void exportSpecialAttributes();
 180
 181         /** exports the ListSource property of a control as attribute
 182
 183             The ListSource property may be exported in different ways: For a ComboBox, it is an attribute
 184             of the form:combobox element.
 185
 186             For a ListBox, it's an attribute if the ListSourceType states that the ListBox does <em>not</em>
 187             display a value list. In case of a value list, the ListSource is not exported, and the pairs of
 188             StringItem/ValueItem are exported as sub-elements.
 189
 190             This method does the attribute part: It exports the ListSource property as attribute, not caring
 191             about whether the object is a ComboBox or a ListBox.
 192         */
 193         void exportListSourceAsAttribute();
 194
 195         /** exports the ListSource property of a control as XML elements
 196
 197             @see exportListSourceAsAttribute
 198         */
 199         void exportListSourceAsElements();
 200
 201         /** gets a Sequence&lt; sal_Int16 &gt; property value as set of sal_Int16's
 202             @param _rPropertyName
 203                 the property name to use
 204             @param _rOut
 205                 out parameter. The set of integers.
 206         */
 207         void getSequenceInt16PropertyAsSet(const OUString& _rPropertyName, Int16Set& _rOut);
 208
 209         /** exports the attribute which descrives a cell value binding of a control
 210             in a spreadsheet document
 211         */
 212         void exportCellBindingAttributes( bool _bIncludeListLinkageType );
 213
 214         /** exports the attribute(s) which bind this control to XForms */
 215         void exportXFormsBindAttributes();
 216
 217         /** exports the attribute(s) which bind the list of a list
 218             control to XForms */
 219         void exportXFormsListAttributes();
 220
 221         /** exports the attribute(s) for an XForms submission */
 222         void exportXFormsSubmissionAttributes();
 223
 224         /** exports the attribute which descrives a cell range which acts as list source for
 225             a list-like control
 226         */
 227         void exportCellListSourceRange( );
 228
 229         /** exports the attribute(s) for the ImagePosition property
 230         */
 231         void exportImagePositionAttributes();
 232
 233         /** determines whether the control we're exporting has an active data binding.
 234
 235             Bindings which count here are:
 236             <ul><li>an established connection to a database field</li>
 237                 <li>a binding to an external value supplier (<type scope="css::form::binding">XValueBinding</type>)</li>
 238             </ul>
 239         */
 240         bool controlHasActiveDataBinding() const;
 241
 242         /** retrieves the string specifying the ListSource of a list or combo box
 243         */
 244         OUString getScalarListSourceValue() const;
 245
 246         /** determines whether the list entries (of a combo or list box) are supplied by the user
 247
 248             List entries may be
 249             <ul><li>specified by the user</li>
 250                 <li>specified by an external list source (<type scope="css::form::binding">XListEntrySource</type>)</li>
 251                 <li>obtained from a database query (in various ways)</li>
 252             </ul>
 253
 254             In the latter two cases, this method will return <FALSE/>
 255         */
 256         bool controlHasUserSuppliedListEntries() const;
 257     };
 258
 259     //= OColumnExport
 260     /** Helper class for exporting a grid column
 261     */
 262     class OColumnExport : public OControlExport
 263     {
 264     public:
 265         /** ctor
 266             @see OColumnExport::OColumnExport
 267         */
 268         OColumnExport(IFormsExportContext& _rContext,
 269             const css::uno::Reference< css::beans::XPropertySet >& _rxControl,
 270             const OUString& _rControlId,
 271             const css::uno::Sequence< css::script::ScriptEventDescriptor >& _rxEvents);
 272
 273         virtual ~OColumnExport() override;
 274
 275     protected:
 276         // OControlExport overridables
 277         virtual const char* getOuterXMLElementName() const override;
 278         virtual void exportServiceNameAttribute() override;
 279         virtual void exportAttributes() override;
 280
 281         // OElementExport overridables
 282         virtual void examine() override;
 283     };
 284
 285     //= OFormExport
 286     /** Helper class for handling xml elements representing a form
 287
 288         <p>In opposite to the class <type>OControlExport</type>, OFormExport is unable to export a <em>complete</em>
 289         form. Instead the client has to care for sub elements of the form itself.</p>
 290     */
 291     class OFormExport
 292                 :public OControlElement
 293                 ,public OElementExport
 294     {
 295         bool m_bCreateConnectionResourceElement;
 296     public:
 297         /** constructs an object capable of exporting controls
 298         */
 299         OFormExport(IFormsExportContext& _rContext,
 300             const css::uno::Reference< css::beans::XPropertySet >& _rxForm,
 301             const css::uno::Sequence< css::script::ScriptEventDescriptor >& _rxEvents
 302             );
 303
 304     protected:
 305         virtual const char* getXMLElementName() const override;
 306         virtual void exportSubTags() override;
 307         virtual void exportAttributes() override;
 308     };
 309 }   // namespace xmloff
 310
 311 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */