LibreOffice Module reportdesign (master)  1
GeometryHandler.hxx
Go to the documentation of this file.
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>
43 
44 
45 namespace rptui
46 {
47 
48 
50  {
51  css::beans::Optional< OUString> m_sInitialFormula;
52  OUString m_sName;
53  OUString m_sSearchString;
54  OUString m_sFormula;
56 
57  const OUString& getName() const { return m_sName; }
58  } ;
59 
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
66  typedef ::cppu::WeakComponentImplHelper< css::inspection::XPropertyHandler
67  , css::beans::XPropertyChangeListener
68  , css::lang::XServiceInfo> GeometryHandler_Base;
69 
71  private ::cppu::BaseMutex,
72  public GeometryHandler_Base
73  {
78 
87  bool impl_dialogFilter_nothrow( OUString& _out_rSelectedClause, ::osl::ClearableMutexGuard& _rClearBeforeDialog ) const;
88 
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 
125  void impl_createFunction(const OUString& _sFunctionName,std::u16string_view _sDataField,const DefaultFunction& _aFunction);
126 
133  bool impl_isCounterFunction_throw(const OUString& _sQuotedFunctionName,OUString& Out_sScope) const;
134 
142  void resetOwnProperties(::osl::ResettableMutexGuard& _aGuard,const OUString& _sOldFunctionName,const OUString& _sOldScope,const sal_uInt32 _nOldDataFieldType);
143 
149  bool impl_isDataField(const OUString& _sName) const;
150 
155  void impl_fillFormulaList_nothrow(::std::vector< OUString >& _out_rList) const;
156 
161  void impl_fillScopeList_nothrow(::std::vector< OUString >& _out_rList) const;
162 
167  void impl_fillMimeTypes_nothrow(::std::vector< OUString >& _out_rList) const;
168 
173  OUString impl_ConvertMimeTypeToUI_nothrow(const OUString& _sMimetype) const;
174 
179  OUString impl_ConvertUIToMimeType_nothrow(const OUString& _sUIName) const;
180 
186  css::uno::Reference< css::report::XFunctionsSupplier> fillScope_throw(OUString& _rsNamePostfix);
187 
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 
208  bool impl_isDefaultFunction_nothrow( const css::uno::Reference< css::report::XFunction>& _xFunction
209  ,OUString& _rDataField
210  ,OUString& _rsDefaultFunctionName) const;
211 
215  void loadDefaultFunctions();
216 
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 
285  css::uno::Sequence< OUString > m_aFieldNames;
286  css::uno::Sequence< OUString > m_aParamNames;
287  TFunctions m_aFunctionNames;
288  ::std::vector< DefaultFunction > m_aDefaultFunctions;
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;
293  css::uno::Reference< css::beans::XPropertySet > m_xReportComponent;
294  mutable css::uno::Reference< css::sdbc::XRowSet > m_xRowSet;
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: */
bool impl_isDataField(const OUString &_sName) const
checks whether the name is a field or a parameter
OUString impl_ConvertMimeTypeToUI_nothrow(const OUString &_sMimetype) const
return the one supported output formats of the report definition
virtual sal_Bool SAL_CALL supportsService(const OUString &ServiceName) override
void createDefaultFunction(::osl::ResettableMutexGuard &_aGuard, const OUString &_sFunction, std::u16string_view _sDataField)
creates a default function of the _sFunction for the data field _sDataField The new function will onl...
sal_uInt32 impl_getDataFieldType_throw(const OUString &_sDataField=OUString()) const
returns the data field type depending on the data field of the report control
virtual css::uno::Sequence< OUString > SAL_CALL getActuatingProperties() override
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
::comphelper::OSimpleListenerContainer< css::beans::XPropertyChangeListener, css::beans::PropertyChangeEvent > PropertyChangeListeners
::std::pair< css::uno::Reference< css::report::XFunction >, css::uno::Reference< css::report::XFunctionsSupplier > > TFunctionPair
bool impl_isDefaultFunction_nothrow(const css::uno::Reference< css::report::XFunction > &_xFunction, OUString &_rDataField, OUString &_rsDefaultFunctionName) const
checks if the given function is a default function we know.
css::uno::Reference< css::report::XFunction > m_xFunction
void checkPosAndSize(const css::awt::Point &_aNewPos, const css::awt::Size &_aSize)
virtual void SAL_CALL propertyChange(const css::beans::PropertyChangeEvent &evt) override
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
css::beans::Property getProperty(const OUString &PropertyName)
virtual void SAL_CALL addPropertyChangeListener(const css::uno::Reference< css::beans::XPropertyChangeListener > &Listener) override
css::uno::Reference< css::inspection::XPropertyHandler > m_xFormComponentHandler
OUString impl_convertToFormula(const css::uno::Any &_rControlValue)
void operator=(GeometryHandler const &)=delete
css::uno::Any getConstantValue(bool bToControlValue, const TranslateId *pResId, const css::uno::Any &_aValue, const OUString &_sConstantName, const OUString &PropertyName)
bool impl_isCounterFunction_throw(const OUString &_sQuotedFunctionName, OUString &Out_sScope) const
check whether the given function name is a counter function.
virtual ~GeometryHandler() override
css::uno::Reference< css::uno::XComponentContext > m_xContext
void loadDefaultFunctions()
fills the member m_aDefaultFunctions
virtual css::uno::Any SAL_CALL getPropertyValue(const OUString &PropertyName) override
void resetOwnProperties(::osl::ResettableMutexGuard &_aGuard, const OUString &_sOldFunctionName, const OUString &_sOldScope, const sal_uInt32 _nOldDataFieldType)
clear the own properties like function and scope and send a notification
css::uno::Reference< css::sdbc::XRowSet > m_xRowSet
inspectee
::std::pair< MetaAction *, int > Component
void impl_setCounterFunction_throw()
sets the counter function at the data field.
virtual OUString SAL_CALL getImplementationName() override
virtual sal_Bool SAL_CALL isComposable(const OUString &PropertyName) override
OUString impl_ConvertUIToMimeType_nothrow(const OUString &_sUIName) const
return the MimeType for the given UI Name
virtual void SAL_CALL setPropertyValue(const OUString &PropertyName, const css::uno::Any &Value) override
const OUString & getName() const
DefaultFunction m_aCounterFunction
css::uno::Reference< css::beans::XPropertySet > m_xReportComponent
delegatee
virtual void SAL_CALL addEventListener(const css::uno::Reference< css::lang::XEventListener > &xListener) override
bool impl_dialogFilter_nothrow(OUString &_out_rSelectedClause,::osl::ClearableMutexGuard &_rClearBeforeDialog) const
executes a dialog for choosing a filter criterion for a database report
PropertyChangeListeners m_aPropertyListeners
unsigned char sal_Bool
::std::vector< DefaultFunction > m_aDefaultFunctions
void impl_initFieldList_nothrow(css::uno::Sequence< OUString > &_rFieldNames) const
css::uno::Reference< css::script::XTypeConverter > m_xTypeConverter
type converter, needed on various occasions
virtual void SAL_CALL inspect(const css::uno::Reference< css::uno::XInterface > &Component) override
::cppu::WeakComponentImplHelper< css::inspection::XPropertyHandler, css::beans::XPropertyChangeListener, css::lang::XServiceInfo > GeometryHandler_Base
virtual css::uno::Sequence< OUString > SAL_CALL getSupersededProperties() override
virtual css::beans::PropertyState SAL_CALL getPropertyState(const OUString &PropertyName) override
void impl_fillFormulaList_nothrow(::std::vector< OUString > &_out_rList) const
return all formula in a semicolon separated list
static void implCreateListLikeControl(const css::uno::Reference< css::inspection::XPropertyControlFactory > &_rxControlFactory, css::inspection::LineDescriptor &out_Descriptor, const TranslateId *pResId, bool _bReadOnlyControl, bool _bTrueIfListBoxFalseIfComboBox)
void impl_fillMimeTypes_nothrow(::std::vector< OUString > &_out_rList) const
return all supported output formats of the report definition
virtual css::uno::Sequence< css::beans::Property > SAL_CALL getSupportedProperties() override
virtual void SAL_CALL disposing() override
virtual void SAL_CALL removePropertyChangeListener(const css::uno::Reference< css::beans::XPropertyChangeListener > &_rxListener) override
virtual css::uno::Any SAL_CALL convertToControlValue(const OUString &PropertyName, const css::uno::Any &PropertyValue, const css::uno::Type &ControlValueType) override
virtual css::inspection::LineDescriptor SAL_CALL describePropertyLine(const OUString &PropertyName, const css::uno::Reference< css::inspection::XPropertyControlFactory > &ControlFactory) override
void impl_fillScopeList_nothrow(::std::vector< OUString > &_out_rList) const
return all group names in a semicolon separated list starting with the group where this control is co...
bool isDefaultFunction(const OUString &_sQuotedFunction, OUString &Out_rDataField, const css::uno::Reference< css::report::XFunctionsSupplier > &_xFunctionsSupplier=css::uno::Reference< css::report::XFunctionsSupplier >(), bool _bSet=false) const
checks if the given function is a default function we know.
virtual void SAL_CALL removeEventListener(const css::uno::Reference< css::lang::XEventListener > &aListener) override
css::uno::Sequence< OUString > m_aFieldNames
void impl_createFunction(const OUString &_sFunctionName, std::u16string_view _sDataField, const DefaultFunction &_aFunction)
Creates the function defined by the function template.
virtual css::uno::Any SAL_CALL convertToPropertyValue(const OUString &PropertyName, const css::uno::Any &ControlValue) override
GeometryHandler(css::uno::Reference< css::uno::XComponentContext > const &context)
css::uno::Reference< css::report::XFunctionsSupplier > fillScope_throw(OUString &_rsNamePostfix)
get the functions supplier for the set scope, default is the surrounding group.
css::beans::Optional< OUString > m_sInitialFormula
virtual sal_Bool SAL_CALL suspend(sal_Bool Suspend) override
css::uno::Sequence< OUString > m_aParamNames
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override
::std::multimap< OUString, TFunctionPair,::comphelper::UStringMixLess > TFunctions