default ->XPropertyHandler for all form components. More...

#include <formcomponenthandler.hxx>

Inheritance diagram for pcr::FormComponentPropertyHandler:

Collaboration diagram for pcr::FormComponentPropertyHandler:

Public Member Functions
	FormComponentPropertyHandler (const css::uno::Reference< css::uno::XComponentContext > &_rxContext)

virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL	getPropertySetInfo () override

Public Member Functions inherited from cppu::ImplHelper1< class Ifc1 >
virtual css::uno::Any SAL_CALL	queryInterface (css::uno::Type const &rType) SAL_OVERRIDE

virtual css::uno::Sequence< css::uno::Type > SAL_CALL	getTypes () SAL_OVERRIDE

virtual css::uno::Sequence< sal_Int8 > SAL_CALL	getImplementationId () SAL_OVERRIDE

Public Member Functions inherited from comphelper::OPropertyContainer
virtual	~OPropertyContainer ()

Public Member Functions inherited from comphelper::OPropertyArrayUsageHelper< class TYPE >
	OPropertyArrayUsageHelper ()

virtual	~OPropertyArrayUsageHelper ()

::cppu::IPropertyArrayHelper *	getArrayHelper ()

Protected Member Functions
virtual	~FormComponentPropertyHandler () override

virtual OUString SAL_CALL	getImplementationName () override

virtual css::uno::Sequence< OUString > SAL_CALL	getSupportedServiceNames () override

virtual ::cppu::IPropertyArrayHelper *	createArrayHelper () const override

virtual ::cppu::IPropertyArrayHelper &SAL_CALL	getInfoHelper () override

virtual css::uno::Any SAL_CALL	getPropertyValue (const OUString &_rPropertyName) override

virtual void SAL_CALL	setPropertyValue (const OUString &_rPropertyName, const css::uno::Any &_rValue) override

virtual css::uno::Any SAL_CALL	convertToPropertyValue (const OUString &_rPropertyName, const css::uno::Any &_rControlValue) override

virtual css::uno::Any SAL_CALL	convertToControlValue (const OUString &_rPropertyName, const css::uno::Any &_rPropertyValue, const css::uno::Type &_rControlValueType) override

virtual css::beans::PropertyState SAL_CALL	getPropertyState (const OUString &_rPropertyName) override

virtual void SAL_CALL	addPropertyChangeListener (const css::uno::Reference< css::beans::XPropertyChangeListener > &_rxListener) override

virtual void SAL_CALL	removePropertyChangeListener (const css::uno::Reference< css::beans::XPropertyChangeListener > &_rxListener) override

virtual css::uno::Sequence< OUString > SAL_CALL	getSupersededProperties () override

virtual css::uno::Sequence< OUString > SAL_CALL	getActuatingProperties () override

virtual css::inspection::LineDescriptor SAL_CALL	describePropertyLine (const OUString &_rPropertyName, const css::uno::Reference< css::inspection::XPropertyControlFactory > &_rxControlFactory) override

virtual css::inspection::InteractiveSelectionResult SAL_CALL	onInteractivePropertySelection (const OUString &_rPropertyName, sal_Bool _bPrimary, css::uno::Any &_rData, const css::uno::Reference< css::inspection::XObjectInspectorUI > &_rxInspectorUI) override

virtual void SAL_CALL	actuatingPropertyChanged (const OUString &_rActuatingPropertyName, const css::uno::Any &_rNewValue, const css::uno::Any &_rOldValue, const css::uno::Reference< css::inspection::XObjectInspectorUI > &_rxInspectorUI, sal_Bool _bFirstTimeInit) override

virtual sal_Bool SAL_CALL	suspend (sal_Bool _bSuspend) override

virtual void SAL_CALL	disposing () override

virtual css::uno::Sequence< css::beans::Property >	doDescribeSupportedProperties () const override

virtual void	onNewComponent () override
	called when XPropertyHandler::inspect has been called, and we thus have a new component to inspect More...

Protected Member Functions inherited from pcr::PropertyHandlerComponent
	PropertyHandlerComponent (const css::uno::Reference< css::uno::XComponentContext > &_rxContext)

virtual OUString SAL_CALL	getImplementationName () override=0

virtual sal_Bool SAL_CALL	supportsService (const OUString &ServiceName) final override

virtual css::uno::Sequence< OUString > SAL_CALL	getSupportedServiceNames () override=0

Protected Member Functions inherited from pcr::PropertyHandler
	PropertyHandler (const css::uno::Reference< css::uno::XComponentContext > &_rxContext)

virtual	~PropertyHandler () override

virtual void SAL_CALL	inspect (const css::uno::Reference< css::uno::XInterface > &_rxIntrospectee) override

virtual css::uno::Sequence< css::beans::Property > SAL_CALL	getSupportedProperties () override

virtual css::uno::Sequence< OUString > SAL_CALL	getSupersededProperties () override

virtual css::uno::Sequence< OUString > SAL_CALL	getActuatingProperties () override

virtual css::uno::Any SAL_CALL	convertToPropertyValue (const OUString &_rPropertyName, const css::uno::Any &_rControlValue) override

virtual css::uno::Any SAL_CALL	convertToControlValue (const OUString &_rPropertyName, const css::uno::Any &_rPropertyValue, const css::uno::Type &_rControlValueType) override

virtual css::beans::PropertyState SAL_CALL	getPropertyState (const OUString &_rPropertyName) override

virtual css::inspection::LineDescriptor SAL_CALL	describePropertyLine (const OUString &_rPropertyName, const css::uno::Reference< css::inspection::XPropertyControlFactory > &_rxControlFactory) override

virtual sal_Bool SAL_CALL	isComposable (const OUString &_rPropertyName) override

virtual css::inspection::InteractiveSelectionResult SAL_CALL	onInteractivePropertySelection (const OUString &_rPropertyName, sal_Bool _bPrimary, css::uno::Any &_rData, const css::uno::Reference< css::inspection::XObjectInspectorUI > &_rxInspectorUI) override

virtual void SAL_CALL	actuatingPropertyChanged (const OUString &_rActuatingPropertyName, const css::uno::Any &_rNewValue, const css::uno::Any &_rOldValue, const css::uno::Reference< css::inspection::XObjectInspectorUI > &_rxInspectorUI, sal_Bool _bFirstTimeInit) override

virtual void SAL_CALL	addPropertyChangeListener (const css::uno::Reference< css::beans::XPropertyChangeListener > &_rxListener) override

virtual void SAL_CALL	removePropertyChangeListener (const css::uno::Reference< css::beans::XPropertyChangeListener > &_rxListener) override

virtual sal_Bool SAL_CALL	suspend (sal_Bool _bSuspend) override

virtual void SAL_CALL	disposing () override

virtual css::uno::Sequence< css::beans::Property >	doDescribeSupportedProperties () const =0

virtual void	onNewComponent ()
	called when XPropertyHandler::inspect has been called, and we thus have a new component to inspect More...

void	firePropertyChange (const OUString &_rPropName, PropertyId _nPropId, const css::uno::Any &_rOldValue, const css::uno::Any &_rNewValue)
	fires the change in a property value to our listener (if any) More...

weld::Window *	impl_getDefaultDialogFrame_nothrow () const
	retrieves a window which can be used as parent for dialogs More...

PropertyId	impl_getPropertyId_throwUnknownProperty (const OUString &_rPropertyName) const
	retrieves the property id for a given property name More...

PropertyId	impl_getPropertyId_throwRuntime (const OUString &_rPropertyName) const
	retrieves the property id for a given property name More...

PropertyId	impl_getPropertyId_nothrow (const OUString &_rPropertyName) const
	retrieves the property id for a given property name More...

void	addStringPropertyDescription (std::vector< css::beans::Property > &_rProperties, const OUString &_rPropertyName) const
	adds a description for the given string property to the given property vector Most probably to be called from within getSupportedProperties More...

void	addInt32PropertyDescription (std::vector< css::beans::Property > &_rProperties, const OUString &_rPropertyName, sal_Int16 _nAttribs=0) const
	adds a description for the given int32 property to the given property vector More...

void	addInt16PropertyDescription (std::vector< css::beans::Property > &_rProperties, const OUString &_rPropertyName, sal_Int16 _nAttribs=0) const
	adds a description for the given int16 property to the given property vector More...

void	addDoublePropertyDescription (std::vector< css::beans::Property > &_rProperties, const OUString &_rPropertyName, sal_Int16 _nAttribs) const
	adds a description for the given double property to the given property vector More...

void	addDatePropertyDescription (std::vector< css::beans::Property > &_rProperties, const OUString &_rPropertyName, sal_Int16 _nAttribs) const
	adds a description for the given date property to the given property vector More...

void	addTimePropertyDescription (std::vector< css::beans::Property > &_rProperties, const OUString &_rPropertyName, sal_Int16 _nAttribs) const
	adds a description for the given time property to the given property vector More...

void	addDateTimePropertyDescription (std::vector< css::beans::Property > &_rProperties, const OUString &_rPropertyName, sal_Int16 _nAttribs) const
	adds a description for the given DateTime property to the given property vector More...

void	implAddPropertyDescription (std::vector< css::beans::Property > &_rProperties, const OUString &_rPropertyName, const css::uno::Type &_rType, sal_Int16 _nAttribs=0) const
	adds a Property, given by name only, to a given vector of Properties More...

const css::beans::Property *	impl_getPropertyFromId_nothrow (PropertyId _nPropId) const
	retrieves a property given by handle More...

const css::beans::Property &	impl_getPropertyFromId_throw (PropertyId _nPropId) const
	retrieves a property given by handle More...

bool	impl_isSupportedProperty_nothrow (PropertyId _nPropId) const
	determines whether a given property id is part of our supported properties More...

const css::beans::Property &	impl_getPropertyFromName_throw (const OUString &_rPropertyName) const
	retrieves a property given by name More...

OUString	impl_getPropertyNameFromId_nothrow (PropertyId _nPropId) const
	get the name of a property given by handle More...

css::uno::Reference< css::frame::XModel >	impl_getContextDocument_nothrow () const
	returns the value of the ContextDocument property in the ComponentContext which was used to create this handler. More...

void	impl_setContextDocumentModified_nothrow () const
	marks the context document as modified More...

bool	impl_componentHasProperty_throw (const OUString &_rPropName) const
	determines whether our component has a given property More...

sal_Int16	impl_getDocumentMeasurementUnit_throw () const
	determines the default measure unit for the document in which our component lives More...

Protected Member Functions inherited from cppu::ImplHelper1< class Ifc1 >
	~ImplHelper1 () SAL_NOEXCEPT

Protected Member Functions inherited from comphelper::OPropertyContainer
	OPropertyContainer (::cppu::OBroadcastHelper &_rBHelper)

virtual sal_Bool SAL_CALL	convertFastPropertyValue (css::uno::Any &rConvertedValue, css::uno::Any &rOldValue, sal_Int32 nHandle, const css::uno::Any &rValue) override

virtual void SAL_CALL	setFastPropertyValue_NoBroadcast (sal_Int32 nHandle, const css::uno::Any &rValue) override

virtual void SAL_CALL	getFastPropertyValue (css::uno::Any &rValue, sal_Int32 nHandle) const override

virtual css::uno::Any SAL_CALL	getFastPropertyValue (sal_Int32 nHandle) override final

virtual void	getFastPropertyValue (std::unique_lock< std::mutex > &rGuard, css::uno::Any &rValue, sal_Int32 nHandle) const =0

virtual void SAL_CALL	setFastPropertyValue (sal_Int32 nHandle, const css::uno::Any &rValue) override final

Protected Member Functions inherited from comphelper::OPropertyContainerHelper
	OPropertyContainerHelper ()

	~OPropertyContainerHelper ()

void	registerProperty (const OUString &_rName, sal_Int32 _nHandle, sal_Int32 _nAttributes, void *_pPointerToMember, const css::uno::Type &_rMemberType)

void	registerMayBeVoidProperty (const OUString &_rName, sal_Int32 _nHandle, sal_Int32 _nAttributes, css::uno::Any *_pPointerToMember, const css::uno::Type &_rExpectedType)

void	registerPropertyNoMember (const OUString &_rName, sal_Int32 _nHandle, sal_Int32 _nAttributes, const css::uno::Type &_rType, css::uno::Any const &_pInitialValue)

void	revokeProperty (sal_Int32 _nHandle)

bool	isRegisteredProperty (sal_Int32 _nHandle) const

bool	isRegisteredProperty (const OUString &_rName) const

bool	convertFastPropertyValue (css::uno::Any &rConvertedValue, css::uno::Any &rOldValue, sal_Int32 nHandle, const css::uno::Any &rValue)

void	setFastPropertyValue (sal_Int32 nHandle, const css::uno::Any &rValue)

void	getFastPropertyValue (css::uno::Any &rValue, sal_Int32 nHandle) const

void	describeProperties (css::uno::Sequence< css::beans::Property > &_rProps) const

const css::beans::Property &	getProperty (const OUString &_rName) const

virtual ::cppu::IPropertyArrayHelper *	createArrayHelper () const=0

Private Member Functions
void	impl_classifyControlModel_throw ()
	classifies our component, in case it's a control model, by ClassId More...

bool	isReportModel () const

css::uno::Any	impl_getPropertyValue_throw (const OUString &_rPropertyName) const
	const-version of ->getPropertyValue More...

void	impl_normalizePropertyValue_nothrow (css::uno::Any &_rValue, PropertyId _nPropId) const

bool	impl_shouldExcludeProperty_nothrow (const css::beans::Property &_rProperty) const
	determines whether we should exclude a given property from our "supported properties" More...

void	impl_initFieldList_nothrow (std::vector< OUString > &rFieldNames) const
	initializes the list of field names, if we're handling a control which supports the DataField property More...

css::uno::Reference< css::sdbc::XRowSet >	impl_getRowSet_throw () const
	obtains the RowSet to which our component belongs More...

css::uno::Reference< css::sdbc::XRowSet >	impl_getRowSet_nothrow () const
	nothrow-version of ->impl_getRowSet_throw More...

bool	impl_ensureRowsetConnection_nothrow () const
	connects the row set belonging to our introspected data aware form component, and remembers the connection in ->m_xRowSetConnection. More...

void	impl_describeCursorSource_nothrow (css::inspection::LineDescriptor &_out_rProperty, const css::uno::Reference< css::inspection::XPropertyControlFactory > &_rxControlFactory) const
	fills an ->LineDescriptor with information to represent a cursor source of our form - that is, a table, a query, or an SQL statement. More...

void	impl_fillTableNames_throw (std::vector< OUString > &_out_rNames) const
	describes the UI for selecting a table name More...

void	impl_fillQueryNames_throw (std::vector< OUString > &_out_rNames) const
	describes the UI for selecting a query name More...

void	impl_fillQueryNames_throw (const css::uno::Reference< css::container::XNameAccess > &_xQueryNames, std::vector< OUString > &_out_rNames, std::u16string_view _sName=std::u16string_view()) const
	describes the UI for selecting a query name More...

void	impl_describeListSourceUI_throw (css::inspection::LineDescriptor &_out_rDescriptor, const css::uno::Reference< css::inspection::XPropertyControlFactory > &_rxControlFactory) const
	describes the UI for selecting a ListSource (for list-like form controls) @precond ->m_xRowSetConnection is not <NULL> @precond ->m_xComponent is not <NULL> More...

void	impl_displaySQLError_nothrow (const ::dbtools::SQLExceptionInfo &_rErrorDescriptor) const
	displays a database-related error to the user More...

bool	impl_dialogListSelection_nothrow (const OUString &_rProperty, ::osl::ClearableMutexGuard &_rClearBeforeDialog) const
	let's the user chose a selection of entries from a string list, and stores this selection in the given property More...

bool	impl_dialogFilterOrSort_nothrow (bool _bFilter, OUString &_out_rSelectedClause, ::osl::ClearableMutexGuard &_rClearBeforeDialog) const
	executes a dialog for choosing a filter or sort criterion for a database form More...

bool	impl_dialogLinkedFormFields_nothrow (::osl::ClearableMutexGuard &_rClearBeforeDialog) const
	executes a dialog which allows the user to choose the columns linking a sub to a master form, and sets the respective MasterFields / SlaveFields properties at the form. More...

bool	impl_dialogFormatting_nothrow (css::uno::Any &_out_rNewValue, ::osl::ClearableMutexGuard &_rClearBeforeDialog) const
	executes a dialog which allows the user to modify the FormatKey property of our component, by choosing a (number) format. More...

bool	impl_browseForImage_nothrow (css::uno::Any &_out_rNewValue, ::osl::ClearableMutexGuard &_rClearBeforeDialog) const
	executes a dialog which allows to the user to change the ImageURL property of our component by browsing for an image file. More...

bool	impl_browseForTargetURL_nothrow (css::uno::Any &_out_rNewValue, ::osl::ClearableMutexGuard &_rClearBeforeDialog) const
	executes a dialog which allows the user to change the TargetURL property of our component @precond our component actually has a TargetURL property More...

bool	impl_executeFontDialog_nothrow (css::uno::Any &_out_rNewValue, ::osl::ClearableMutexGuard &_rClearBeforeDialog) const
	executes a dialog which allows the user to change the font, plus related properties, of our component @precond our component actually has a Font property More...

bool	impl_browseForDatabaseDocument_throw (css::uno::Any &_out_rNewValue, ::osl::ClearableMutexGuard &_rClearBeforeDialog) const
	allows the user browsing for a database document @precond our component actually has a DataSource property More...

bool	impl_dialogColorChooser_throw (sal_Int32 _nColorPropertyId, css::uno::Any &_out_rNewValue, ::osl::ClearableMutexGuard &_rClearBeforeDialog) const
	raises a dialog which allows the user to choose a color More...

bool	impl_dialogChooseLabelControl_nothrow (css::uno::Any &_out_rNewValue, ::osl::ClearableMutexGuard &_rClearBeforeDialog) const
	raises a dialog which allows the user to choose a label control for our component More...

bool	impl_dialogChangeTabOrder_nothrow (::osl::ClearableMutexGuard &_rClearBeforeDialog) const
	raises a dialog which lets the user chose the tab order of controls of a form @precond we have a view control container in which our controls live More...

css::uno::Reference< css::awt::XControlContainer >	impl_getContextControlContainer_nothrow () const
	retrieves the context for controls, whose model(s) we're inspecting More...

bool	impl_doDesignSQLCommand_nothrow (const css::uno::Reference< css::inspection::XObjectInspectorUI > &_rxInspectorUI, PropertyId _nDesignForProperty)
	opens a query design window for interactively designing the SQL command of a database form More...

void	impl_updateDependentProperty_nothrow (PropertyId _nPropId, const css::uno::Reference< css::inspection::XObjectInspectorUI > &_rxInspectorUI) const
	updates a property (UI) whose state depends on more than one other property More...

OUString	impl_getDocumentURL_nothrow () const
	returns the URL of our context document More...

	DECL_LINK (OnDesignerClosed, SQLCommandDesigner &, void)

	FormComponentPropertyHandler (const FormComponentPropertyHandler &)=delete

FormComponentPropertyHandler &	operator= (const FormComponentPropertyHandler &)=delete

Static Private Member Functions
static bool	impl_hasValidDataSourceSignature_nothrow (const css::uno::Reference< css::beans::XPropertySet > &_xFormProperties, bool _bAllowEmptyDataSourceName)
	determines whether the given form has a valid data source signature. More...

Private Attributes
css::uno::Reference< css::beans::XPropertyState >	m_xPropertyState
	access to property states More...

css::uno::Reference< css::uno::XInterface >	m_xObjectParent
	the parent of our component More...

mutable::dbtools::SharedConnection	m_xRowSetConnection
	the database connection. Owned by us if and only if we created it ourself. More...

css::uno::Reference< css::sdbc::XRowSet >	m_xRowSet

::rtl::Reference< SQLCommandDesigner >	m_xCommandDesigner
	helper component encapsulating the handling for the QueryDesign component for interactively designing an SQL command More...

css::uno::Reference< css::inspection::XObjectInspectorUI >	m_xBrowserUI

OUString	m_sDefaultValueString
	the string indicating a "default" (VOID) value in list-like controls More...

std::set< OUString >	m_aPropertiesWithDefListEntry
	all properties to whose control's we added ->m_sDefaultValueString More...

ComponentClassification	m_eComponentClass
	type of our component More...

bool	m_bComponentIsSubForm: 1
	is our component a (database) sub form? More...

bool	m_bHaveListSource: 1
	our component has a "ListSource" property More...

bool	m_bHaveCommand: 1
	our component has a "Command" property More...

sal_Int16	m_nClassId
	the class id of the component - if applicable More...

Additional Inherited Members
Static Protected Member Functions inherited from comphelper::OPropertyContainer
static css::uno::Sequence< css::uno::Type >	getBaseTypes ()

Static Protected Member Functions inherited from comphelper::OPropertyArrayUsageHelper< class TYPE >
static std::mutex &	theMutex ()

Protected Attributes inherited from pcr::PropertyHandler
css::uno::Reference< css::uno::XComponentContext >	m_xContext
	the context in which the instance was created More...

css::uno::Reference< css::beans::XPropertySet >	m_xComponent
	the component we're inspecting More...

css::uno::Reference< css::beans::XPropertySetInfo >	m_xComponentPropertyInfo
	info about our component's properties More...

css::uno::Reference< css::script::XTypeConverter >	m_xTypeConverter
	type converter, needed on various occasions More...

std::unique_ptr< OPropertyInfoService >	m_pInfoService
	access to property meta data More...

Protected Attributes inherited from cppu::BaseMutex
mutable::osl::Mutex	m_aMutex

Static Protected Attributes inherited from comphelper::OPropertyArrayUsageHelper< class TYPE >
static sal_Int32	s_nRefCount

::cppu::IPropertyArrayHelper *	s_pProps

Detailed Description

default ->XPropertyHandler for all form components.

Definition at line 56 of file formcomponenthandler.hxx.

Constructor & Destructor Documentation

◆ FormComponentPropertyHandler() [1/2]

pcr::FormComponentPropertyHandler::FormComponentPropertyHandler ( const css::uno::Reference< css::uno::XComponentContext > & _rxContext )

explicit

References DECLARE_XINTERFACE.

◆ ~FormComponentPropertyHandler()

pcr::FormComponentPropertyHandler::~FormComponentPropertyHandler ( )

overrideprotectedvirtual

Definition at line 154 of file formcomponenthandler.cxx.

◆ FormComponentPropertyHandler() [2/2]

pcr::FormComponentPropertyHandler::FormComponentPropertyHandler ( const FormComponentPropertyHandler & )

privatedelete

Member Function Documentation

◆ actuatingPropertyChanged()

void SAL_CALL pcr::FormComponentPropertyHandler::actuatingPropertyChanged	(	const OUString &	_rActuatingPropertyName,
		const css::uno::Any &	_rNewValue,
		const css::uno::Any &	_rOldValue,
		const css::uno::Reference< css::inspection::XObjectInspectorUI > &	_rxInspectorUI,
		sal_Bool	_bFirstTimeInit
	)

overrideprotectedvirtual

Reimplemented from pcr::PropertyHandler.

Definition at line 1492 of file formcomponenthandler.cxx.

References DBG_ASSERT, pcr::eFormControl, m_aMutex, pcr::FormatDescription::nKey, PROPERTY_BORDERCOLOR, PROPERTY_DEFAULT_STATE, PROPERTY_DEFAULT_VALUE, PROPERTY_EFFECTIVE_DEFAULT, PROPERTY_EFFECTIVE_MAX, PROPERTY_EFFECTIVE_MIN, PROPERTY_EFFECTIVE_VALUE, PROPERTY_EMPTY_IS_NULL, PROPERTY_FILTERPROPOSAL, PROPERTY_FORMATSSUPPLIER, PROPERTY_ID_BORDER, PROPERTY_ID_BOUNDCOLUMN, PROPERTY_ID_BUTTONTYPE, PROPERTY_ID_COMMAND, PROPERTY_ID_COMMANDTYPE, PROPERTY_ID_CONTROLSOURCE, PROPERTY_ID_DATASOURCE, PROPERTY_ID_DECIMAL_ACCURACY, PROPERTY_ID_DEFAULT_SELECT_SEQ, PROPERTY_ID_DETAILFIELDS, PROPERTY_ID_DROPDOWN, PROPERTY_ID_EMPTY_IS_NULL, PROPERTY_ID_ESCAPE_PROCESSING, PROPERTY_ID_FILTER, PROPERTY_ID_FORMATKEY, PROPERTY_ID_IMAGE_URL, PROPERTY_ID_IMAGEPOSITION, PROPERTY_ID_INPUT_REQUIRED, PROPERTY_ID_LINECOUNT, PROPERTY_ID_LISTSOURCE, PROPERTY_ID_LISTSOURCETYPE, PROPERTY_ID_REPEAT, PROPERTY_ID_SCALE_MODE, PROPERTY_ID_SCALEIMAGE, PROPERTY_ID_SELECTEDITEMS, PROPERTY_ID_SHOWTHOUSANDSEP, PROPERTY_ID_SORT, PROPERTY_ID_STRINGITEMLIST, PROPERTY_ID_SUBMIT_ENCODING, PROPERTY_ID_TABSTOP, PROPERTY_ID_TARGET_FRAME, PROPERTY_ID_TARGET_URL, PROPERTY_ID_TOGGLE, PROPERTY_ID_TRISTATE, PROPERTY_ID_TYPEDITEMLIST, PROPERTY_IMAGEPOSITION, PROPERTY_LINECOUNT, PROPERTY_LISTSOURCE, PROPERTY_REPEAT_DELAY, PROPERTY_STATE, PROPERTY_SUBMIT_METHOD, PROPERTY_TABINDEX, PROPERTY_TARGET_URL, PROPERTY_VALUE, PROPERTY_VALUEMAX, PROPERTY_VALUEMIN, pcr::FormatDescription::pSupplier, SAL_WARN, pcr::OFormattedNumericControl::SetDecimalDigits(), and pcr::OFormattedNumericControl::SetFormatDescription().

◆ addPropertyChangeListener()

void SAL_CALL pcr::FormComponentPropertyHandler::addPropertyChangeListener ( const css::uno::Reference< css::beans::XPropertyChangeListener > & _rxListener )

overrideprotectedvirtual

Reimplemented from pcr::PropertyHandler.

Definition at line 789 of file formcomponenthandler.cxx.

References m_aMutex.

◆ convertToControlValue()

Any SAL_CALL pcr::FormComponentPropertyHandler::convertToControlValue	(	const OUString &	_rPropertyName,
		const css::uno::Any &	_rPropertyValue,
		const css::uno::Type &	_rControlValueType
	)

overrideprotectedvirtual

◆ convertToPropertyValue()

Any SAL_CALL pcr::FormComponentPropertyHandler::convertToPropertyValue	(	const OUString &	_rPropertyName,
		const css::uno::Any &	_rControlValue
	)

overrideprotectedvirtual

care for the special "default" string, translate it to VOID

Reimplemented from pcr::PropertyHandler.

Definition at line 468 of file formcomponenthandler.cxx.

References Any, svt::OFileNotation::get(), m_aMutex, m_xContext, svt::OFileNotation::N_URL, pcr::PcrRes(), Property, PROPERTY_ID_DATASOURCE, PROPERTY_ID_DATE, PROPERTY_ID_DATEMAX, PROPERTY_ID_DATEMIN, PROPERTY_ID_DEFAULT_DATE, PROPERTY_ID_DEFAULT_TIME, PROPERTY_ID_IMAGE_URL, PROPERTY_ID_SHOW_FILTERSORT, PROPERTY_ID_SHOW_NAVIGATION, PROPERTY_ID_SHOW_POSITION, PROPERTY_ID_SHOW_RECORDACTIONS, PROPERTY_ID_TARGET_URL, PROPERTY_ID_TIME, PROPERTY_ID_TIMEMAX, PROPERTY_ID_TIMEMIN, PROPERTY_ID_WRITING_MODE, SAL_N_ELEMENTS, and SAL_WARN.

◆ createArrayHelper()

cppu::IPropertyArrayHelper * pcr::FormComponentPropertyHandler::createArrayHelper ( ) const

overrideprotectedvirtual

Implements comphelper::OPropertyArrayUsageHelper< class TYPE >.

Definition at line 3273 of file formcomponenthandler.cxx.

References comphelper::OPropertyContainerHelper::describeProperties().

◆ DECL_LINK()

pcr::FormComponentPropertyHandler::DECL_LINK	(	OnDesignerClosed	,
		SQLCommandDesigner &	,
		void
	)

private

◆ describePropertyLine()

LineDescriptor SAL_CALL pcr::FormComponentPropertyHandler::describePropertyLine	(	const OUString &	_rPropertyName,
		const css::uno::Reference< css::inspection::XPropertyControlFactory > &	_rxControlFactory
	)

overrideprotectedvirtual

Reimplemented from pcr::PropertyHandler.

Definition at line 909 of file formcomponenthandler.cxx.

References aFieldNames, Any, bReadOnly, DBG_ASSERT, pcr::eFormControl, eType, Exception, HID_PROP_ACTIVESELECTIONBACKGROUNDCOLOR, HID_PROP_ACTIVESELECTIONTEXTCOLOR, HID_PROP_GRIDLINECOLOR, HID_PROP_HEADERBACKGROUNDCOLOR, HID_PROP_HEADERTEXTCOLOR, HID_PROP_INACTIVESELECTIONBACKGROUNDCOLOR, HID_PROP_INACTIVESELECTIONTEXTCOLOR, m_aMutex, m_xContext, pcr::FormatDescription::nKey, PROP_FLAG_DATA_PROPERTY, PROP_FLAG_ENUM, Property, PROPERTY_DECIMAL_ACCURACY, PROPERTY_FORMATKEY, PROPERTY_FORMATSSUPPLIER, PROPERTY_ID_ACTIVESELECTIONBACKGROUNDCOLOR, PROPERTY_ID_ACTIVESELECTIONTEXTCOLOR, PROPERTY_ID_BACKGROUNDCOLOR, PROPERTY_ID_BLOCKINCREMENT, PROPERTY_ID_BORDERCOLOR, PROPERTY_ID_BOUNDCOLUMN, PROPERTY_ID_COMMAND, PROPERTY_ID_CONTROLLABEL, PROPERTY_ID_CONTROLSOURCE, PROPERTY_ID_DATASOURCE, PROPERTY_ID_DATE, PROPERTY_ID_DATEMAX, PROPERTY_ID_DATEMIN, PROPERTY_ID_DECIMAL_ACCURACY, PROPERTY_ID_DEFAULT_DATE, PROPERTY_ID_DEFAULT_SELECT_SEQ, PROPERTY_ID_DEFAULT_STATE, PROPERTY_ID_DEFAULT_TEXT, PROPERTY_ID_DEFAULT_TIME, PROPERTY_ID_DEFAULT_VALUE, PROPERTY_ID_DETAILFIELDS, PROPERTY_ID_ECHO_CHAR, PROPERTY_ID_EFFECTIVE_DEFAULT, PROPERTY_ID_EFFECTIVE_MAX, PROPERTY_ID_EFFECTIVE_MIN, PROPERTY_ID_EFFECTIVE_VALUE, PROPERTY_ID_FILLCOLOR, PROPERTY_ID_FILTER, PROPERTY_ID_FONT, PROPERTY_ID_FORMATKEY, PROPERTY_ID_GRIDLINECOLOR, PROPERTY_ID_HEADERBACKGROUNDCOLOR, PROPERTY_ID_HEADERTEXTCOLOR, PROPERTY_ID_HEIGHT, PROPERTY_ID_IMAGE_URL, PROPERTY_ID_INACTIVESELECTIONBACKGROUNDCOLOR, PROPERTY_ID_INACTIVESELECTIONTEXTCOLOR, PROPERTY_ID_LABEL, PROPERTY_ID_LINEINCREMENT, PROPERTY_ID_LISTSOURCE, PROPERTY_ID_LISTSOURCETYPE, PROPERTY_ID_MASTERFIELDS, PROPERTY_ID_MAXTEXTLEN, PROPERTY_ID_MULTILINE, PROPERTY_ID_REPEAT_DELAY, PROPERTY_ID_ROWHEIGHT, PROPERTY_ID_SELECTEDITEMS, PROPERTY_ID_SHOW_FILTERSORT, PROPERTY_ID_SHOW_NAVIGATION, PROPERTY_ID_SHOW_POSITION, PROPERTY_ID_SHOW_RECORDACTIONS, PROPERTY_ID_SORT, PROPERTY_ID_SPININCREMENT, PROPERTY_ID_STATE, PROPERTY_ID_SYMBOLCOLOR, PROPERTY_ID_TABINDEX, PROPERTY_ID_TARGET_FRAME, PROPERTY_ID_TARGET_URL, PROPERTY_ID_TEXT, PROPERTY_ID_TIME, PROPERTY_ID_TIMEMAX, PROPERTY_ID_TIMEMIN, PROPERTY_ID_URL, PROPERTY_ID_VALUE, PROPERTY_ID_VALUEMAX, PROPERTY_ID_VALUEMIN, PROPERTY_ID_VISIBLESIZE, PROPERTY_ID_WIDTH, PROPERTY_ID_WORDBREAK, PROPERTY_MULTILINE, PROPERTY_TRISTATE, pcr::FormatDescription::pSupplier, SAL_N_ELEMENTS, sDisplayName, u, UID_PROP_DLG_ATTR_DATASOURCE, UID_PROP_DLG_ATTR_TARGET_URL, UID_PROP_DLG_BACKGROUNDCOLOR, UID_PROP_DLG_BORDERCOLOR, UID_PROP_DLG_CONTROLLABEL, UID_PROP_DLG_FILLCOLOR, UID_PROP_DLG_FILTER, UID_PROP_DLG_FONT_TYPE, UID_PROP_DLG_FORMLINKFIELDS, UID_PROP_DLG_IMAGE_URL, UID_PROP_DLG_NUMBER_FORMAT, UID_PROP_DLG_ORDER, UID_PROP_DLG_SELECTION, UID_PROP_DLG_SQLCOMMAND, UID_PROP_DLG_SYMBOLCOLOR, and UID_PROP_DLG_TABINDEX.

◆ disposing()

void SAL_CALL pcr::FormComponentPropertyHandler::disposing ( )

overrideprotectedvirtual

Reimplemented from pcr::PropertyHandler.

Definition at line 2006 of file formcomponenthandler.cxx.

◆ doDescribeSupportedProperties()

Sequence< Property > pcr::FormComponentPropertyHandler::doDescribeSupportedProperties ( ) const

overrideprotectedvirtual

Implements pcr::PropertyHandler.

Definition at line 805 of file formcomponenthandler.cxx.

References aProperties, comphelper::containerToSequence(), SvtModuleOptions::DATABASE, pcr::eDialogControl, pcr::eFormControl, SvtModuleOptions::IsModuleInstalled(), m_bHaveCommand, m_bHaveListSource, PROP_FLAG_DIALOG_VISIBLE, PROP_FLAG_FORM_VISIBLE, Property, PROPERTY_ID_BORDER, PROPERTY_ID_COMMAND, PROPERTY_ID_LISTSOURCE, PROPERTY_ID_TABSTOP, and sDisplayName.

◆ getActuatingProperties()

Sequence< OUString > SAL_CALL pcr::FormComponentPropertyHandler::getActuatingProperties ( )

overrideprotectedvirtual

◆ getImplementationName()

OUString pcr::FormComponentPropertyHandler::getImplementationName ( )

overrideprotectedvirtual

Implements pcr::PropertyHandlerComponent.

Definition at line 160 of file formcomponenthandler.cxx.

◆ getInfoHelper()

cppu::IPropertyArrayHelper & pcr::FormComponentPropertyHandler::getInfoHelper ( )

overrideprotected

Definition at line 3281 of file formcomponenthandler.cxx.

References comphelper::OPropertyArrayUsageHelper< class TYPE >::getArrayHelper().

Referenced by getPropertySetInfo().

◆ getPropertySetInfo()

uno::Reference< beans::XPropertySetInfo > SAL_CALL pcr::FormComponentPropertyHandler::getPropertySetInfo ( )

overridevirtual

Definition at line 3286 of file formcomponenthandler.cxx.

References getInfoHelper().

◆ getPropertyState()

PropertyState SAL_CALL pcr::FormComponentPropertyHandler::getPropertyState ( const OUString & _rPropertyName )

overrideprotectedvirtual

Reimplemented from pcr::PropertyHandler.

Definition at line 781 of file formcomponenthandler.cxx.

References m_aMutex.

◆ getPropertyValue()

Any SAL_CALL pcr::FormComponentPropertyHandler::getPropertyValue ( const OUString & _rPropertyName )

overrideprotectedvirtual

Definition at line 301 of file formcomponenthandler.cxx.

References Any, m_aMutex, and PROPERTY_ROWSET.

◆ getSupersededProperties()

Sequence< OUString > SAL_CALL pcr::FormComponentPropertyHandler::getSupersededProperties ( )

overrideprotectedvirtual

Reimplemented from pcr::PropertyHandler.

Definition at line 875 of file formcomponenthandler.cxx.

◆ getSupportedServiceNames()

Sequence< OUString > pcr::FormComponentPropertyHandler::getSupportedServiceNames ( )

overrideprotectedvirtual

Implements pcr::PropertyHandlerComponent.

Definition at line 166 of file formcomponenthandler.cxx.

◆ impl_browseForDatabaseDocument_throw()

bool pcr::FormComponentPropertyHandler::impl_browseForDatabaseDocument_throw	(	css::uno::Any &	_out_rNewValue,
		::osl::ClearableMutexGuard &	_rClearBeforeDialog
	)		const

private

allows the user browsing for a database document @precond our component actually has a DataSource property

Parameters

_out_rNewValue the new property value, if the user chose a new DataSource

Returns: <TRUE> if and only if a new DataSource has been chosen by the user. In this case, ->_out_rNewValue is filled with the new property value

Definition at line 2865 of file formcomponenthandler.cxx.

References ERRCODE_NONE, sfx2::FileDialogHelper::Execute(), SfxFilter::GetFilterByName(), sfx2::FileDialogHelper::GetPath(), INetURLObject::GetProtocol(), PROPERTY_DATASOURCE, SAL_WARN, sfx2::FileDialogHelper::SetCurrentFilter(), and sfx2::FileDialogHelper::SetDisplayDirectory().

◆ impl_browseForImage_nothrow()

bool pcr::FormComponentPropertyHandler::impl_browseForImage_nothrow	(	css::uno::Any &	_out_rNewValue,
		::osl::ClearableMutexGuard &	_rClearBeforeDialog
	)		const

private

executes a dialog which allows to the user to change the ImageURL property of our component by browsing for an image file.

@precond our component actually has an ImageURL property

Parameters

_out_rNewValue the new property value, if the user chose a new image url

Returns: <TRUE> if and only if a new image URL has been chosen by the user. In this case, ->_out_rNewValue is filled with the new property value

Definition at line 2738 of file formcomponenthandler.cxx.

References DBG_ASSERT, ERRCODE_NONE, sfx2::FileDialogHelper::Execute(), sfx2::FileDialogHelper::FormsInsertImage, sfx2::FileDialogHelper::GetFilePicker(), sfx2::FileDialogHelper::GetGraphic(), sfx2::FileDialogHelper::GetPath(), Graphic::GetXGraphic(), m_xContext, PROPERTY_ID_IMAGE_URL, PROPERTY_IMAGE_URL, SAL_WARN, sfx2::FileDialogHelper::SetContext(), sfx2::FileDialogHelper::SetDisplayDirectory(), sfx2::FileDialogHelper::SetTitle(), xController, and xModel.

◆ impl_browseForTargetURL_nothrow()

bool pcr::FormComponentPropertyHandler::impl_browseForTargetURL_nothrow	(	css::uno::Any &	_out_rNewValue,
		::osl::ClearableMutexGuard &	_rClearBeforeDialog
	)		const

private

executes a dialog which allows the user to change the TargetURL property of our component @precond our component actually has a TargetURL property

Parameters

_out_rNewValue the new property value, if the user chose a new TargetURL

Returns: <TRUE> if and only if a new TargetURL has been chosen by the user. In this case, ->_out_rNewValue is filled with the new property value

Definition at line 2809 of file formcomponenthandler.cxx.

References ERRCODE_NONE, sfx2::FileDialogHelper::Execute(), sfx2::FileDialogHelper::GetPath(), INetURLObject::GetProtocol(), PROPERTY_TARGET_URL, SAL_WARN, and sfx2::FileDialogHelper::SetDisplayDirectory().

◆ impl_classifyControlModel_throw()

void pcr::FormComponentPropertyHandler::impl_classifyControlModel_throw ( )

private

classifies our component, in case it's a control model, by ClassId

Note that UNO dialog controls are also classified, though they don't have the ClassId property

Definition at line 2082 of file formcomponenthandler.cxx.

References pcr::eDialogControl, i, pcr::ControlType::PROGRESSBAR, PROPERTY_CLASSID, SAL_N_ELEMENTS, SAL_WARN, and sServiceName.

◆ impl_describeCursorSource_nothrow()

void pcr::FormComponentPropertyHandler::impl_describeCursorSource_nothrow	(	css::inspection::LineDescriptor &	_out_rProperty,
		const css::uno::Reference< css::inspection::XPropertyControlFactory > &	_rxControlFactory
	)		const

private

fills an ->LineDescriptor with information to represent a cursor source of our form - that is, a table, a query, or an SQL statement.

As an example, if our form has currently a CommandType of TABLE, then the value list in the LineDescriptor will contain a list of all tables of the data source which the form is bound to.

@seealso impl_fillTableNames_throw @seealso impl_fillQueryNames_throw

Definition at line 2435 of file formcomponenthandler.cxx.

References Exception, PROPERTY_COMMANDTYPE, PROPERTY_ID_COMMAND, TOOLS_WARN_EXCEPTION, and UID_PROP_DLG_SQLCOMMAND.

◆ impl_describeListSourceUI_throw()

void pcr::FormComponentPropertyHandler::impl_describeListSourceUI_throw	(	css::inspection::LineDescriptor &	_out_rDescriptor,
		const css::uno::Reference< css::inspection::XPropertyControlFactory > &	_rxControlFactory
	)		const

private

describes the UI for selecting a ListSource (for list-like form controls) @precond ->m_xRowSetConnection is not <NULL> @precond ->m_xComponent is not <NULL>

Definition at line 2539 of file formcomponenthandler.cxx.

References Any, PROPERTY_ID_LISTSOURCE, and PROPERTY_LISTSOURCETYPE.

◆ impl_dialogChangeTabOrder_nothrow()

bool pcr::FormComponentPropertyHandler::impl_dialogChangeTabOrder_nothrow ( ::osl::ClearableMutexGuard & _rClearBeforeDialog ) const

private

raises a dialog which lets the user chose the tab order of controls of a form @precond we have a view control container in which our controls live

Returns: <TRUE> if and only if the user successfully changed the tab order @seealso impl_getContextControlContainer_nothrow

Definition at line 2934 of file formcomponenthandler.cxx.

References m_xContext, RET_OK, and weld::DialogController::run().

◆ impl_dialogChooseLabelControl_nothrow()

bool pcr::FormComponentPropertyHandler::impl_dialogChooseLabelControl_nothrow	(	css::uno::Any &	_out_rNewValue,
		::osl::ClearableMutexGuard &	_rClearBeforeDialog
	)		const

private

raises a dialog which allows the user to choose a label control for our component

Parameters

_out_rNewValue the chosen label control, if any

Returns: <TRUE> if and only if a label control was chosen by the user

Definition at line 2913 of file formcomponenthandler.cxx.

References pcr::OSelectLabelDialog::GetSelected(), RET_OK, and weld::DialogController::run().

◆ impl_dialogColorChooser_throw()

bool pcr::FormComponentPropertyHandler::impl_dialogColorChooser_throw	(	sal_Int32	_nColorPropertyId,
		css::uno::Any &	_out_rNewValue,
		::osl::ClearableMutexGuard &	_rClearBeforeDialog
	)		const

private

raises a dialog which allows the user to choose a color

Parameters

_nColorPropertyId	the ID of the color property
_out_rNewValue	the chosen color value

Returns: <TRUE> if and only if a color was chosen by the user

Definition at line 2896 of file formcomponenthandler.cxx.

References SvColorDialog::Execute(), SvColorDialog::GetColor(), SAL_WARN, and SvColorDialog::SetColor().

◆ impl_dialogFilterOrSort_nothrow()

bool pcr::FormComponentPropertyHandler::impl_dialogFilterOrSort_nothrow	(	bool	_bFilter,
		OUString &	_out_rSelectedClause,
		::osl::ClearableMutexGuard &	_rClearBeforeDialog
	)		const

private

executes a dialog for choosing a filter or sort criterion for a database form

Parameters

_bFilter	<TRUE> if the Filter property should be used, <FALSE> if it's the Order property
_out_rSelectedClause	the filter or order clause as chosen by the user @precond we're really inspecting a database form (well, a RowSet at least)

Returns: <TRUE> if and only if the user successfully chose a clause

Definition at line 2597 of file formcomponenthandler.cxx.

References Any, Exception, m_xContext, PROPERTY_ID_FILTER, PROPERTY_ID_SORT, and TOOLS_WARN_EXCEPTION.

◆ impl_dialogFormatting_nothrow()

bool pcr::FormComponentPropertyHandler::impl_dialogFormatting_nothrow	(	css::uno::Any &	_out_rNewValue,
		::osl::ClearableMutexGuard &	_rClearBeforeDialog
	)		const

private

executes a dialog which allows the user to modify the FormatKey property of our component, by choosing a (number) format.

@precond Our component actually has a FormatKey property.

Parameters

_out_rNewValue the new property value, if the user chose a new formatting

Returns: <TRUE> if and only if a new formatting has been chosen by the user. In this case, ->_out_rNewValue is filled with the new property value

Definition at line 2672 of file formcomponenthandler.cxx.

References SvxAbstractDialogFactory::Create(), DBG_ASSERT, SvNumberFormatter::DeleteEntry(), Exception, SfxSingleTabDialogController::get_content_area(), SfxItemSet::GetItem(), SfxItemSet::GetItemIfSet(), SvNumberFormatsSupplierObj::GetNumberFormatter(), SfxSingleTabDialogController::GetOutputItemSet(), svl::Items, pcr::PcrRes(), PROPERTY_FORMATKEY, PROPERTY_FORMATSSUPPLIER, SfxItemSet::Put(), RET_OK, SfxSingleTabDialogController::SetTabPage(), SfxGetpApp(), and TOOLS_WARN_EXCEPTION.

◆ impl_dialogLinkedFormFields_nothrow()

bool pcr::FormComponentPropertyHandler::impl_dialogLinkedFormFields_nothrow ( ::osl::ClearableMutexGuard & _rClearBeforeDialog ) const

private

executes a dialog which allows the user to choose the columns linking a sub to a master form, and sets the respective MasterFields / SlaveFields properties at the form.

@precond we're inspecting (sub) database form

Returns: <TRUE> if and only if the user successfully enter master and slave fields

Definition at line 2658 of file formcomponenthandler.cxx.

References m_xContext, RET_OK, and pcr::FormLinkDialog::run().

◆ impl_dialogListSelection_nothrow()

bool pcr::FormComponentPropertyHandler::impl_dialogListSelection_nothrow	(	const OUString &	_rProperty,
		::osl::ClearableMutexGuard &	_rClearBeforeDialog
	)		const

private

let's the user chose a selection of entries from a string list, and stores this selection in the given property

Returns: <TRUE> if and only if the user successfully changed the property

Definition at line 2586 of file formcomponenthandler.cxx.

References RET_OK, and pcr::ListSelectionDialog::run().

◆ impl_displaySQLError_nothrow()

void pcr::FormComponentPropertyHandler::impl_displaySQLError_nothrow ( const ::dbtools::SQLExceptionInfo & _rErrorDescriptor ) const

private

displays a database-related error to the user

Definition at line 2373 of file formcomponenthandler.cxx.

References m_xContext.

◆ impl_doDesignSQLCommand_nothrow()

bool pcr::FormComponentPropertyHandler::impl_doDesignSQLCommand_nothrow	(	const css::uno::Reference< css::inspection::XObjectInspectorUI > &	_rxInspectorUI,
		PropertyId	_nDesignForProperty
	)

private

opens a query design window for interactively designing the SQL command of a database form

Parameters

_rxUIUpdate	access to the property browser UI
_nDesignForProperty	the ID for the property for which the designer is opened

Returns: <TRUE> if the window was successfully opened, or was previously open, <FALSE> otherwise

Definition at line 3142 of file formcomponenthandler.cxx.

References DBG_ASSERT, DBG_UNHANDLED_EXCEPTION, Exception, impl_ensureRowsetConnection_nothrow(), pcr::PropertyHandler::impl_getPropertyNameFromId_nothrow(), LINK, m_xBrowserUI, m_xCommandDesigner, pcr::PropertyHandler::m_xComponent, pcr::PropertyHandler::m_xContext, m_xRowSetConnection, PROPERTY_ID_COMMAND, and PROPERTY_ID_LISTSOURCE.

◆ impl_ensureRowsetConnection_nothrow()

bool pcr::FormComponentPropertyHandler::impl_ensureRowsetConnection_nothrow ( ) const

private

connects the row set belonging to our introspected data aware form component, and remembers the connection in ->m_xRowSetConnection.

If the row set already is connected, ->m_xRowSetConnection will be set, too, but not take the ownership of the connection.

If ->m_xRowSetConnection is already set, nothing happens, so if you want to force creation of a connection, you need to clear ->m_xRowSetConnection.

Definition at line 2379 of file formcomponenthandler.cxx.

References any, Any, DBG_UNHANDLED_EXCEPTION, Exception, INetURLObject::getBase(), INetURLObject::GetProtocol(), INetURLObject::LAST_SEGMENT, m_xContext, utl::SharedUNOComponent< css::sdbc::XConnection >::NoTakeOwnership, pcr::PcrRes(), PROPERTY_DATASOURCE, TOOLS_WARN_EXCEPTION, and INetURLObject::WithCharset.

Referenced by impl_doDesignSQLCommand_nothrow().

◆ impl_executeFontDialog_nothrow()

bool pcr::FormComponentPropertyHandler::impl_executeFontDialog_nothrow	(	css::uno::Any &	_out_rNewValue,
		::osl::ClearableMutexGuard &	_rClearBeforeDialog
	)		const

private

executes a dialog which allows the user to change the font, plus related properties, of our component @precond our component actually has a Font property

Parameters

_out_rNewValue a value describing the new font, as Sequence< NamedValue >

Returns: <TRUE> if and only if the user successfully changed the font of our component

Definition at line 2832 of file formcomponenthandler.cxx.

References comphelper::containerToSequence(), SfxTabDialogController::GetOutputItemSet(), pOut, RET_OK, and SfxTabDialogController::run().

◆ impl_fillQueryNames_throw() [1/2]

void pcr::FormComponentPropertyHandler::impl_fillQueryNames_throw	(	const css::uno::Reference< css::container::XNameAccess > &	_xQueryNames,
		std::vector< OUString > &	_out_rNames,
		std::u16string_view	_sName = `std::u16string_view()`
	)		const

private

describes the UI for selecting a query name

@precond m_xRowSetConnection is not <NULL>

◆ impl_fillQueryNames_throw() [2/2]

void pcr::FormComponentPropertyHandler::impl_fillQueryNames_throw ( std::vector< OUString > & _out_rNames ) const

private

describes the UI for selecting a query name

@precond m_xRowSetConnection is not <NULL>

Definition at line 2499 of file formcomponenthandler.cxx.

◆ impl_fillTableNames_throw()

void pcr::FormComponentPropertyHandler::impl_fillTableNames_throw ( std::vector< OUString > & _out_rNames ) const

private

describes the UI for selecting a table name

@precond m_xRowSetConnection is not <NULL>

Definition at line 2481 of file formcomponenthandler.cxx.

References DBG_ASSERT.

◆ impl_getContextControlContainer_nothrow()

Reference< XControlContainer > pcr::FormComponentPropertyHandler::impl_getContextControlContainer_nothrow ( ) const

private

retrieves the context for controls, whose model(s) we're inspecting

If we're inspecting a control model, this is usually part of a set of controls and control models, where the controls live in a certain context (a ->XControlContainer). If we know this context, we can enable additional special functionality.

The ->XComponentContext in which we were created is examined for a value named "ControlContext", and this value is returned.

Definition at line 2925 of file formcomponenthandler.cxx.

References any, Any, and m_xContext.

◆ impl_getDocumentURL_nothrow()

OUString pcr::FormComponentPropertyHandler::impl_getDocumentURL_nothrow ( ) const

private

returns the URL of our context document

Returns

Definition at line 3257 of file formcomponenthandler.cxx.

References DBG_UNHANDLED_EXCEPTION, Exception, and pcr::PropertyHandler::impl_getContextDocument_nothrow().

◆ impl_getPropertyValue_throw()

Any pcr::FormComponentPropertyHandler::impl_getPropertyValue_throw ( const OUString & _rPropertyName ) const

private

const-version of ->getPropertyValue

Definition at line 242 of file formcomponenthandler.cxx.

References Any, comphelper::containerToSequence(), and eType.

◆ impl_getRowSet_nothrow()

Reference< XRowSet > pcr::FormComponentPropertyHandler::impl_getRowSet_nothrow ( ) const

private

nothrow-version of ->impl_getRowSet_throw

Definition at line 2323 of file formcomponenthandler.cxx.

References Exception, and TOOLS_WARN_EXCEPTION.

◆ impl_getRowSet_throw()

Reference< XRowSet > pcr::FormComponentPropertyHandler::impl_getRowSet_throw ( ) const

private

obtains the RowSet to which our component belongs

If the component is a RowSet itself, it's returned directly. Else, the parent is examined for the XRowSet interface. If the parent is no XRowSet, then a check is made whether our component is a grid control column, and if so, the parent of the grid control is examined for the XRowSet interface.

Normally, at least one of those methods should succeed.

Definition at line 2295 of file formcomponenthandler.cxx.

References DBG_ASSERT.

◆ impl_hasValidDataSourceSignature_nothrow()

bool pcr::FormComponentPropertyHandler::impl_hasValidDataSourceSignature_nothrow	(	const css::uno::Reference< css::beans::XPropertySet > &	_xFormProperties,
		bool	_bAllowEmptyDataSourceName
	)

staticprivate

determines whether the given form has a valid data source signature.

Valid here means that the DataSource property denotes an existing data source, and the Command property is not empty. No check is made whether the value of the Command property denotes an existent object, since this would be way too expensive.

Parameters

_xFormProperties	the form to check. Must not be <NULL>.
_bAllowEmptyDataSourceName	determine whether an empty data source name is allowed (<TRUE>), and should not lead to rejection

Definition at line 3228 of file formcomponenthandler.cxx.

References Exception, PROPERTY_COMMAND, PROPERTY_DATASOURCE, and TOOLS_WARN_EXCEPTION.

◆ impl_initFieldList_nothrow()

void pcr::FormComponentPropertyHandler::impl_initFieldList_nothrow ( std::vector< OUString > & rFieldNames ) const

private

initializes the list of field names, if we're handling a control which supports the DataField property

Definition at line 2338 of file formcomponenthandler.cxx.

References pcr::clearContainer(), Exception, PROPERTY_COMMAND, PROPERTY_COMMANDTYPE, PROPERTY_DATASOURCE, SAL_WARN, and TOOLS_WARN_EXCEPTION.

◆ impl_normalizePropertyValue_nothrow()

void pcr::FormComponentPropertyHandler::impl_normalizePropertyValue_nothrow	(	css::uno::Any &	_rValue,
		PropertyId	_nPropId
	)		const

private

Definition at line 2165 of file formcomponenthandler.cxx.

References PROPERTY_ID_TABSTOP.

◆ impl_shouldExcludeProperty_nothrow()

bool pcr::FormComponentPropertyHandler::impl_shouldExcludeProperty_nothrow ( const css::beans::Property & _rProperty ) const

private

determines whether we should exclude a given property from our "supported properties"

Definition at line 2205 of file formcomponenthandler.cxx.

References SvtModuleOptions::DATABASE, pcr::eDialogControl, SvtCTLOptions::IsCTLFontEnabled(), isEmbeddedInDatabase(), PROP_FLAG_DATA_PROPERTY, PROP_FLAG_EXPERIMENTAL, PROP_FLAG_REPORT_INVISIBLE, PROPERTY_FORMATSSUPPLIER, PROPERTY_ID_CONTROLLABEL, PROPERTY_ID_DATASOURCE, PROPERTY_ID_DETAILFIELDS, PROPERTY_ID_EFFECTIVE_DEFAULT, PROPERTY_ID_EFFECTIVE_MAX, PROPERTY_ID_EFFECTIVE_MIN, PROPERTY_ID_EFFECTIVE_VALUE, PROPERTY_ID_FORMATKEY, PROPERTY_ID_MASTERFIELDS, PROPERTY_ID_SCALEIMAGE, PROPERTY_ID_TEXT, PROPERTY_ID_WRITING_MODE, and PROPERTY_SCALE_MODE.

◆ impl_updateDependentProperty_nothrow()

void pcr::FormComponentPropertyHandler::impl_updateDependentProperty_nothrow	(	PropertyId	_nPropId,
		const css::uno::Reference< css::inspection::XObjectInspectorUI > &	_rxInspectorUI
	)		const

private

updates a property (UI) whose state depends on more than one other property

->actuatingPropertyChanged is called for certain properties in whose changes we expressed interes (->getActuatingProperty). Now such a property change can result in simple UI updates, for instance another property being enabled or disabled.

However, it can also result in a more complex change: The current (UI) state might depend on the value of more than one other property. Those dependent properties (their UI, more precisely) are updated in this method.

Parameters

_nPropid	the ->PropertyId of the dependent property whose UI state is to be updated
_rxInspectorUI	provides access to the property browser UI. Must not be <NULL>.

Definition at line 1788 of file formcomponenthandler.cxx.

References aEntries, Any, bIsEnabled, pcr::eFormControl, Exception, PROPERTY_BOUNDCOLUMN, PROPERTY_BUTTONTYPE, PROPERTY_COMMAND, PROPERTY_COMMANDTYPE, PROPERTY_CONTROLSOURCE, PROPERTY_DETAILFIELDS, PROPERTY_EMPTY_IS_NULL, PROPERTY_ESCAPE_PROCESSING, PROPERTY_ID_BOUNDCOLUMN, PROPERTY_ID_COMMAND, PROPERTY_ID_CONTROLSOURCE, PROPERTY_ID_DEFAULT_SELECT_SEQ, PROPERTY_ID_DETAILFIELDS, PROPERTY_ID_FILTER, PROPERTY_ID_INPUT_REQUIRED, PROPERTY_ID_SCALE_MODE, PROPERTY_ID_SCALEIMAGE, PROPERTY_ID_SELECTEDITEMS, PROPERTY_ID_SORT, PROPERTY_ID_STRINGITEMLIST, PROPERTY_ID_TARGET_FRAME, PROPERTY_ID_TYPEDITEMLIST, PROPERTY_IMAGE_URL, PROPERTY_INPUT_REQUIRED, PROPERTY_LISTSOURCE, PROPERTY_LISTSOURCETYPE, PROPERTY_MASTERFIELDS, PROPERTY_STRINGITEMLIST, PROPERTY_TARGET_FRAME, PROPERTY_TARGET_URL, SAL_WARN, and TOOLS_WARN_EXCEPTION.

◆ isReportModel()

bool pcr::FormComponentPropertyHandler::isReportModel ( ) const

private

Definition at line 2198 of file formcomponenthandler.cxx.

References xModel.

◆ onInteractivePropertySelection()

InteractiveSelectionResult SAL_CALL pcr::FormComponentPropertyHandler::onInteractivePropertySelection	(	const OUString &	_rPropertyName,
		sal_Bool	_bPrimary,
		css::uno::Any &	_rData,
		const css::uno::Reference< css::inspection::XObjectInspectorUI > &	_rxInspectorUI
	)

overrideprotectedvirtual

Reimplemented from pcr::PropertyHandler.

Definition at line 1384 of file formcomponenthandler.cxx.

References m_aMutex, PROPERTY_ID_ACTIVESELECTIONBACKGROUNDCOLOR, PROPERTY_ID_ACTIVESELECTIONTEXTCOLOR, PROPERTY_ID_BACKGROUNDCOLOR, PROPERTY_ID_BORDERCOLOR, PROPERTY_ID_COMMAND, PROPERTY_ID_CONTROLLABEL, PROPERTY_ID_DATASOURCE, PROPERTY_ID_DEFAULT_SELECT_SEQ, PROPERTY_ID_DETAILFIELDS, PROPERTY_ID_FILLCOLOR, PROPERTY_ID_FILTER, PROPERTY_ID_FONT, PROPERTY_ID_FORMATKEY, PROPERTY_ID_GRIDLINECOLOR, PROPERTY_ID_HEADERBACKGROUNDCOLOR, PROPERTY_ID_HEADERTEXTCOLOR, PROPERTY_ID_IMAGE_URL, PROPERTY_ID_INACTIVESELECTIONBACKGROUNDCOLOR, PROPERTY_ID_INACTIVESELECTIONTEXTCOLOR, PROPERTY_ID_LISTSOURCE, PROPERTY_ID_MASTERFIELDS, PROPERTY_ID_SELECTEDITEMS, PROPERTY_ID_SORT, PROPERTY_ID_SYMBOLCOLOR, PROPERTY_ID_TABINDEX, and PROPERTY_ID_TARGET_URL.

◆ onNewComponent()

void pcr::FormComponentPropertyHandler::onNewComponent ( )

overrideprotectedvirtual

called when XPropertyHandler::inspect has been called, and we thus have a new component to inspect

Reimplemented from pcr::PropertyHandler.

Definition at line 2022 of file formcomponenthandler.cxx.

References pcr::eDialogControl, pcr::eFormControl, pcr::eUnknown, Exception, PROPERTY_HEIGHT, PROPERTY_POSITIONX, PROPERTY_POSITIONY, PROPERTY_STEP, PROPERTY_TABINDEX, PROPERTY_WIDTH, and TOOLS_WARN_EXCEPTION.

◆ operator=()

FormComponentPropertyHandler & pcr::FormComponentPropertyHandler::operator= ( const FormComponentPropertyHandler & )

privatedelete

◆ removePropertyChangeListener()

void SAL_CALL pcr::FormComponentPropertyHandler::removePropertyChangeListener ( const css::uno::Reference< css::beans::XPropertyChangeListener > & _rxListener )

overrideprotectedvirtual

Reimplemented from pcr::PropertyHandler.

Definition at line 797 of file formcomponenthandler.cxx.

References m_aMutex.

◆ setPropertyValue()

void SAL_CALL pcr::FormComponentPropertyHandler::setPropertyValue	(	const OUString &	_rPropertyName,
		const css::uno::Any &	_rValue
	)

overrideprotectedvirtual

Definition at line 310 of file formcomponenthandler.cxx.

References Any, aStr, DBG_ASSERT, eType, i, Locale, m_aMutex, PROPERTY_GRAPHIC, PROPERTY_ID_FONT, PROPERTY_ID_IMAGE_URL, PROPERTY_NAME, PROPERTY_ROWSET, and SAL_WARN.

◆ suspend()

sal_Bool SAL_CALL pcr::FormComponentPropertyHandler::suspend ( sal_Bool _bSuspend )

overrideprotectedvirtual

Reimplemented from pcr::PropertyHandler.

Definition at line 2013 of file formcomponenthandler.cxx.

References m_aMutex.

Member Data Documentation

◆ m_aPropertiesWithDefListEntry

std::set< OUString > pcr::FormComponentPropertyHandler::m_aPropertiesWithDefListEntry

private

all properties to whose control's we added ->m_sDefaultValueString

Definition at line 78 of file formcomponenthandler.hxx.

◆ m_bComponentIsSubForm

bool pcr::FormComponentPropertyHandler::m_bComponentIsSubForm

private

is our component a (database) sub form?

Definition at line 82 of file formcomponenthandler.hxx.

◆ m_bHaveCommand

bool pcr::FormComponentPropertyHandler::m_bHaveCommand

private

our component has a "Command" property

Definition at line 86 of file formcomponenthandler.hxx.

Referenced by doDescribeSupportedProperties().

◆ m_bHaveListSource

bool pcr::FormComponentPropertyHandler::m_bHaveListSource

private

our component has a "ListSource" property

Definition at line 84 of file formcomponenthandler.hxx.

Referenced by doDescribeSupportedProperties().

◆ m_eComponentClass

ComponentClassification pcr::FormComponentPropertyHandler::m_eComponentClass

private

type of our component

Definition at line 80 of file formcomponenthandler.hxx.

◆ m_nClassId

sal_Int16 pcr::FormComponentPropertyHandler::m_nClassId

private

the class id of the component - if applicable

Definition at line 88 of file formcomponenthandler.hxx.

◆ m_sDefaultValueString

OUString pcr::FormComponentPropertyHandler::m_sDefaultValueString

private

the string indicating a "default" (VOID) value in list-like controls

Definition at line 76 of file formcomponenthandler.hxx.

◆ m_xBrowserUI

css::uno::Reference< css::inspection::XObjectInspectorUI > pcr::FormComponentPropertyHandler::m_xBrowserUI

private

Definition at line 73 of file formcomponenthandler.hxx.

Referenced by impl_doDesignSQLCommand_nothrow().

◆ m_xCommandDesigner

::rtl::Reference< SQLCommandDesigner > pcr::FormComponentPropertyHandler::m_xCommandDesigner

private

helper component encapsulating the handling for the QueryDesign component for interactively designing an SQL command

Definition at line 72 of file formcomponenthandler.hxx.

Referenced by impl_doDesignSQLCommand_nothrow().

◆ m_xObjectParent

css::uno::Reference< css::uno::XInterface > pcr::FormComponentPropertyHandler::m_xObjectParent

private

the parent of our component

Definition at line 64 of file formcomponenthandler.hxx.

◆ m_xPropertyState

css::uno::Reference< css::beans::XPropertyState > pcr::FormComponentPropertyHandler::m_xPropertyState

private

access to property states

Definition at line 62 of file formcomponenthandler.hxx.

◆ m_xRowSet

css::uno::Reference< css::sdbc::XRowSet > pcr::FormComponentPropertyHandler::m_xRowSet

private

Definition at line 68 of file formcomponenthandler.hxx.

◆ m_xRowSetConnection

mutable::dbtools::SharedConnection pcr::FormComponentPropertyHandler::m_xRowSetConnection

private

the database connection. Owned by us if and only if we created it ourself.

Definition at line 67 of file formcomponenthandler.hxx.

Referenced by impl_doDesignSQLCommand_nothrow().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FormComponentPropertyHandler() [1/2]

◆ ~FormComponentPropertyHandler()

◆ FormComponentPropertyHandler() [2/2]

Member Function Documentation

◆ actuatingPropertyChanged()

◆ addPropertyChangeListener()

◆ convertToControlValue()

◆ convertToPropertyValue()

◆ createArrayHelper()

◆ DECL_LINK()

◆ describePropertyLine()

◆ disposing()

◆ doDescribeSupportedProperties()

◆ getActuatingProperties()

◆ getImplementationName()

◆ getInfoHelper()

◆ getPropertySetInfo()

◆ getPropertyState()

◆ getPropertyValue()

◆ getSupersededProperties()

◆ getSupportedServiceNames()

◆ impl_browseForDatabaseDocument_throw()

◆ impl_browseForImage_nothrow()

◆ impl_browseForTargetURL_nothrow()

◆ impl_classifyControlModel_throw()

◆ impl_describeCursorSource_nothrow()

◆ impl_describeListSourceUI_throw()

◆ impl_dialogChangeTabOrder_nothrow()

◆ impl_dialogChooseLabelControl_nothrow()

◆ impl_dialogColorChooser_throw()

◆ impl_dialogFilterOrSort_nothrow()

◆ impl_dialogFormatting_nothrow()

◆ impl_dialogLinkedFormFields_nothrow()

◆ impl_dialogListSelection_nothrow()

◆ impl_displaySQLError_nothrow()

◆ impl_doDesignSQLCommand_nothrow()

◆ impl_ensureRowsetConnection_nothrow()

◆ impl_executeFontDialog_nothrow()

◆ impl_fillQueryNames_throw() [1/2]

◆ impl_fillQueryNames_throw() [2/2]

◆ impl_fillTableNames_throw()

◆ impl_getContextControlContainer_nothrow()

◆ impl_getDocumentURL_nothrow()

◆ impl_getPropertyValue_throw()

◆ impl_getRowSet_nothrow()

◆ impl_getRowSet_throw()

◆ impl_hasValidDataSourceSignature_nothrow()

◆ impl_initFieldList_nothrow()

◆ impl_normalizePropertyValue_nothrow()

◆ impl_shouldExcludeProperty_nothrow()

◆ impl_updateDependentProperty_nothrow()

◆ isReportModel()

◆ onInteractivePropertySelection()

◆ onNewComponent()

◆ operator=()

◆ removePropertyChangeListener()

◆ setPropertyValue()

◆ suspend()

Member Data Documentation

◆ m_aPropertiesWithDefListEntry

◆ m_bComponentIsSubForm

◆ m_bHaveCommand

◆ m_bHaveListSource

◆ m_eComponentClass

◆ m_nClassId

◆ m_sDefaultValueString

◆ m_xBrowserUI

◆ m_xCommandDesigner

◆ m_xObjectParent

◆ m_xPropertyState

◆ m_xRowSet

◆ m_xRowSetConnection