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>
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
43
44
45namespace rptui
46{
47
48
50 {
51 css::beans::Optional< OUString> m_sInitialFormula;
52 OUString m_sName;
54 OUString m_sFormula;
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::OInterfaceContainerHelper3< css::beans::XPropertyChangeListener > PropertyChangeListeners;
64 typedef ::cppu::WeakComponentImplHelper< css::inspection::XPropertyHandler
65 , css::beans::XPropertyChangeListener
66 , css::lang::XServiceInfo> GeometryHandler_Base;
67
69 private ::cppu::BaseMutex,
71 {
76
85 bool impl_dialogFilter_nothrow( OUString& _out_rSelectedClause, ::osl::ClearableMutexGuard& _rClearBeforeDialog ) const;
86
92 sal_uInt32 impl_getDataFieldType_throw(const OUString& _sDataField = OUString()) const;
93
94 css::uno::Any getConstantValue(bool bToControlValue,const TranslateId* pResId,const css::uno::Any& _aValue,const OUString& _sConstantName,const OUString & PropertyName );
95 css::beans::Property getProperty(const OUString & PropertyName);
97 const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory
98 ,css::inspection::LineDescriptor & out_Descriptor
99 ,const TranslateId* pResId
100 ,bool _bReadOnlyControl
101 ,bool _bTrueIfListBoxFalseIfComboBox
102 );
104 const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory
105 ,css::inspection::LineDescriptor & out_Descriptor
106 ,const ::std::vector< OUString>& _aEntries
107 ,bool _bReadOnlyControl
108 ,bool _bTrueIfListBoxFalseIfComboBox
109 );
110 void checkPosAndSize( const css::awt::Point& _aNewPos,
111 const css::awt::Size& _aSize);
112
113 OUString impl_convertToFormula( const css::uno::Any& _rControlValue );
114
115 void impl_initFieldList_nothrow( css::uno::Sequence< OUString >& _rFieldNames ) const;
116
123 void impl_createFunction(const OUString& _sFunctionName,std::u16string_view _sDataField,const DefaultFunction& _aFunction);
124
131 bool impl_isCounterFunction_throw(const OUString& _sQuotedFunctionName,OUString& Out_sScope) const;
132
140 void resetOwnProperties(::osl::ResettableMutexGuard& _aGuard,const OUString& _sOldFunctionName,const OUString& _sOldScope,const sal_uInt32 _nOldDataFieldType);
141
147 bool impl_isDataField(const OUString& _sName) const;
148
153 void impl_fillFormulaList_nothrow(::std::vector< OUString >& _out_rList) const;
154
159 void impl_fillScopeList_nothrow(::std::vector< OUString >& _out_rList) const;
160
165 void impl_fillMimeTypes_nothrow(::std::vector< OUString >& _out_rList) const;
166
171 OUString impl_ConvertMimeTypeToUI_nothrow(const OUString& _sMimetype) const;
172
177 OUString impl_ConvertUIToMimeType_nothrow(const OUString& _sUIName) const;
178
184 css::uno::Reference< css::report::XFunctionsSupplier> fillScope_throw(OUString& _rsNamePostfix);
185
194 bool isDefaultFunction(const OUString& _sQuotedFunction
195 ,OUString& Out_rDataField
196 ,const css::uno::Reference< css::report::XFunctionsSupplier>& _xFunctionsSupplier = css::uno::Reference< css::report::XFunctionsSupplier>()
197 ,bool _bSet = false) const;
198
206 bool impl_isDefaultFunction_nothrow( const css::uno::Reference< css::report::XFunction>& _xFunction
207 ,OUString& _rDataField
208 ,OUString& _rsDefaultFunctionName) const;
209
214
222 void createDefaultFunction(::osl::ResettableMutexGuard& _aGuard ,const OUString& _sFunction,std::u16string_view _sDataField);
223
224 void removeFunction();
225
227 {
228 bool& m_bIn;
229 public:
230 OBlocker(bool& _bIn) : m_bIn(_bIn){ m_bIn = true; }
231 ~OBlocker() { m_bIn = false; }
232 };
233
234
235 // XEventListener
236 virtual void SAL_CALL disposing(const css::lang::EventObject& Source) override;
237 // XPropertyChangeListener
238 virtual void SAL_CALL propertyChange(const css::beans::PropertyChangeEvent& evt) override;
239
240 public:
241 explicit GeometryHandler(css::uno::Reference< css::uno::XComponentContext > const & context);
242
243 // XServiceInfo
244 virtual OUString SAL_CALL getImplementationName( ) override;
245 virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
246 virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames( ) override;
247
248 // css::lang::XComponent:
249 virtual void SAL_CALL addEventListener(const css::uno::Reference< css::lang::XEventListener > & xListener) override;
250 virtual void SAL_CALL removeEventListener(const css::uno::Reference< css::lang::XEventListener > & aListener) override;
251
252 // css::inspection::XPropertyHandler:
253 virtual void SAL_CALL inspect(const css::uno::Reference< css::uno::XInterface > & Component) override;
254 virtual css::uno::Any SAL_CALL getPropertyValue(const OUString & PropertyName) override;
255 virtual void SAL_CALL setPropertyValue(const OUString & PropertyName, const css::uno::Any & Value) override;
256 virtual css::beans::PropertyState SAL_CALL getPropertyState(const OUString & PropertyName) override;
257 virtual css::inspection::LineDescriptor SAL_CALL describePropertyLine(const OUString& PropertyName, const css::uno::Reference< css::inspection::XPropertyControlFactory >& ControlFactory ) override;
258 virtual css::uno::Any SAL_CALL convertToPropertyValue(const OUString & PropertyName, const css::uno::Any & ControlValue) override;
259 virtual css::uno::Any SAL_CALL convertToControlValue(const OUString & PropertyName, const css::uno::Any & PropertyValue, const css::uno::Type & ControlValueType) override;
260 virtual void SAL_CALL addPropertyChangeListener(const css::uno::Reference< css::beans::XPropertyChangeListener > & Listener) override;
261 virtual void SAL_CALL removePropertyChangeListener(const css::uno::Reference< css::beans::XPropertyChangeListener > & _rxListener) override;
262 virtual css::uno::Sequence< css::beans::Property > SAL_CALL getSupportedProperties() override;
263 virtual css::uno::Sequence< OUString > SAL_CALL getSupersededProperties() override;
264 virtual css::uno::Sequence< OUString > SAL_CALL getActuatingProperties() override;
265 virtual sal_Bool SAL_CALL isComposable(const OUString & PropertyName) override;
266 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;
267 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;
268 virtual sal_Bool SAL_CALL suspend(sal_Bool Suspend) override;
269
270 protected:
271 virtual ~GeometryHandler() override;
272 private:
274 void operator =(GeometryHandler const &) = delete;
275
276 // override WeakComponentImplHelperBase::disposing()
277 // This function is called upon disposing the component,
278 // if your component needs special work when it becomes
279 // disposed, do it here.
280 virtual void SAL_CALL disposing() override;
281
283 css::uno::Sequence< OUString > m_aFieldNames;
284 css::uno::Sequence< OUString > m_aParamNames;
286 ::std::vector< DefaultFunction > m_aDefaultFunctions;
288 css::uno::Reference< css::uno::XComponentContext > m_xContext;
289 mutable css::uno::Reference< css::report::XFunction> m_xFunction;
290 css::uno::Reference< css::inspection::XPropertyHandler > m_xFormComponentHandler;
291 css::uno::Reference< css::beans::XPropertySet > m_xReportComponent;
292 mutable css::uno::Reference< css::sdbc::XRowSet > m_xRowSet;
294 css::uno::Reference< css::script::XTypeConverter > m_xTypeConverter;
295 mutable OUString m_sDefaultFunction;
296 mutable OUString m_sScope;
298 mutable bool m_bNewFunction;
299 bool m_bIn;
300 };
301
302} // namespace rptui
303
304
305#endif // RPT_GeometryHandler_HXX
306
307/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
void impl_initFieldList_nothrow(css::uno::Sequence< OUString > &_rFieldNames) const
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...
bool impl_isDataField(const OUString &_sName) const
checks whether the name is a field or a parameter
void impl_fillFormulaList_nothrow(::std::vector< OUString > &_out_rList) const
return all formula in a semicolon separated list
virtual void SAL_CALL disposing() override
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.
css::uno::Sequence< OUString > m_aParamNames
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override
void loadDefaultFunctions()
fills the member m_aDefaultFunctions
virtual css::uno::Sequence< OUString > SAL_CALL getSupersededProperties() override
css::uno::Reference< css::report::XFunctionsSupplier > fillScope_throw(OUString &_rsNamePostfix)
get the functions supplier for the set scope, default is the surrounding group.
virtual void SAL_CALL addEventListener(const css::uno::Reference< css::lang::XEventListener > &xListener) override
bool impl_isCounterFunction_throw(const OUString &_sQuotedFunctionName, OUString &Out_sScope) const
check whether the given function name is a counter function.
virtual void SAL_CALL disposing(const css::lang::EventObject &Source) override
virtual sal_Bool SAL_CALL supportsService(const OUString &ServiceName) override
bool impl_dialogFilter_nothrow(OUString &_out_rSelectedClause, ::osl::ClearableMutexGuard &_rClearBeforeDialog) const
executes a dialog for choosing a filter criterion for a database report
virtual OUString SAL_CALL getImplementationName() override
virtual sal_Bool SAL_CALL suspend(sal_Bool Suspend) override
virtual void SAL_CALL setPropertyValue(const OUString &PropertyName, const css::uno::Any &Value) override
virtual ~GeometryHandler() override
virtual css::uno::Any SAL_CALL getPropertyValue(const OUString &PropertyName) override
void operator=(GeometryHandler const &)=delete
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
virtual css::inspection::LineDescriptor SAL_CALL describePropertyLine(const OUString &PropertyName, const css::uno::Reference< css::inspection::XPropertyControlFactory > &ControlFactory) override
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::sdbc::XRowSet > m_xRowSet
inspectee
void impl_createFunction(const OUString &_sFunctionName, std::u16string_view _sDataField, const DefaultFunction &_aFunction)
Creates the function defined by the function template.
static void implCreateListLikeControl(const css::uno::Reference< css::inspection::XPropertyControlFactory > &_rxControlFactory, css::inspection::LineDescriptor &out_Descriptor, const ::std::vector< OUString > &_aEntries, bool _bReadOnlyControl, bool _bTrueIfListBoxFalseIfComboBox)
PropertyChangeListeners m_aPropertyListeners
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
::std::vector< DefaultFunction > m_aDefaultFunctions
css::beans::Property getProperty(const OUString &PropertyName)
css::uno::Reference< css::inspection::XPropertyHandler > m_xFormComponentHandler
virtual void SAL_CALL removeEventListener(const css::uno::Reference< css::lang::XEventListener > &aListener) override
virtual void SAL_CALL propertyChange(const css::beans::PropertyChangeEvent &evt) override
OUString impl_ConvertUIToMimeType_nothrow(const OUString &_sUIName) const
return the MimeType for the given UI Name
virtual sal_Bool SAL_CALL isComposable(const OUString &PropertyName) override
void impl_fillMimeTypes_nothrow(::std::vector< OUString > &_out_rList) const
return all supported output formats of the report definition
GeometryHandler(css::uno::Reference< css::uno::XComponentContext > const &context)
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...
virtual void SAL_CALL inspect(const css::uno::Reference< css::uno::XInterface > &Component) override
GeometryHandler(GeometryHandler const &)=delete
virtual css::uno::Sequence< css::beans::Property > SAL_CALL getSupportedProperties() override
virtual css::uno::Sequence< OUString > SAL_CALL getActuatingProperties() override
static void implCreateListLikeControl(const css::uno::Reference< css::inspection::XPropertyControlFactory > &_rxControlFactory, css::inspection::LineDescriptor &out_Descriptor, const TranslateId *pResId, bool _bReadOnlyControl, bool _bTrueIfListBoxFalseIfComboBox)
css::uno::Reference< css::beans::XPropertySet > m_xReportComponent
delegatee
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
OUString impl_convertToFormula(const css::uno::Any &_rControlValue)
css::uno::Sequence< OUString > m_aFieldNames
DefaultFunction m_aCounterFunction
OUString impl_ConvertMimeTypeToUI_nothrow(const OUString &_sMimetype) const
return the one supported output formats of the report definition
css::uno::Reference< css::report::XFunction > m_xFunction
css::uno::Reference< css::script::XTypeConverter > m_xTypeConverter
type converter, needed on various occasions
virtual css::uno::Any SAL_CALL convertToControlValue(const OUString &PropertyName, const css::uno::Any &PropertyValue, const css::uno::Type &ControlValueType) override
virtual css::beans::PropertyState SAL_CALL getPropertyState(const OUString &PropertyName) override
css::uno::Reference< css::uno::XComponentContext > m_xContext
virtual void SAL_CALL addPropertyChangeListener(const css::uno::Reference< css::beans::XPropertyChangeListener > &Listener) override
virtual void SAL_CALL removePropertyChangeListener(const css::uno::Reference< css::beans::XPropertyChangeListener > &_rxListener) override
sal_uInt32 impl_getDataFieldType_throw(const OUString &_sDataField=OUString()) const
returns the data field type depending on the data field of the report control
void impl_setCounterFunction_throw()
sets the counter function at the data field.
void checkPosAndSize(const css::awt::Point &_aNewPos, const css::awt::Size &_aSize)
virtual css::uno::Any SAL_CALL convertToPropertyValue(const OUString &PropertyName, const css::uno::Any &ControlValue) override
css::uno::Any getConstantValue(bool bToControlValue, const TranslateId *pResId, const css::uno::Any &_aValue, const OUString &_sConstantName, const OUString &PropertyName)
::std::multimap< OUString, TFunctionPair, ::comphelper::UStringMixLess > TFunctions
::cppu::WeakComponentImplHelper< css::inspection::XPropertyHandler, css::beans::XPropertyChangeListener, css::lang::XServiceInfo > GeometryHandler_Base
::std::pair< css::uno::Reference< css::report::XFunction >, css::uno::Reference< css::report::XFunctionsSupplier > > TFunctionPair
::comphelper::OInterfaceContainerHelper3< css::beans::XPropertyChangeListener > PropertyChangeListeners
css::beans::Optional< OUString > m_sInitialFormula
const OUString & getName() const
::std::pair< MetaAction *, int > Component
unsigned char sal_Bool