LibreOffice Module fpicker (master) 1
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
svt::OCommonPicker Class Referenceabstract

implements common functionality for the 2 UNO picker components More...

#include <commonpicker.hxx>

Inheritance diagram for svt::OCommonPicker:
[legend]
Collaboration diagram for svt::OCommonPicker:
[legend]

Public Member Functions

 OCommonPicker ()
 
- Public Member Functions inherited from comphelper::OPropertyContainer
virtual ~OPropertyContainer ()
 
- Public Member Functions inherited from comphelper::OPropertyArrayUsageHelper< OCommonPicker >
 OPropertyArrayUsageHelper ()
 
virtual ~OPropertyArrayUsageHelper ()
 
::cppu::IPropertyArrayHelper * getArrayHelper ()
 

Protected Member Functions

const ::cppu::OBroadcastHelper & GetBroadcastHelper () const
 
::cppu::OBroadcastHelper & GetBroadcastHelper ()
 
virtual ~OCommonPicker () override
 
virtual std::shared_ptr< SvtFileDialog_Base > implCreateDialog (weld::Window *pParent)=0
 
virtual sal_Int16 implExecutePicker ()=0
 
virtual void SAL_CALL disposing () override
 
virtual void SAL_CALL disposing (const css::lang::EventObject &Source) override
 
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo () override
 
virtual ::cppu::IPropertyArrayHelper &SAL_CALL getInfoHelper () override
 
virtual ::cppu::IPropertyArrayHelper * createArrayHelper () const override
 
virtual void SAL_CALL setFastPropertyValue_NoBroadcast (sal_Int32 _nHandle, const css::uno::Any &_rValue) override
 
virtual void SAL_CALL setTitle (const OUString &_rTitle)
 
virtual sal_Int16 SAL_CALL execute ()
 
virtual void SAL_CALL setControlProperty (const OUString &aControlName, const OUString &aControlProperty, const css::uno::Any &aValue) override
 
virtual css::uno::Any SAL_CALL getControlProperty (const OUString &aControlName, const OUString &aControlProperty) override
 
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedControls () override
 
virtual sal_Bool SAL_CALL isControlSupported (const OUString &aControlName) override
 
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedControlProperties (const OUString &aControlName) override
 
virtual sal_Bool SAL_CALL isControlPropertySupported (const OUString &aControlName, const OUString &aControlProperty) override
 
virtual void SAL_CALL cancel () override
 
virtual void SAL_CALL initialize (const css::uno::Sequence< css::uno::Any > &aArguments) override
 
void checkAlive () const
 
void prepareDialog ()
 
bool createPicker ()
 
virtual bool implHandleInitializationArgument (const OUString &_rName, const css::uno::Any &_rValue)
 handle a single argument from the XInitialization::initialize method More...
 
- 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
 

Protected Attributes

OUString m_aTitle
 
OUString m_aDisplayDirectory
 
std::shared_ptr< SvtFileDialog_Base > m_xDlg
 
- Protected Attributes inherited from cppu::BaseMutex
mutable::osl::Mutex m_aMutex
 

Private Member Functions

void stopWindowListening ()
 
 DECL_LINK (OnCancelPicker, void *, void)
 

Private Attributes

OUString m_sHelpURL
 
css::uno::Reference< css::awt::XWindow > m_xWindow
 
ImplSVEvent * m_nCancelEvent
 
bool m_bExecuting
 
css::uno::Reference< css::awt::XWindow > m_xDialogParent
 
css::uno::Reference< css::lang::XComponent > m_xWindowListenerAdapter
 
css::uno::Reference< css::lang::XComponent > m_xParentListenerAdapter
 

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< OCommonPicker >
static std::mutex & theMutex ()
 
- Static Protected Attributes inherited from comphelper::OPropertyArrayUsageHelper< OCommonPicker >
static sal_Int32 s_nRefCount
 
::cppu::IPropertyArrayHelper * s_pProps
 

Detailed Description

implements common functionality for the 2 UNO picker components

Definition at line 50 of file commonpicker.hxx.

Constructor & Destructor Documentation

◆ OCommonPicker()

svt::OCommonPicker::OCommonPicker ( )

Definition at line 53 of file commonpicker.cxx.

References m_aMutex, m_sHelpURL, m_xWindow, PROPERTY_ID_HELPURL, PROPERTY_ID_WINDOW, and comphelper::OPropertyContainerHelper::registerProperty().

◆ ~OCommonPicker()

svt::OCommonPicker::~OCommonPicker ( )
overrideprotectedvirtual

Definition at line 74 of file commonpicker.cxx.

References dispose(), and GetBroadcastHelper().

Member Function Documentation

◆ cancel()

void SAL_CALL svt::OCommonPicker::cancel ( )
overrideprotectedvirtual

Reimplemented in SvtFilePicker.

Definition at line 366 of file commonpicker.cxx.

References LINK, cppu::BaseMutex::m_aMutex, m_nCancelEvent, and Application::PostUserEvent().

Referenced by SvtFilePicker::cancel().

◆ checkAlive()

void svt::OCommonPicker::checkAlive ( ) const
protected

Definition at line 96 of file commonpicker.cxx.

Referenced by SvtFilePicker::addFilePickerListener(), SvtFilePicker::appendFilter(), SvtFilePicker::appendFilterGroup(), SvtFilePicker::enableControl(), SvtFilePicker::getAvailableHeight(), SvtFilePicker::getAvailableWidth(), getControlProperty(), SvtFilePicker::getCurrentFilter(), SvtFilePicker::getDisplayDirectory(), SvtFilePicker::getLabel(), SvtFilePicker::getSelectedFiles(), SvtFilePicker::getShowState(), getSupportedControlProperties(), getSupportedControls(), SvtFilePicker::getSupportedImageFormats(), SvtFilePicker::getValue(), initialize(), SvtFilePicker::initialize(), isControlPropertySupported(), isControlSupported(), SvtFilePicker::removeFilePickerListener(), setControlProperty(), SvtFilePicker::setCurrentFilter(), SvtFilePicker::setDefaultName(), SvtFilePicker::setDisplayDirectory(), SvtFilePicker::setImage(), SvtFilePicker::setLabel(), SvtFilePicker::setMultiSelectionMode(), SvtFilePicker::setShowState(), and SvtFilePicker::setValue().

◆ createArrayHelper()

cppu::IPropertyArrayHelper * svt::OCommonPicker::createArrayHelper ( ) const
overrideprotectedvirtual

Implements comphelper::OPropertyArrayUsageHelper< OCommonPicker >.

Definition at line 171 of file commonpicker.cxx.

References comphelper::OPropertyContainerHelper::describeProperties().

◆ createPicker()

bool svt::OCommonPicker::createPicker ( )
protected

Definition at line 200 of file commonpicker.cxx.

References Application::GetFrameWeld(), svt::OControlAccess::getHelpURL(), VCLUnoHelper::GetInterface(), VCLUnoHelper::GetWindow(), weld::Window::GetXWindow(), implCreateDialog(), m_sHelpURL, m_xDialogParent, m_xDlg, m_xParentListenerAdapter, m_xWindow, m_xWindowListenerAdapter, SAL_WARN_IF, and svt::OControlAccess::setHelpURL().

Referenced by getControlProperty(), getSupportedControlProperties(), getSupportedControls(), isControlPropertySupported(), isControlSupported(), prepareDialog(), and setControlProperty().

◆ DECL_LINK()

svt::OCommonPicker::DECL_LINK ( OnCancelPicker  ,
void *  ,
void   
)
private

◆ disposing() [1/2]

void SAL_CALL svt::OCommonPicker::disposing ( )
overrideprotectedvirtual

Definition at line 113 of file commonpicker.cxx.

References cppu::BaseMutex::m_aMutex, m_bExecuting, m_nCancelEvent, m_xDialogParent, m_xDlg, m_xWindow, Application::RemoveUserEvent(), RET_CANCEL, and stopWindowListening().

◆ disposing() [2/2]

virtual void SAL_CALL svt::OCommonPicker::disposing ( const css::lang::EventObject &  Source)
overrideprotectedvirtual

◆ execute()

sal_Int16 svt::OCommonPicker::execute ( )
protectedvirtual
Exceptions
css::uno::RuntimeException

Reimplemented in SvtFilePicker.

Definition at line 344 of file commonpicker.cxx.

References implExecutePicker(), cppu::BaseMutex::m_aMutex, m_bExecuting, and prepareDialog().

◆ GetBroadcastHelper() [1/2]

::cppu::OBroadcastHelper & svt::OCommonPicker::GetBroadcastHelper ( )
inlineprotected

Definition at line 78 of file commonpicker.hxx.

◆ GetBroadcastHelper() [2/2]

const ::cppu::OBroadcastHelper & svt::OCommonPicker::GetBroadcastHelper ( ) const
inlineprotected

Definition at line 77 of file commonpicker.hxx.

Referenced by ~OCommonPicker().

◆ getControlProperty()

Any SAL_CALL svt::OCommonPicker::getControlProperty ( const OUString &  aControlName,
const OUString &  aControlProperty 
)
overrideprotectedvirtual

Definition at line 264 of file commonpicker.cxx.

References Any, checkAlive(), createPicker(), svt::OControlAccess::getControlProperty(), and m_xDlg.

◆ getInfoHelper()

cppu::IPropertyArrayHelper &SAL_CALL svt::OCommonPicker::getInfoHelper ( )
overrideprotected

Definition at line 178 of file commonpicker.cxx.

References comphelper::OPropertyArrayUsageHelper< OCommonPicker >::getArrayHelper().

Referenced by getPropertySetInfo().

◆ getPropertySetInfo()

Reference< XPropertySetInfo > SAL_CALL svt::OCommonPicker::getPropertySetInfo ( )
overrideprotectedvirtual

Definition at line 183 of file commonpicker.cxx.

References getInfoHelper().

◆ getSupportedControlProperties()

Sequence< OUString > SAL_CALL svt::OCommonPicker::getSupportedControlProperties ( const OUString &  aControlName)
overrideprotectedvirtual

Definition at line 306 of file commonpicker.cxx.

References checkAlive(), createPicker(), svt::OControlAccess::getSupportedControlProperties(), and m_xDlg.

◆ getSupportedControls()

Sequence< OUString > SAL_CALL svt::OCommonPicker::getSupportedControls ( )
overrideprotectedvirtual

Definition at line 279 of file commonpicker.cxx.

References checkAlive(), createPicker(), svt::OControlAccess::getSupportedControls(), and m_xDlg.

◆ implCreateDialog()

virtual std::shared_ptr< SvtFileDialog_Base > svt::OCommonPicker::implCreateDialog ( weld::Window *  pParent)
protectedpure virtual

Implemented in SvtFilePicker, and SvtRemoteFilePicker.

Referenced by createPicker().

◆ implExecutePicker()

virtual sal_Int16 svt::OCommonPicker::implExecutePicker ( )
protectedpure virtual

Implemented in SvtFilePicker.

References DECLARE_XINTERFACE.

Referenced by execute().

◆ implHandleInitializationArgument()

bool svt::OCommonPicker::implHandleInitializationArgument ( const OUString &  _rName,
const css::uno::Any &  _rValue 
)
protectedvirtual

handle a single argument from the XInitialization::initialize method

Returns
<TRUE> if the argument could be handled

Reimplemented in SvtFilePicker.

Definition at line 460 of file commonpicker.cxx.

References m_xDialogParent.

Referenced by initialize().

◆ initialize()

void SAL_CALL svt::OCommonPicker::initialize ( const css::uno::Sequence< css::uno::Any > &  aArguments)
overrideprotectedvirtual

Reimplemented in SvtFilePicker.

Definition at line 407 of file commonpicker.cxx.

References Any, checkAlive(), DBG_ASSERT, implHandleInitializationArgument(), OUStringToOString(), and SAL_WARN.

◆ isControlPropertySupported()

sal_Bool SAL_CALL svt::OCommonPicker::isControlPropertySupported ( const OUString &  aControlName,
const OUString &  aControlProperty 
)
overrideprotectedvirtual

Definition at line 320 of file commonpicker.cxx.

References checkAlive(), createPicker(), svt::OControlAccess::isControlPropertySupported(), and m_xDlg.

◆ isControlSupported()

sal_Bool SAL_CALL svt::OCommonPicker::isControlSupported ( const OUString &  aControlName)
overrideprotectedvirtual

Definition at line 293 of file commonpicker.cxx.

References checkAlive(), createPicker(), and svt::OControlAccess::isControlSupported().

◆ prepareDialog()

void svt::OCommonPicker::prepareDialog ( )
protected

Definition at line 102 of file commonpicker.cxx.

References createPicker(), m_aTitle, and m_xDlg.

Referenced by execute(), and SvtFilePicker::startExecuteModal().

◆ setControlProperty()

void SAL_CALL svt::OCommonPicker::setControlProperty ( const OUString &  aControlName,
const OUString &  aControlProperty,
const css::uno::Any &  aValue 
)
overrideprotectedvirtual

Definition at line 252 of file commonpicker.cxx.

References checkAlive(), createPicker(), m_xDlg, and svt::OControlAccess::setControlProperty().

◆ setFastPropertyValue_NoBroadcast()

void SAL_CALL svt::OCommonPicker::setFastPropertyValue_NoBroadcast ( sal_Int32  _nHandle,
const css::uno::Any &  _rValue 
)
overrideprotectedvirtual

Reimplemented from comphelper::OPropertyContainer.

Definition at line 188 of file commonpicker.cxx.

References m_sHelpURL, m_xDlg, nHandle, PROPERTY_ID_HELPURL, and svt::OControlAccess::setHelpURL().

◆ setTitle()

void svt::OCommonPicker::setTitle ( const OUString &  _rTitle)
protectedvirtual
Exceptions
css::uno::RuntimeException

Reimplemented in SvtFilePicker.

Definition at line 337 of file commonpicker.cxx.

References m_aTitle.

◆ stopWindowListening()

void svt::OCommonPicker::stopWindowListening ( )
private

Definition at line 134 of file commonpicker.cxx.

References disposeComponent(), m_xParentListenerAdapter, and m_xWindowListenerAdapter.

Referenced by disposing().

Member Data Documentation

◆ m_aDisplayDirectory

OUString svt::OCommonPicker::m_aDisplayDirectory
protected

Definition at line 72 of file commonpicker.hxx.

Referenced by SvtFilePicker::getDisplayDirectory(), SvtFilePicker::prepareExecute(), and SvtFilePicker::setDisplayDirectory().

◆ m_aTitle

OUString svt::OCommonPicker::m_aTitle
protected

Definition at line 71 of file commonpicker.hxx.

Referenced by prepareDialog(), and setTitle().

◆ m_bExecuting

bool svt::OCommonPicker::m_bExecuting
private

Definition at line 63 of file commonpicker.hxx.

Referenced by disposing(), and execute().

◆ m_nCancelEvent

ImplSVEvent* svt::OCommonPicker::m_nCancelEvent
private

Definition at line 62 of file commonpicker.hxx.

Referenced by cancel(), and disposing().

◆ m_sHelpURL

OUString svt::OCommonPicker::m_sHelpURL
private

Definition at line 58 of file commonpicker.hxx.

Referenced by createPicker(), OCommonPicker(), and setFastPropertyValue_NoBroadcast().

◆ m_xDialogParent

css::uno::Reference< css::awt::XWindow > svt::OCommonPicker::m_xDialogParent
private

Definition at line 65 of file commonpicker.hxx.

Referenced by createPicker(), disposing(), and implHandleInitializationArgument().

◆ m_xDlg

std::shared_ptr<SvtFileDialog_Base> svt::OCommonPicker::m_xDlg
protected

Definition at line 75 of file commonpicker.hxx.

Referenced by createPicker(), disposing(), SvtFilePicker::enableControl(), SvtFilePicker::getAvailableHeight(), SvtFilePicker::getAvailableWidth(), getControlProperty(), SvtFilePicker::getCurrentFilter(), SvtFilePicker::getDisplayDirectory(), SvtFilePicker::getLabel(), SvtFilePicker::getSelectedFiles(), SvtFilePicker::getShowState(), getSupportedControlProperties(), getSupportedControls(), SvtFilePicker::getValue(), SvtFilePicker::implExecutePicker(), isControlPropertySupported(), prepareDialog(), SvtFilePicker::prepareExecute(), setControlProperty(), SvtFilePicker::setCurrentFilter(), setFastPropertyValue_NoBroadcast(), SvtFilePicker::setImage(), SvtFilePicker::setLabel(), SvtFilePicker::setShowState(), SvtFilePicker::setValue(), and SvtFilePicker::startExecuteModal().

◆ m_xParentListenerAdapter

css::uno::Reference< css::lang::XComponent > svt::OCommonPicker::m_xParentListenerAdapter
private

Definition at line 68 of file commonpicker.hxx.

Referenced by createPicker(), and stopWindowListening().

◆ m_xWindow

css::uno::Reference< css::awt::XWindow > svt::OCommonPicker::m_xWindow
private

Definition at line 59 of file commonpicker.hxx.

Referenced by createPicker(), disposing(), and OCommonPicker().

◆ m_xWindowListenerAdapter

css::uno::Reference< css::lang::XComponent > svt::OCommonPicker::m_xWindowListenerAdapter
private

Definition at line 67 of file commonpicker.hxx.

Referenced by createPicker(), and stopWindowListening().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:29:13 for LibreOffice Module fpicker (master) by doxygen 1.9.3