reportdesign/source/ui/inc/GeometryHandler.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 #ifndef INCLUDED_REPORTDESIGN_SOURCE_UI_INC_GEOMETRYHANDLER_HXX
  21 #define INCLUDED_REPORTDESIGN_SOURCE_UI_INC_GEOMETRYHANDLER_HXX
  22
  23 #include <sal/config.h>
  24 #include <com/sun/star/uno/XComponentContext.hpp>
  25 #include <cppuhelper/compbase.hxx>
  26 #include <cppuhelper/basemutex.hxx>
  27 #include <com/sun/star/awt/Point.hpp>
  28 #include <com/sun/star/awt/Size.hpp>
  29 #include <com/sun/star/inspection/XPropertyHandler.hpp>
  30 #include <com/sun/star/script/XTypeConverter.hpp>
  31 #include <com/sun/star/beans/XPropertySet.hpp>
  32 #include <com/sun/star/lang/XServiceInfo.hpp>
  33 #include <com/sun/star/report/XFunctionsSupplier.hpp>
  34 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  35 #include <com/sun/star/sdbc/XRowSet.hpp>
  36 #include <unotools/resmgr.hxx>
  37 #include <map>
  38 #include <memory>
  39 #include <string_view>
  40
  41 #include <comphelper/stl_types.hxx>
  42 #include <comphelper/listenernotification.hxx>
  43
  44
  45 namespace rptui
  46 {
  47
  48
  49     struct DefaultFunction
  50     {
  51         css::beans::Optional< OUString>               m_sInitialFormula;
  52         OUString                                      m_sName;
  53         OUString                                      m_sSearchString;
  54         OUString                                      m_sFormula;
  55         bool                                          m_bPreEvaluated;
  56
  57         const OUString& getName() const { return m_sName; }
  58     } ;
  59
  60     class OPropertyInfoService;
  61     typedef ::std::pair< css::uno::Reference< css::report::XFunction>, css::uno::Reference< css::report::XFunctionsSupplier> > TFunctionPair;
  62     typedef ::std::multimap< OUString,TFunctionPair, ::comphelper::UStringMixLess > TFunctions;
  63     typedef ::comphelper::OSimpleListenerContainer  <   css::beans::XPropertyChangeListener
  64                                                     ,   css::beans::PropertyChangeEvent
  65                                                     >   PropertyChangeListeners;
  66     typedef ::cppu::WeakComponentImplHelper<   css::inspection::XPropertyHandler
  67                                             ,   css::beans::XPropertyChangeListener
  68                                             ,   css::lang::XServiceInfo> GeometryHandler_Base;
  69
  70     class GeometryHandler:
  71         private ::cppu::BaseMutex,
  72         public GeometryHandler_Base
  73     {
  74         /** sets the counter function at the data field.
  75         *   If the counter function doesn't exist it will be created.
  76         */
  77         void impl_setCounterFunction_throw();
  78
  79         /** executes a dialog for choosing a filter criterion for a database report
  80             @param _out_rSelectedClause
  81                 the filter or order clause as chosen by the user
  82             @precond
  83                 we're really inspecting a database form (well, a RowSet at least)
  84             @return
  85                 <TRUE/> if and only if the user successfully chose a clause
  86         */
  87         bool impl_dialogFilter_nothrow( OUString& _out_rSelectedClause, ::osl::ClearableMutexGuard& _rClearBeforeDialog ) const;
  88
  89         /** returns the data field type depending on the data field of the report control
  90         *
  91         * \param _sDataField if the data field is not empty it will be used as data field, otherwise the data field will be used.
  92         * \return the data field type
  93         */
  94         sal_uInt32 impl_getDataFieldType_throw(const OUString& _sDataField = OUString()) const;
  95
  96         css::uno::Any getConstantValue(bool bToControlValue,const TranslateId* pResId,const css::uno::Any& _aValue,const OUString& _sConstantName,const OUString & PropertyName );
  97         css::beans::Property getProperty(const OUString & PropertyName);
  98         static void implCreateListLikeControl(
  99                 const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory
 100                 ,css::inspection::LineDescriptor & out_Descriptor
 101                 ,const TranslateId* pResId
 102                 ,bool _bReadOnlyControl
 103                 ,bool _bTrueIfListBoxFalseIfComboBox
 104             );
 105         static void implCreateListLikeControl(
 106                 const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory
 107                 ,css::inspection::LineDescriptor & out_Descriptor
 108                 ,const ::std::vector< OUString>& _aEntries
 109                 ,bool _bReadOnlyControl
 110                 ,bool _bTrueIfListBoxFalseIfComboBox
 111             );
 112         void checkPosAndSize(   const css::awt::Point& _aNewPos,
 113                                 const css::awt::Size& _aSize);
 114
 115         OUString impl_convertToFormula( const css::uno::Any& _rControlValue );
 116
 117         void impl_initFieldList_nothrow( css::uno::Sequence< OUString >& _rFieldNames ) const;
 118
 119         /** Creates the function defined by the function template
 120         *
 121         * \param _sFunctionName the function name
 122         * \param _sDataField the data field
 123         * \param _aFunction the function template
 124         */
 125         void impl_createFunction(const OUString& _sFunctionName,std::u16string_view _sDataField,const DefaultFunction& _aFunction);
 126
 127         /** check whether the given function name is a counter function.
 128         *
 129         * \param _sQuotedFunctionName the quoted function name to check
 130         * \param Out_sScope the scope of the function
 131         * \return When true it is a counter functions otherwise false.
 132         */
 133         bool impl_isCounterFunction_throw(const OUString& _sQuotedFunctionName,OUString& Out_sScope) const;
 134
 135         /** clear the own properties like function and scope and send a notification
 136         *
 137         * \param _aGuard
 138         * \param _sOldFunctionName
 139         * \param _sOldScope
 140         * \param _nOldDataFieldType
 141         */
 142        void resetOwnProperties(::osl::ResettableMutexGuard& _aGuard,const OUString& _sOldFunctionName,const OUString& _sOldScope,const sal_uInt32 _nOldDataFieldType);
 143
 144         /** checks whether the name is a field or a parameter
 145         *
 146         * \param _sName the name to check
 147         * \return true when it is a field or parameter otherwise false
 148         */
 149         bool impl_isDataField(const OUString& _sName) const;
 150
 151         /**return all formula in a semicolon separated list
 152         *
 153         * \param _rList the localized function names
 154         */
 155         void impl_fillFormulaList_nothrow(::std::vector< OUString >& _out_rList) const;
 156
 157         /** return all group names in a semicolon separated list starting with the group where this control is contained in.
 158         *
 159         * \param _rList fills the list with all scope names.
 160         */
 161         void impl_fillScopeList_nothrow(::std::vector< OUString >& _out_rList) const;
 162
 163         /** return all supported output formats of the report definition
 164         *
 165         * \param _rList fills the list with all mime types
 166         */
 167         void impl_fillMimeTypes_nothrow(::std::vector< OUString >& _out_rList) const;
 168
 169         /** return the one supported output formats of the report definition
 170         *
 171         * \param _sMimetype the mimetype
 172         */
 173         OUString impl_ConvertMimeTypeToUI_nothrow(const OUString& _sMimetype) const;
 174
 175         /** return the MimeType for the given UI Name
 176         *
 177         * \param _sUIName the doc ui name
 178         */
 179         OUString impl_ConvertUIToMimeType_nothrow(const OUString& _sUIName) const;
 180
 181         /** get the functions supplier for the set scope, default is the surrounding group.
 182         *
 183         * \param _rsNamePostfix the name postfix which can be used when the scope as name part is needed
 184         * \return the function supplier
 185         */
 186         css::uno::Reference< css::report::XFunctionsSupplier> fillScope_throw(OUString& _rsNamePostfix);
 187
 188         /** checks if the given function is a default function we know.
 189         *
 190         * \param _sQuotedFunction the quoted function name
 191         * \param Out_rDataField the data field which is used in the function
 192         * \param _xFunctionsSupplier the function supplier to search or empty if not used
 193         * \param _bSet If set to sal_True than the m_sDefaultFunction and m_sScope vars will be set if successful.
 194         * \return sal_True with known otherwise sal_False
 195         */
 196         bool isDefaultFunction(const OUString& _sQuotedFunction
 197                                     ,OUString& Out_rDataField
 198                                     ,const css::uno::Reference< css::report::XFunctionsSupplier>& _xFunctionsSupplier = css::uno::Reference< css::report::XFunctionsSupplier>()
 199                                     ,bool _bSet = false) const;
 200
 201         /** checks if the given function is a default function we know.
 202         *
 203         * \param _xFunction
 204         * \param _rDataField
 205         * \param _rsDefaultFunctionName
 206         * \return
 207         */
 208         bool impl_isDefaultFunction_nothrow( const css::uno::Reference< css::report::XFunction>& _xFunction
 209                                             ,OUString& _rDataField
 210                                             ,OUString& _rsDefaultFunctionName) const;
 211
 212         /** fills the member m_aDefaultFunctions
 213         *
 214         */
 215         void loadDefaultFunctions();
 216
 217         /** creates a default function of the _sFunction for the data field _sDataField
 218         *   The new function will only be created if it didn't exist.
 219         *
 220         * \param _aGuard        Will be cleared, when a new function was created.
 221         * \param _sFunction     The name of the function.
 222         * \param _sDataField    The name of the data field.
 223         */
 224         void createDefaultFunction(::osl::ResettableMutexGuard& _aGuard ,const OUString& _sFunction,std::u16string_view _sDataField);
 225
 226         void removeFunction();
 227
 228         class OBlocker
 229         {
 230             bool& m_bIn;
 231         public:
 232             OBlocker(bool& _bIn) : m_bIn(_bIn){ m_bIn = true; }
 233             ~OBlocker() { m_bIn = false; }
 234         };
 235
 236
 237         // XEventListener
 238         virtual void SAL_CALL disposing(const css::lang::EventObject& Source) override;
 239         // XPropertyChangeListener
 240         virtual void SAL_CALL propertyChange(const css::beans::PropertyChangeEvent& evt) override;
 241
 242     public:
 243         explicit GeometryHandler(css::uno::Reference< css::uno::XComponentContext > const & context);
 244
 245         // XServiceInfo
 246         virtual OUString SAL_CALL getImplementationName(  ) override;
 247         virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
 248         virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;
 249
 250         // css::lang::XComponent:
 251         virtual void SAL_CALL addEventListener(const css::uno::Reference< css::lang::XEventListener > & xListener) override;
 252         virtual void SAL_CALL removeEventListener(const css::uno::Reference< css::lang::XEventListener > & aListener) override;
 253
 254         // css::inspection::XPropertyHandler:
 255         virtual void SAL_CALL inspect(const css::uno::Reference< css::uno::XInterface > & Component) override;
 256         virtual css::uno::Any SAL_CALL getPropertyValue(const OUString & PropertyName) override;
 257         virtual void SAL_CALL setPropertyValue(const OUString & PropertyName, const css::uno::Any & Value) override;
 258         virtual css::beans::PropertyState SAL_CALL getPropertyState(const OUString & PropertyName) override;
 259         virtual css::inspection::LineDescriptor SAL_CALL describePropertyLine(const OUString& PropertyName, const css::uno::Reference< css::inspection::XPropertyControlFactory >& ControlFactory ) override;
 260         virtual css::uno::Any SAL_CALL convertToPropertyValue(const OUString & PropertyName, const css::uno::Any & ControlValue) override;
 261         virtual css::uno::Any SAL_CALL convertToControlValue(const OUString & PropertyName, const css::uno::Any & PropertyValue, const css::uno::Type & ControlValueType) override;
 262         virtual void SAL_CALL addPropertyChangeListener(const css::uno::Reference< css::beans::XPropertyChangeListener > & Listener) override;
 263         virtual void SAL_CALL removePropertyChangeListener(const css::uno::Reference< css::beans::XPropertyChangeListener > & _rxListener) override;
 264         virtual css::uno::Sequence< css::beans::Property > SAL_CALL getSupportedProperties() override;
 265         virtual css::uno::Sequence< OUString > SAL_CALL getSupersededProperties() override;
 266         virtual css::uno::Sequence< OUString > SAL_CALL getActuatingProperties() override;
 267         virtual sal_Bool SAL_CALL isComposable(const OUString & PropertyName) override;
 268         virtual css::inspection::InteractiveSelectionResult SAL_CALL onInteractivePropertySelection(const OUString & PropertyName, sal_Bool Primary, css::uno::Any & out_Data, const css::uno::Reference< css::inspection::XObjectInspectorUI > & InspectorUI) override;
 269         virtual void SAL_CALL actuatingPropertyChanged(const OUString & ActuatingPropertyName, const css::uno::Any & NewValue, const css::uno::Any & OldValue, const css::uno::Reference< css::inspection::XObjectInspectorUI > & InspectorUI, sal_Bool FirstTimeInit) override;
 270         virtual sal_Bool SAL_CALL suspend(sal_Bool Suspend) override;
 271
 272     protected:
 273         virtual ~GeometryHandler() override;
 274     private:
 275         GeometryHandler(GeometryHandler const &) = delete;
 276         void operator =(GeometryHandler const &) = delete;
 277
 278         // override WeakComponentImplHelperBase::disposing()
 279         // This function is called upon disposing the component,
 280         // if your component needs special work when it becomes
 281         // disposed, do it here.
 282         virtual void SAL_CALL disposing() override;
 283
 284         PropertyChangeListeners                                   m_aPropertyListeners;
 285         css::uno::Sequence< OUString >                            m_aFieldNames;
 286         css::uno::Sequence< OUString >                            m_aParamNames;
 287         TFunctions                                                m_aFunctionNames;
 288         ::std::vector< DefaultFunction >                          m_aDefaultFunctions;
 289         DefaultFunction                                           m_aCounterFunction;
 290         css::uno::Reference< css::uno::XComponentContext >        m_xContext;
 291         mutable css::uno::Reference< css::report::XFunction>      m_xFunction;
 292         css::uno::Reference< css::inspection::XPropertyHandler >  m_xFormComponentHandler; /// delegatee
 293         css::uno::Reference< css::beans::XPropertySet >           m_xReportComponent; /// inspectee
 294         mutable css::uno::Reference< css::sdbc::XRowSet >         m_xRowSet;
 295         /// type converter, needed on various occasions
 296         css::uno::Reference< css::script::XTypeConverter >        m_xTypeConverter;
 297         mutable OUString                                          m_sDefaultFunction;
 298         mutable OUString                                          m_sScope;
 299         sal_uInt32                                                m_nDataFieldType;
 300         mutable bool                                              m_bNewFunction;
 301         bool                                                      m_bIn;
 302     };
 303
 304 } // namespace rptui
 305
 306
 307 #endif // RPT_GeometryHandler_HXX
 308
 309 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */