writerfilter/source/dmapper/FormControlHelper.cxx

   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 #include <math.h>
  21
  22 #include <com/sun/star/awt/XControlModel.hpp>
  23 #include <com/sun/star/beans/XPropertySet.hpp>
  24 #include <com/sun/star/container/XIndexContainer.hpp>
  25 #include <com/sun/star/container/XNamed.hpp>
  26 #include <com/sun/star/drawing/XControlShape.hpp>
  27 #include <com/sun/star/drawing/XDrawPage.hpp>
  28 #include <com/sun/star/drawing/XDrawPageSupplier.hpp>
  29 #include <com/sun/star/form/XForm.hpp>
  30 #include <com/sun/star/form/XFormComponent.hpp>
  31 #include <com/sun/star/form/XFormsSupplier.hpp>
  32 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  33 #include <com/sun/star/text/TextContentAnchorType.hpp>
  34 #include <com/sun/star/text/VertOrientation.hpp>
  35 #include <com/sun/star/uno/Any.hxx>
  36 #include <com/sun/star/uno/Type.hxx>
  37
  38 #include "FormControlHelper.hxx"
  39 #include <xmloff/odffields.hxx>
  40
  41 namespace writerfilter {
  42 namespace dmapper {
  43
  44 using namespace ::com::sun::star;
  45
  46 struct FormControlHelper::FormControlHelper_Impl
  47 {
  48     FieldId m_eFieldId;
  49     awt::Size aSize;
  50     uno::Reference<drawing::XDrawPage> rDrawPage;
  51     uno::Reference<form::XForm> rForm;
  52     uno::Reference<form::XFormComponent> rFormComponent;
  53     uno::Reference<lang::XMultiServiceFactory> rServiceFactory;
  54     uno::Reference<text::XTextDocument> rTextDocument;
  55
  56     uno::Reference<drawing::XDrawPage> getDrawPage();
  57     uno::Reference<lang::XMultiServiceFactory> getServiceFactory();
  58     uno::Reference<form::XForm> getForm();
  59     uno::Reference<container::XIndexContainer> getFormComps();
  60 };
  61
  62 uno::Reference<drawing::XDrawPage> FormControlHelper::FormControlHelper_Impl::getDrawPage()
  63 {
  64     if (! rDrawPage.is())
  65     {
  66         uno::Reference<drawing::XDrawPageSupplier>
  67             xDrawPageSupplier(rTextDocument, uno::UNO_QUERY);
  68         if (xDrawPageSupplier.is())
  69             rDrawPage = xDrawPageSupplier->getDrawPage();
  70     }
  71
  72     return rDrawPage;
  73 }
  74
  75 uno::Reference<lang::XMultiServiceFactory> FormControlHelper::FormControlHelper_Impl::getServiceFactory()
  76 {
  77     if (! rServiceFactory.is())
  78         rServiceFactory = uno::Reference<lang::XMultiServiceFactory>(rTextDocument, uno::UNO_QUERY);
  79
  80     return rServiceFactory;
  81 }
  82
  83 uno::Reference<form::XForm> FormControlHelper::FormControlHelper_Impl::getForm()
  84 {
  85     if (! rForm.is())
  86     {
  87         uno::Reference<form::XFormsSupplier> xFormsSupplier(getDrawPage(), uno::UNO_QUERY);
  88
  89         if (xFormsSupplier.is())
  90         {
  91             uno::Reference<container::XNameContainer> xFormsNamedContainer(xFormsSupplier->getForms());
  92             static OUString sDOCXForm("DOCX-Standard");
  93
  94             OUString sFormName(sDOCXForm);
  95             sal_uInt16 nUnique = 0;
  96
  97             while (xFormsNamedContainer->hasByName(sFormName))
  98             {
  99                 ++nUnique;
 100                 sFormName = sDOCXForm;
 101                 sFormName += OUString(nUnique);
 102             }
 103
 104             uno::Reference<uno::XInterface> xForm(getServiceFactory()->createInstance("com.sun.star.form.component.Form"));
 105             if (xForm.is())
 106             {
 107                 uno::Reference<beans::XPropertySet>
 108                     xFormProperties(xForm, uno::UNO_QUERY);
 109                 uno::Any aAny(sFormName);
 110                 xFormProperties->setPropertyValue("Name", aAny);
 111             }
 112
 113             rForm = uno::Reference<form::XForm>(xForm, uno::UNO_QUERY);
 114
 115             uno::Reference<container::XIndexContainer> xForms(xFormsNamedContainer, uno::UNO_QUERY);
 116             uno::Any aAny(xForm);
 117             xForms->insertByIndex(xForms->getCount(), aAny);
 118         }
 119     }
 120
 121     return rForm;
 122 }
 123
 124 uno::Reference<container::XIndexContainer> FormControlHelper::FormControlHelper_Impl::getFormComps()
 125 {
 126     uno::Reference<container::XIndexContainer> xIndexContainer(getForm(), uno::UNO_QUERY);
 127
 128     return xIndexContainer;
 129 }
 130
 131 FormControlHelper::FormControlHelper(FieldId eFieldId,
 132                                      uno::Reference<text::XTextDocument> rTextDocument,
 133                                      FFDataHandler::Pointer_t pFFData)
 134     : m_pFFData(pFFData), m_pImpl(new FormControlHelper_Impl)
 135 {
 136     m_pImpl->m_eFieldId = eFieldId;
 137     m_pImpl->rTextDocument = rTextDocument;
 138 }
 139
 140 FormControlHelper::~FormControlHelper()
 141 {
 142 }
 143
 144 bool FormControlHelper::createCheckbox(uno::Reference<text::XTextRange> xTextRange,
 145                                        const OUString & rControlName)
 146 {
 147     if ( !m_pFFData )
 148         return false;
 149     uno::Reference<lang::XMultiServiceFactory>
 150         xServiceFactory(m_pImpl->getServiceFactory());
 151
 152     if (! xServiceFactory.is())
 153         return false;
 154
 155     uno::Reference<uno::XInterface> xInterface = xServiceFactory->createInstance("com.sun.star.form.component.CheckBox");
 156
 157     if (!xInterface.is())
 158         return false;
 159
 160     m_pImpl->rFormComponent = uno::Reference<form::XFormComponent>(xInterface, uno::UNO_QUERY);
 161     if (!m_pImpl->rFormComponent.is())
 162         return false;
 163
 164     uno::Reference<beans::XPropertySet> xPropSet(xInterface, uno::UNO_QUERY);
 165
 166     sal_uInt32 nCheckBoxHeight = 16 * m_pFFData->getCheckboxHeight();
 167
 168     if (m_pFFData->getCheckboxAutoHeight())
 169     {
 170         uno::Reference<beans::XPropertySet> xTextRangeProps(xTextRange, uno::UNO_QUERY);
 171
 172         try
 173         {
 174             float fCheckBoxHeight = 0.0;
 175             xTextRangeProps->getPropertyValue("CharHeight") >>= fCheckBoxHeight;
 176             nCheckBoxHeight = static_cast<sal_uInt32>(floor(fCheckBoxHeight * 35.3));
 177         }
 178         catch (beans::UnknownPropertyException &)
 179         {
 180         }
 181     }
 182
 183     m_pImpl->aSize.Width = nCheckBoxHeight;
 184     m_pImpl->aSize.Height = m_pImpl->aSize.Width;
 185
 186     uno::Any aAny;
 187     if (!m_pFFData->getStatusText().isEmpty())
 188     {
 189         aAny <<= m_pFFData->getStatusText();
 190
 191         xPropSet->setPropertyValue("HelpText", aAny);
 192     }
 193
 194     aAny <<= m_pFFData->getCheckboxChecked();
 195     xPropSet->setPropertyValue("DefaultState", aAny);
 196
 197     if (!m_pFFData->getHelpText().isEmpty())
 198     {
 199         aAny <<= m_pFFData->getHelpText();
 200         xPropSet->setPropertyValue("HelpF1Text", aAny);
 201     }
 202
 203     aAny <<= rControlName;
 204     xPropSet->setPropertyValue("Name", aAny);
 205
 206     return true;
 207 }
 208
 209 bool FormControlHelper::processField(uno::Reference<text::XFormField> xFormField)
 210 {
 211     bool bRes = true;
 212     uno::Reference<container::XNameContainer> xNameCont = xFormField->getParameters();
 213     uno::Reference<container::XNamed> xNamed( xFormField, uno::UNO_QUERY );
 214     if ( m_pFFData && xNamed.is() && xNameCont.is() )
 215     {
 216
 217         if (m_pImpl->m_eFieldId == FIELD_FORMTEXT )
 218         {
 219             xFormField->setFieldType(ODF_FORMTEXT);
 220             if (  !m_pFFData->getName().isEmpty() )
 221             {
 222                 xNamed->setName( m_pFFData->getName() );
 223             }
 224         }
 225         else if (m_pImpl->m_eFieldId == FIELD_FORMCHECKBOX )
 226         {
 227             xFormField->setFieldType(ODF_FORMCHECKBOX);
 228             uno::Reference<beans::XPropertySet> xPropSet(xFormField, uno::UNO_QUERY);
 229             uno::Any aAny;
 230             aAny <<= m_pFFData->getCheckboxChecked();
 231             if ( xPropSet.is() )
 232                 xPropSet->setPropertyValue("Checked", aAny);
 233         }
 234         else if (m_pImpl->m_eFieldId == FIELD_FORMDROPDOWN )
 235         {
 236             xFormField->setFieldType(ODF_FORMDROPDOWN);
 237             uno::Sequence< OUString > sItems;
 238             sItems.realloc( m_pFFData->getDropDownEntries().size() );
 239             ::std::copy( m_pFFData->getDropDownEntries().begin(), m_pFFData->getDropDownEntries().end(), sItems.begin());
 240             if ( sItems.getLength() )
 241             {
 242                 if ( xNameCont->hasByName(ODF_FORMDROPDOWN_LISTENTRY) )
 243                     xNameCont->replaceByName(ODF_FORMDROPDOWN_LISTENTRY, uno::makeAny( sItems ) );
 244                 else
 245                     xNameCont->insertByName(ODF_FORMDROPDOWN_LISTENTRY, uno::makeAny( sItems ) );
 246
 247                 sal_Int32 nResult = m_pFFData->getDropDownResult().toInt32();
 248                 if ( nResult )
 249                 {
 250                     if ( xNameCont->hasByName(ODF_FORMDROPDOWN_RESULT) )
 251                         xNameCont->replaceByName(ODF_FORMDROPDOWN_RESULT, uno::makeAny( nResult ) );
 252                     else
 253                         xNameCont->insertByName(ODF_FORMDROPDOWN_RESULT, uno::makeAny( nResult ) );
 254                 }
 255             }
 256         }
 257     }
 258     else
 259         bRes = false;
 260     return bRes;
 261 }
 262
 263 bool FormControlHelper::insertControl(uno::Reference<text::XTextRange> xTextRange)
 264 {
 265     bool bCreated = false;
 266     if ( !m_pFFData )
 267         return false;
 268     uno::Reference<container::XNameContainer> xFormCompsByName(m_pImpl->getForm(), uno::UNO_QUERY);
 269     uno::Reference<container::XIndexContainer> xFormComps(m_pImpl->getFormComps());
 270     if (! xFormComps.is())
 271         return false;
 272
 273     static OUString sControl("Control");
 274
 275     sal_Int32 nControl = 0;
 276     bool bDone = false;
 277     OUString sControlName;
 278
 279     do
 280     {
 281         OUString sTmp(sControl);
 282         sTmp += OUString::number(nControl);
 283
 284         nControl++;
 285         if (! xFormCompsByName->hasByName(sTmp))
 286         {
 287             sControlName = sTmp;
 288             bDone = true;
 289         }
 290     }
 291     while (! bDone);
 292
 293     switch (m_pImpl->m_eFieldId)
 294     {
 295     case FIELD_FORMCHECKBOX:
 296         bCreated = createCheckbox(xTextRange, sControlName);
 297         break;
 298     default:
 299         break;
 300     }
 301
 302     if (!bCreated)
 303         return false;
 304
 305     uno::Any aAny(m_pImpl->rFormComponent);
 306     xFormComps->insertByIndex(xFormComps->getCount(), aAny);
 307
 308     if (! m_pImpl->getServiceFactory().is())
 309         return false;
 310
 311     uno::Reference<uno::XInterface> xInterface = m_pImpl->getServiceFactory()->createInstance("com.sun.star.drawing.ControlShape");
 312
 313     if (! xInterface.is())
 314         return false;
 315
 316     uno::Reference<drawing::XShape> xShape(xInterface, uno::UNO_QUERY);
 317
 318     if (! xShape.is())
 319         return false;
 320
 321     xShape->setSize(m_pImpl->aSize);
 322
 323     uno::Reference<beans::XPropertySet> xShapeProps(xShape, uno::UNO_QUERY);
 324
 325     sal_uInt16 nTmp = text::TextContentAnchorType_AS_CHARACTER;
 326     aAny <<= nTmp;
 327
 328     xShapeProps->setPropertyValue("AnchorType", aAny);
 329
 330     nTmp = text::VertOrientation::CENTER;
 331     aAny <<= nTmp;
 332     xShapeProps->setPropertyValue("VertOrient", aAny);
 333
 334     aAny <<= xTextRange;
 335
 336     xShapeProps->setPropertyValue("TextRange", aAny);
 337
 338     uno::Reference<drawing::XControlShape> xControlShape(xShape, uno::UNO_QUERY);
 339     uno::Reference<awt::XControlModel> xControlModel(m_pImpl->rFormComponent, uno::UNO_QUERY);
 340     xControlShape->setControl(xControlModel);
 341
 342     m_pImpl->getDrawPage()->add(xShape);
 343
 344     return true;
 345 }
 346
 347 }}
 348
 349 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */