xmloff/source/forms/elementexport.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: elementexport.hxx,v $
  10  * $Revision: 1.18 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _XMLOFF_ELEMENTEXPORT_HXX_
  32 #define _XMLOFF_ELEMENTEXPORT_HXX_
  33
  34 #include <com/sun/star/beans/XPropertySet.hpp>
  35 #include <com/sun/star/container/XIndexAccess.hpp>
  36 #include <com/sun/star/script/ScriptEventDescriptor.hpp>
  37 #include "propertyexport.hxx"
  38 #include "callbacks.hxx"
  39 #include "controlelement.hxx"
  40 #include "valueproperties.hxx"
  41
  42 class SvXMLElementExport;
  43 //.........................................................................
  44 namespace xmloff
  45 {
  46 //.........................................................................
  47
  48     //=====================================================================
  49     //= OElementExport
  50     //=====================================================================
  51     class OElementExport : public OPropertyExport
  52     {
  53     protected:
  54         ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >
  55                                 m_aEvents;
  56
  57         SvXMLElementExport*             m_pXMLElement;                  // XML element doing the concrete startElement etc.
  58
  59     public:
  60         OElementExport(IFormsExportContext& _rContext,
  61             const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxProps,
  62             const ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _rEvents);
  63         virtual ~OElementExport();
  64
  65         void doExport();
  66
  67     protected:
  68         /// get the name of the XML element
  69         virtual const sal_Char* getXMLElementName() const = 0;
  70         /// examine the element we're exporting
  71         virtual void examine();
  72         /// export the attributes
  73         virtual void exportAttributes();
  74         /// export any sub tags
  75         virtual void exportSubTags();
  76
  77         /** exports the events (as script:events tag)
  78         */
  79         void exportEvents();
  80
  81         /** add the service-name attribute to the export context
  82         */
  83         virtual void exportServiceNameAttribute();
  84
  85         /// start the XML element
  86         virtual void implStartElement(const sal_Char* _pName);
  87
  88         /// ends the XML element
  89         virtual void implEndElement();
  90     };
  91
  92     //=====================================================================
  93     //= OControlExport
  94     //=====================================================================
  95     /** Helper class for handling xml elements representing a form control
  96     */
  97     class OControlExport
  98                 :public OControlElement
  99                 ,public OValuePropertiesMetaData
 100                 ,public OElementExport
 101     {
 102     protected:
 103         DECLARE_STL_STDKEY_SET(sal_Int16, Int16Set);
 104             // used below
 105
 106         ::rtl::OUString                 m_sControlId;                   // the control id to use when exporting
 107         ::rtl::OUString                 m_sReferringControls;   // list of referring controls (i.e. their id's)
 108         sal_Int16                               m_nClassId;                             // class id of the control we're representing
 109         ElementType                             m_eType;                                // (XML) type of the control we're representing
 110         sal_Int32                               m_nIncludeCommon;               // common control attributes to include
 111         sal_Int32                               m_nIncludeDatabase;             // common database attributes to include
 112         sal_Int32                               m_nIncludeSpecial;              // special attributes to include
 113         sal_Int32                               m_nIncludeEvents;               // events to include
 114         sal_Int32               m_nIncludeBindings;         // binding attributes to include
 115
 116         SvXMLElementExport*             m_pOuterElement;                // XML element doing the concrete startElement etc. for the outer element
 117
 118     public:
 119         /** constructs an object capable of exporting controls
 120
 121             <p>You need at least two pre-requisites from outside: The control to be exported needs to have a class id
 122             assigned, and you need the list control-ids of all the controls referring to this one as LabelControl.<br/>
 123             This information can't be collected when known only the control itself and not it's complete context.</p>
 124
 125             @param _rControlId
 126                 the control id to use when exporting the control
 127             @param _rReferringControls
 128                 the comma-separated list of control-ids of all the controls referring to this one as LabelControl
 129         */
 130         OControlExport(IFormsExportContext& _rContext,
 131             const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControl,
 132             const ::rtl::OUString& _rControlId,
 133             const ::rtl::OUString& _rReferringControls,
 134             const ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _rxEvents);
 135         ~OControlExport();
 136
 137     protected:
 138         /// start the XML element
 139         virtual void implStartElement(const sal_Char* _pName);
 140
 141         /// ends the XML element
 142         virtual void implEndElement();
 143
 144         /// get the name of the outer XML element
 145         virtual const sal_Char* getOuterXMLElementName() const;
 146
 147         // get the name of the XML element
 148         virtual const sal_Char* getXMLElementName() const;
 149
 150         /** examine the control. Some kind of CtorImpl.
 151         */
 152         virtual void examine();
 153
 154         /// exports the attributes for the outer element
 155         void exportOuterAttributes();
 156
 157         /// exports the attributes for the inner element
 158         void exportInnerAttributes();
 159
 160         /// export the attributes
 161         virtual void exportAttributes();
 162
 163         /** writes everything which needs to be represented as sub tag
 164         */
 165         void exportSubTags() throw (::com::sun::star::uno::Exception);
 166
 167         /**     adds common control attributes to the XMLExport context given
 168
 169             <p>The attribute list of the context is not cleared initially, this is the responsibility of the caller.</p>
 170         */
 171         void exportCommonControlAttributes();
 172
 173         /**     adds database attributes to the XMLExport context given
 174
 175             <p>The attribute list of the context is not cleared initially, this is the responsibility of the caller.</p>
 176         */
 177         void exportDatabaseAttributes();
 178
 179         /**     adds the XML attributes which are related to binding controls to
 180             external values and/or list sources
 181         */
 182         void exportBindingAtributes();
 183
 184         /** adds attributes which are special to a control type to the export context's attribute list
 185         */
 186         void exportSpecialAttributes();
 187
 188         /** exports the ListSource property of a control as attribute
 189
 190             The ListSource property may be exported in different ways: For a ComboBox, it is an attribute
 191             of the form:combobox element.
 192
 193             For a ListBox, it's an attribute if the ListSourceType states that the ListBox does <em>not</em>
 194             display a value list. In case of a value list, the ListSource is not exported, and the pairs of
 195             StringItem/ValueItem are exported as sub-elements.
 196
 197             This method does the attribute part: It exports the ListSource property as attribute, not caring
 198             about whether the object is a ComboBox or a ListBox.
 199         */
 200         void exportListSourceAsAttribute();
 201
 202         /** exports the ListSource property of a control as XML elements
 203
 204             @see exportListSourceAsAttribute
 205         */
 206         void exportListSourceAsElements();
 207
 208         /** get's a Sequence&lt; sal_Int16 &gt; property value as set of sal_Int16's
 209             @param _rPropertyName
 210                 the property name to use
 211             @param _rOut
 212                 out parameter. The set of integers.
 213         */
 214         void getSequenceInt16PropertyAsSet(const ::rtl::OUString& _rPropertyName, Int16Set& _rOut);
 215
 216         /** exports the attribute which descrives a cell value binding of a control
 217             in a spreadsheet document
 218         */
 219         void exportCellBindingAttributes( bool _bIncludeListLinkageType );
 220
 221         /** exports the attribute(s) which bind this control to XForms */
 222         void exportXFormsBindAttributes();
 223
 224         /** exports the attribute(s) which bind the list of a list
 225             control to XForms */
 226         void exportXFormsListAttributes();
 227
 228         /** exports the attribute(s) for an XForms submission */
 229         void exportXFormsSubmissionAttributes();
 230
 231         /** exports the attribute which descrives a cell range which acts as list source for
 232             a list-like control
 233         */
 234         void exportCellListSourceRange( );
 235
 236         /** exports the attribut(s) for the ImagePosition property
 237         */
 238         void exportImagePositionAttributes();
 239
 240         /** determines whether the control we're exporting has an active data binding.
 241
 242             Bindings which count here are:
 243             <ul><li>an established connection to a database field</li>
 244                 <li>a binding to an external value supplier (<type scope="com::sun::star::form::binding">XValueBinding</type>)</li>
 245             </ul>
 246         */
 247         bool controlHasActiveDataBinding() const;
 248
 249         /** retrieves the string specifying the ListSource of a list or combo box
 250         */
 251         ::rtl::OUString getScalarListSourceValue() const;
 252
 253         /** determines whether the list entries (of a combo or list box) are supplied by the user
 254
 255             List entries may be
 256             <ul><li>specified by the user</li>
 257                 <li>specified by an external list source (<type scope="com::sun::star::form::binding">XListEntrySource</type>)</li>
 258                 <li>obtained from a database query (in various ways)</li>
 259             </ul>
 260
 261             In the latter two cases, this method will return <FALSE/>
 262         */
 263         bool controlHasUserSuppliedListEntries() const;
 264     };
 265
 266     //=====================================================================
 267     //= OColumnExport
 268     //=====================================================================
 269     /** Helper class for exporting a grid column
 270     */
 271     class OColumnExport : public OControlExport
 272     {
 273     public:
 274         /** ctor
 275             @see OColumnExport::OColumnExport
 276         */
 277         OColumnExport(IFormsExportContext& _rContext,
 278             const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControl,
 279             const ::rtl::OUString& _rControlId,
 280             const ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _rxEvents);
 281
 282         ~OColumnExport();
 283
 284     protected:
 285         // OControlExport overridables
 286         virtual const sal_Char* getOuterXMLElementName() const;
 287         virtual void exportServiceNameAttribute();
 288         virtual void exportAttributes();
 289
 290         // OElementExport overridables
 291         virtual void examine();
 292     };
 293
 294     //=====================================================================
 295     //= OFormExport
 296     //=====================================================================
 297     /** Helper class for handling xml elements representing a form
 298
 299         <p>In opposite to the class <type>OControlExport</type>, OFormExport is unable to export a <em>complete</em>
 300         form. Instead the client has to care for sub elements of the form itself.</p>
 301     */
 302     class OFormExport
 303                 :public OControlElement
 304                 ,public OElementExport
 305     {
 306         sal_Bool m_bCreateConnectionResourceElement;
 307     public:
 308         /** constructs an object capable of exporting controls
 309         */
 310         OFormExport(IFormsExportContext& _rContext,
 311             const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxForm,
 312             const ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _rxEvents
 313             );
 314
 315     protected:
 316         virtual const sal_Char* getXMLElementName() const;
 317         virtual void exportSubTags();
 318         virtual void exportAttributes();
 319     };
 320 //.........................................................................
 321 }       // namespace xmloff
 322 //.........................................................................
 323
 324 #endif // _XMLOFF_ELEMENTEXPORT_HXX_
 325