extensions/source/propctrlr/handlerhelper.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 "handlerhelper.hxx"
  21 #include <strings.hrc>
  22 #include <yesno.hrc>
  23 #include "modulepcr.hxx"
  24 #include "enumrepresentation.hxx"
  25 #include "formmetadata.hxx"
  26
  27 #include <com/sun/star/inspection/StringRepresentation.hpp>
  28 #include <com/sun/star/beans/PropertyAttribute.hpp>
  29 #include <com/sun/star/uno/XComponentContext.hpp>
  30 #include <com/sun/star/util/XModifiable.hpp>
  31 #include <com/sun/star/awt/XWindow.hpp>
  32 #include <com/sun/star/inspection/LineDescriptor.hpp>
  33 #include <com/sun/star/inspection/PropertyControlType.hpp>
  34 #include <com/sun/star/inspection/XStringListControl.hpp>
  35 #include <com/sun/star/inspection/XNumericControl.hpp>
  36 #include <tools/diagnose_ex.h>
  37 #include <toolkit/helper/vclunohelper.hxx>
  38 #include <vcl/svapp.hxx>
  39 #include <vcl/window.hxx>
  40
  41 #include <algorithm>
  42
  43
  44 namespace pcr
  45 {
  46
  47
  48     using namespace ::com::sun::star::uno;
  49     using namespace ::com::sun::star::lang;
  50     using namespace ::com::sun::star::awt;
  51     using namespace ::com::sun::star::util;
  52     using namespace ::com::sun::star::beans;
  53     using namespace ::com::sun::star::script;
  54     using namespace ::com::sun::star::inspection;
  55
  56
  57     //= PropertyHandlerHelper
  58
  59
  60     void PropertyHandlerHelper::describePropertyLine( const Property& _rProperty,
  61         LineDescriptor& /* [out] */ _out_rDescriptor, const Reference< XPropertyControlFactory >& _rxControlFactory )
  62     {
  63         // display the pure property name - no L10N
  64         _out_rDescriptor.DisplayName = _rProperty.Name;
  65
  66         OSL_PRECOND( _rxControlFactory.is(), "PropertyHandlerHelper::describePropertyLine: no factory -> no control!" );
  67         if ( !_rxControlFactory.is() )
  68             return;
  69
  70         bool bReadOnlyControl = requiresReadOnlyControl( _rProperty.Attributes );
  71
  72         // special handling for booleans (this will become a list)
  73         if ( _rProperty.Type.getTypeClass() == TypeClass_BOOLEAN )
  74         {
  75             _out_rDescriptor.Control = createListBoxControl(_rxControlFactory, RID_RSC_ENUM_YESNO, SAL_N_ELEMENTS(RID_RSC_ENUM_YESNO), bReadOnlyControl);
  76             return;
  77         }
  78
  79         sal_Int16 nControlType = PropertyControlType::TextField;
  80         switch ( _rProperty.Type.getTypeClass() )
  81         {
  82         case TypeClass_BYTE:
  83         case TypeClass_SHORT:
  84         case TypeClass_UNSIGNED_SHORT:
  85         case TypeClass_LONG:
  86         case TypeClass_UNSIGNED_LONG:
  87         case TypeClass_HYPER:
  88         case TypeClass_UNSIGNED_HYPER:
  89         case TypeClass_FLOAT:
  90         case TypeClass_DOUBLE:
  91             nControlType = PropertyControlType::NumericField;
  92             break;
  93
  94         case TypeClass_SEQUENCE:
  95             nControlType = PropertyControlType::StringListField;
  96             break;
  97
  98         default:
  99             OSL_FAIL( "PropertyHandlerHelper::describePropertyLine: don't know how to represent this at the UI!" );
 100             [[fallthrough]];
 101
 102         case TypeClass_STRING:
 103             nControlType = PropertyControlType::TextField;
 104             break;
 105         }
 106
 107         // create a control
 108         _out_rDescriptor.Control = _rxControlFactory->createPropertyControl( nControlType, bReadOnlyControl );
 109     }
 110
 111
 112     namespace
 113     {
 114         Reference< XPropertyControl > lcl_implCreateListLikeControl(
 115                 const Reference< XPropertyControlFactory >& _rxControlFactory,
 116                 const std::vector< OUString >& _rInitialListEntries,
 117                 bool _bReadOnlyControl,
 118                 bool _bSorted,
 119                 bool _bTrueIfListBoxFalseIfComboBox
 120             )
 121         {
 122             Reference< XStringListControl > xListControl(
 123                 _rxControlFactory->createPropertyControl(
 124                     _bTrueIfListBoxFalseIfComboBox ? PropertyControlType::ListBox : PropertyControlType::ComboBox, _bReadOnlyControl
 125                 ),
 126                 UNO_QUERY_THROW
 127             );
 128
 129             std::vector< OUString > aInitialEntries( _rInitialListEntries );
 130             if ( _bSorted )
 131                 std::sort( aInitialEntries.begin(), aInitialEntries.end() );
 132
 133             for (auto const& initialEntry : aInitialEntries)
 134                 xListControl->appendListEntry(initialEntry);
 135             return xListControl.get();
 136         }
 137     }
 138
 139     Reference< XPropertyControl > PropertyHandlerHelper::createListBoxControl( const Reference< XPropertyControlFactory >& _rxControlFactory,
 140                 const std::vector< OUString >& _rInitialListEntries, bool _bReadOnlyControl, bool _bSorted )
 141     {
 142         return lcl_implCreateListLikeControl(_rxControlFactory, _rInitialListEntries, _bReadOnlyControl, _bSorted, true);
 143     }
 144
 145     Reference< XPropertyControl > PropertyHandlerHelper::createListBoxControl( const Reference< XPropertyControlFactory >& _rxControlFactory,
 146                 const char** pTransIds, size_t nElements, bool _bReadOnlyControl )
 147     {
 148         std::vector<OUString> aInitialListEntries;
 149         for (size_t i = 0; i < nElements; ++i)
 150             aInitialListEntries.push_back(PcrRes(pTransIds[i]));
 151         return lcl_implCreateListLikeControl(_rxControlFactory, aInitialListEntries, _bReadOnlyControl, /*_bSorted*/false, true);
 152     }
 153
 154     Reference< XPropertyControl > PropertyHandlerHelper::createComboBoxControl( const Reference< XPropertyControlFactory >& _rxControlFactory,
 155                 const std::vector< OUString >& _rInitialListEntries, bool _bSorted )
 156     {
 157         return lcl_implCreateListLikeControl( _rxControlFactory, _rInitialListEntries, /*_bReadOnlyControl*/false, _bSorted, false );
 158     }
 159
 160
 161     Reference< XPropertyControl > PropertyHandlerHelper::createNumericControl( const Reference< XPropertyControlFactory >& _rxControlFactory,
 162             sal_Int16 _nDigits, const Optional< double >& _rMinValue, const Optional< double >& _rMaxValue )
 163     {
 164         Reference< XNumericControl > xNumericControl(
 165             _rxControlFactory->createPropertyControl( PropertyControlType::NumericField, /*_bReadOnlyControl*/false ),
 166             UNO_QUERY_THROW
 167         );
 168
 169         xNumericControl->setDecimalDigits( _nDigits );
 170         xNumericControl->setMinValue( _rMinValue );
 171         xNumericControl->setMaxValue( _rMaxValue );
 172
 173         return xNumericControl.get();
 174     }
 175
 176
 177     Any PropertyHandlerHelper::convertToPropertyValue( const Reference< XComponentContext >& _rxContext,const Reference< XTypeConverter >& _rxTypeConverter,
 178         const Property& _rProperty, const Any& _rControlValue )
 179     {
 180         Any aPropertyValue( _rControlValue );
 181         if ( !aPropertyValue.hasValue() )
 182             // NULL is converted to NULL
 183             return aPropertyValue;
 184
 185         if ( aPropertyValue.getValueType().equals( _rProperty.Type ) )
 186             // nothing to do, type is already as desired
 187             return aPropertyValue;
 188
 189         if ( _rControlValue.getValueType().getTypeClass() == TypeClass_STRING )
 190         {
 191             OUString sControlValue;
 192             _rControlValue >>= sControlValue;
 193
 194             Reference< XStringRepresentation > xConversionHelper = StringRepresentation::create( _rxContext,_rxTypeConverter );
 195             aPropertyValue = xConversionHelper->convertToPropertyValue( sControlValue, _rProperty.Type );
 196         }
 197         else
 198         {
 199             try
 200             {
 201                 if ( _rxTypeConverter.is() )
 202                     aPropertyValue = _rxTypeConverter->convertTo( _rControlValue, _rProperty.Type );
 203             }
 204             catch( const Exception& )
 205             {
 206                 OSL_FAIL( "PropertyHandlerHelper::convertToPropertyValue: caught an exception while converting via TypeConverter!" );
 207             }
 208         }
 209
 210         return aPropertyValue;
 211     }
 212
 213
 214     Any PropertyHandlerHelper::convertToControlValue( const Reference< XComponentContext >& _rxContext,const Reference< XTypeConverter >& _rxTypeConverter,
 215         const Any& _rPropertyValue, const Type& _rControlValueType )
 216     {
 217         Any aControlValue( _rPropertyValue );
 218         if ( !aControlValue.hasValue() )
 219             // NULL is converted to NULL
 220             return aControlValue;
 221
 222         if ( _rControlValueType.getTypeClass() == TypeClass_STRING )
 223         {
 224             Reference< XStringRepresentation > xConversionHelper = StringRepresentation::create( _rxContext,_rxTypeConverter );
 225             aControlValue <<= xConversionHelper->convertToControlValue( _rPropertyValue );
 226         }
 227         else
 228         {
 229             try
 230             {
 231                 if ( _rxTypeConverter.is() )
 232                     aControlValue = _rxTypeConverter->convertTo( _rPropertyValue, _rControlValueType );
 233             }
 234             catch( const Exception& )
 235             {
 236                 OSL_FAIL( "PropertyHandlerHelper::convertToControlValue: caught an exception while converting via TypeConverter!" );
 237             }
 238         }
 239
 240         return aControlValue;
 241     }
 242
 243
 244     void PropertyHandlerHelper::setContextDocumentModified( const Reference<XComponentContext> & _rContext )
 245     {
 246         try
 247         {
 248             Reference< XModifiable > xDocumentModifiable( getContextDocument_throw(_rContext), UNO_QUERY_THROW );
 249             xDocumentModifiable->setModified( true );
 250         }
 251         catch( const Exception& )
 252         {
 253             DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
 254         }
 255     }
 256
 257     Reference< XInterface > PropertyHandlerHelper::getContextDocument( const Reference<XComponentContext> & _rContext )
 258     {
 259         Reference< XInterface > xI;
 260         try
 261         {
 262             xI = getContextDocument_throw( _rContext );
 263         }
 264         catch( const Exception& )
 265         {
 266             OSL_FAIL( "PropertyHandler::getContextValueByName: caught an exception!" );
 267         }
 268         return xI;
 269     }
 270
 271     Reference< XInterface > PropertyHandlerHelper::getContextDocument_throw( const Reference<XComponentContext> & _rContext )
 272     {
 273         Reference< XInterface > xI;
 274         Any aReturn = _rContext->getValueByName( "ContextDocument" );
 275         aReturn >>= xI;
 276         return xI;
 277     }
 278
 279
 280     vcl::Window* PropertyHandlerHelper::getDialogParentWindow( const Reference<XComponentContext>& _rContext )
 281     {
 282         vcl::Window* pInspectorWindow = nullptr;
 283         try
 284         {
 285             Reference< XWindow > xInspectorWindow( _rContext->getValueByName( "DialogParentWindow" ), UNO_QUERY_THROW );
 286             pInspectorWindow = VCLUnoHelper::GetWindow( xInspectorWindow ).get();
 287         }
 288         catch( const Exception& )
 289         {
 290             DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
 291         }
 292         return pInspectorWindow;
 293     }
 294
 295     weld::Window* PropertyHandlerHelper::getDialogParentFrame(const Reference<XComponentContext>& _rContext)
 296     {
 297         weld::Window* pInspectorWindow = nullptr;
 298         try
 299         {
 300             Reference< XWindow > xInspectorWindow( _rContext->getValueByName( "DialogParentWindow" ), UNO_QUERY_THROW );
 301             pInspectorWindow = Application::GetFrameWeld(xInspectorWindow);
 302         }
 303         catch( const Exception& )
 304         {
 305             DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
 306         }
 307         return pInspectorWindow;
 308     }
 309 } // namespace pcr
 310
 311
 312 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */