LibreOffice Module fpicker (master) 1
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SvtFilePicker Class Reference

#include <OfficeFilePicker.hxx>

Inheritance diagram for SvtFilePicker:
[legend]
Collaboration diagram for SvtFilePicker:
[legend]

Public Member Functions

 SvtFilePicker ()
 
virtual ~SvtFilePicker () override
 
virtual void SAL_CALL setTitle (const OUString &_rTitle) override
 
virtual sal_Int16 SAL_CALL execute () override
 
virtual void SAL_CALL setDialogTitle (const OUString &_rTitle) override
 
virtual void SAL_CALL startExecuteModal (const css::uno::Reference< css::ui::dialogs::XDialogClosedListener > &xListener) override
 
virtual void SAL_CALL setMultiSelectionMode (sal_Bool bMode) override
 
virtual void SAL_CALL setDefaultName (const OUString &aName) override
 
virtual void SAL_CALL setDisplayDirectory (const OUString &aDirectory) override
 
virtual OUString SAL_CALL getDisplayDirectory () override
 
virtual css::uno::Sequence< OUString > SAL_CALL getFiles () override
 
virtual css::uno::Sequence< OUString > SAL_CALL getSelectedFiles () override
 
virtual void SAL_CALL setValue (sal_Int16 ElementID, sal_Int16 ControlAction, const css::uno::Any &value) override
 
virtual css::uno::Any SAL_CALL getValue (sal_Int16 ElementID, sal_Int16 ControlAction) override
 
virtual void SAL_CALL setLabel (sal_Int16 ElementID, const OUString &aValue) override
 
virtual OUString SAL_CALL getLabel (sal_Int16 ElementID) override
 
virtual void SAL_CALL enableControl (sal_Int16 ElementID, sal_Bool bEnable) override
 
virtual void SAL_CALL addFilePickerListener (const css::uno::Reference< css::ui::dialogs::XFilePickerListener > &xListener) override
 
virtual void SAL_CALL removeFilePickerListener (const css::uno::Reference< css::ui::dialogs::XFilePickerListener > &xListener) override
 
virtual css::uno::Sequence< sal_Int16 > SAL_CALL getSupportedImageFormats () override
 
virtual sal_Int32 SAL_CALL getTargetColorDepth () override
 
virtual sal_Int32 SAL_CALL getAvailableWidth () override
 
virtual sal_Int32 SAL_CALL getAvailableHeight () override
 
virtual void SAL_CALL setImage (sal_Int16 aImageFormat, const css::uno::Any &aImage) override
 
virtual sal_Bool SAL_CALL setShowState (sal_Bool bShowState) override
 
virtual sal_Bool SAL_CALL getShowState () override
 
virtual void SAL_CALL appendFilter (const OUString &aTitle, const OUString &aFilter) override
 
virtual void SAL_CALL setCurrentFilter (const OUString &aTitle) override
 
virtual OUString SAL_CALL getCurrentFilter () override
 
virtual void SAL_CALL appendFilterGroup (const OUString &sGroupTitle, const css::uno::Sequence< css::beans::StringPair > &aFilters) override
 
virtual void SAL_CALL cancel () override
 
virtual void SAL_CALL dispose () override
 
virtual void SAL_CALL addEventListener (const css::uno::Reference< css::lang::XEventListener > &l) override
 
virtual void SAL_CALL removeEventListener (const css::uno::Reference< css::lang::XEventListener > &l) override
 
virtual void SAL_CALL initialize (const css::uno::Sequence< css::uno::Any > &aArguments) override
 
virtual OUString SAL_CALL getImplementationName () override
 
virtual sal_Bool SAL_CALL supportsService (const OUString &sServiceName) override
 
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames () override
 
- Public Member Functions inherited from cppu::ImplHelper5< class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5 >
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 svt::OCommonPicker
 OCommonPicker ()
 
- Public Member Functions inherited from comphelper::OPropertyContainer
virtual ~OPropertyContainer ()
 
- Public Member Functions inherited from comphelper::OPropertyArrayUsageHelper< OCommonPicker >
 OPropertyArrayUsageHelper ()
 
virtual ~OPropertyArrayUsageHelper ()
 
::cppu::IPropertyArrayHelpergetArrayHelper ()
 
virtual void notify (sal_Int16 nEventId, sal_Int16 nControlId)=0
 

Protected Member Functions

virtual std::shared_ptr< SvtFileDialog_BaseimplCreateDialog (weld::Window *pParent) override
 
virtual sal_Int16 implExecutePicker () override
 
virtual bool implHandleInitializationArgument (const OUString &_rName, const css::uno::Any &_rValue) override
 handle a single argument from the XInitialization::initialize method More...
 
PickerFlags getPickerFlags () const
 
virtual void notify (sal_Int16 _nEventId, sal_Int16 _nControlId) override
 
bool FilterNameExists (const OUString &rTitle)
 
bool FilterNameExists (const UnoFilterList &_rGroupedFilters)
 
void ensureFilterList (const OUString &_rInitialCurrentFilter)
 
void prepareExecute ()
 
void DialogClosedHdl (sal_Int32 nResult)
 
- Protected Member Functions inherited from cppu::ImplHelper5< class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5 >
 ~ImplHelper5 () SAL_NOEXCEPT
 
- Protected Member Functions inherited from svt::OCommonPicker
const ::cppu::OBroadcastHelperGetBroadcastHelper () const
 
::cppu::OBroadcastHelperGetBroadcastHelper ()
 
virtual ~OCommonPicker () override
 
virtual std::shared_ptr< SvtFileDialog_BaseimplCreateDialog (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::IPropertyArrayHelpercreateArrayHelper () 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::IPropertyArrayHelpercreateArrayHelper () const =0
 
- Protected Member Functions inherited from svt::IFilePickerListener
 ~IFilePickerListener ()
 

Protected Attributes

std::unique_ptr< FilterListm_pFilterList
 
std::unique_ptr< ElementListm_pElemList
 
bool m_bMultiSelection
 
sal_Int16 m_nServiceType
 
OUString m_aDefaultName
 
OUString m_aCurrentFilter
 
OUString m_aOldDisplayDirectory
 
OUString m_aOldHideDirectory
 
OUString m_aStandardDir
 
css::uno::Sequence< OUString > m_aDenyList
 
css::uno::Reference< css::ui::dialogs::XFilePickerListener > m_xListener
 
css::uno::Reference< css::ui::dialogs::XDialogClosedListener > m_xDlgClosedListener
 
- Protected Attributes inherited from svt::OCommonPicker
OUString m_aTitle
 
OUString m_aDisplayDirectory
 
std::shared_ptr< SvtFileDialog_Basem_xDlg
 
- Protected Attributes inherited from cppu::BaseMutex
mutable::osl::Mutex m_aMutex
 

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::mutextheMutex ()
 
- Static Protected Attributes inherited from comphelper::OPropertyArrayUsageHelper< OCommonPicker >
static sal_Int32 s_nRefCount
 
::cppu::IPropertyArrayHelpers_pProps
 

Detailed Description

Definition at line 56 of file OfficeFilePicker.hxx.

Constructor & Destructor Documentation

◆ SvtFilePicker()

SvtFilePicker::SvtFilePicker ( )

Definition at line 408 of file OfficeFilePicker.cxx.

◆ ~SvtFilePicker()

SvtFilePicker::~SvtFilePicker ( )
overridevirtual

Definition at line 414 of file OfficeFilePicker.cxx.

Member Function Documentation

◆ addEventListener()

virtual void SAL_CALL SvtFilePicker::addEventListener ( const css::uno::Reference< css::lang::XEventListener > &  l)
inlineoverridevirtual

Definition at line 169 of file OfficeFilePicker.hxx.

◆ addFilePickerListener()

void SAL_CALL SvtFilePicker::addFilePickerListener ( const css::uno::Reference< css::ui::dialogs::XFilePickerListener > &  xListener)
overridevirtual

Definition at line 763 of file OfficeFilePicker.cxx.

References svt::OCommonPicker::checkAlive(), and m_xListener.

◆ appendFilter()

void SAL_CALL SvtFilePicker::appendFilter ( const OUString &  aTitle,
const OUString &  aFilter 
)
overridevirtual

◆ appendFilterGroup()

void SAL_CALL SvtFilePicker::appendFilterGroup ( const OUString &  sGroupTitle,
const css::uno::Sequence< css::beans::StringPair > &  aFilters 
)
overridevirtual

◆ cancel()

virtual void SAL_CALL SvtFilePicker::cancel ( )
inlineoverridevirtual

Reimplemented from svt::OCommonPicker.

Definition at line 165 of file OfficeFilePicker.hxx.

References svt::OCommonPicker::cancel().

◆ DialogClosedHdl()

void SvtFilePicker::DialogClosedHdl ( sal_Int32  nResult)
protected

Definition at line 213 of file OfficeFilePicker.cxx.

References aEvent, and m_xDlgClosedListener.

Referenced by startExecuteModal().

◆ dispose()

virtual void SAL_CALL SvtFilePicker::dispose ( void  )
inlineoverridevirtual

Definition at line 167 of file OfficeFilePicker.hxx.

◆ enableControl()

void SAL_CALL SvtFilePicker::enableControl ( sal_Int16  ElementID,
sal_Bool  bEnable 
)
overridevirtual

◆ ensureFilterList()

void SvtFilePicker::ensureFilterList ( const OUString &  _rInitialCurrentFilter)
protected

Definition at line 394 of file OfficeFilePicker.cxx.

References m_aCurrentFilter, and m_pFilterList.

Referenced by appendFilter(), and appendFilterGroup().

◆ execute()

sal_Int16 SAL_CALL SvtFilePicker::execute ( )
overridevirtual
Exceptions
css::uno::RuntimeException

Reimplemented from svt::OCommonPicker.

Definition at line 486 of file OfficeFilePicker.cxx.

◆ FilterNameExists() [1/2]

bool SvtFilePicker::FilterNameExists ( const OUString &  rTitle)
protected

Definition at line 359 of file OfficeFilePicker.cxx.

References m_pFilterList.

Referenced by appendFilter(), appendFilterGroup(), and setCurrentFilter().

◆ FilterNameExists() [2/2]

bool SvtFilePicker::FilterNameExists ( const UnoFilterList _rGroupedFilters)
protected

Definition at line 375 of file OfficeFilePicker.cxx.

References m_pFilterList.

◆ getAvailableHeight()

sal_Int32 SAL_CALL SvtFilePicker::getAvailableHeight ( )
overridevirtual

◆ getAvailableWidth()

sal_Int32 SAL_CALL SvtFilePicker::getAvailableWidth ( )
overridevirtual

◆ getCurrentFilter()

OUString SAL_CALL SvtFilePicker::getCurrentFilter ( )
overridevirtual

◆ getDisplayDirectory()

OUString SAL_CALL SvtFilePicker::getDisplayDirectory ( )
overridevirtual

◆ getFiles()

Sequence< OUString > SAL_CALL SvtFilePicker::getFiles ( )
overridevirtual

Definition at line 575 of file OfficeFilePicker.cxx.

References getSelectedFiles().

◆ getImplementationName()

OUString SAL_CALL SvtFilePicker::getImplementationName ( )
overridevirtual

Reimplemented in SvtRemoteFilePicker.

Definition at line 1031 of file OfficeFilePicker.cxx.

◆ getLabel()

OUString SAL_CALL SvtFilePicker::getLabel ( sal_Int16  ElementID)
overridevirtual

◆ getPickerFlags()

PickerFlags SvtFilePicker::getPickerFlags ( ) const
protected

◆ getSelectedFiles()

Sequence< OUString > SAL_CALL SvtFilePicker::getSelectedFiles ( )
overridevirtual

◆ getShowState()

sal_Bool SAL_CALL SvtFilePicker::getShowState ( )
overridevirtual

◆ getSupportedImageFormats()

Sequence< sal_Int16 > SAL_CALL SvtFilePicker::getSupportedImageFormats ( )
overridevirtual

Definition at line 781 of file OfficeFilePicker.cxx.

References svt::OCommonPicker::checkAlive().

◆ getSupportedServiceNames()

Sequence< OUString > SAL_CALL SvtFilePicker::getSupportedServiceNames ( )
overridevirtual

Reimplemented in SvtRemoteFilePicker.

Definition at line 1043 of file OfficeFilePicker.cxx.

◆ getTargetColorDepth()

sal_Int32 SAL_CALL SvtFilePicker::getTargetColorDepth ( )
overridevirtual

Definition at line 788 of file OfficeFilePicker.cxx.

◆ getValue()

Any SAL_CALL SvtFilePicker::getValue ( sal_Int16  ElementID,
sal_Int16  ControlAction 
)
overridevirtual

◆ implCreateDialog()

std::shared_ptr< SvtFileDialog_Base > SvtFilePicker::implCreateDialog ( weld::Window pParent)
overrideprotectedvirtual

Implements svt::OCommonPicker.

Reimplemented in SvtRemoteFilePicker.

Definition at line 435 of file OfficeFilePicker.cxx.

References getPickerFlags(), m_aDenyList, m_aStandardDir, and sStandardDir.

◆ implExecutePicker()

sal_Int16 SvtFilePicker::implExecutePicker ( )
overrideprotectedvirtual

Implements svt::OCommonPicker.

Definition at line 418 of file OfficeFilePicker.cxx.

References svt::OCommonPicker::m_xDlg, and prepareExecute().

◆ implHandleInitializationArgument()

bool SvtFilePicker::implHandleInitializationArgument ( const OUString &  _rName,
const css::uno::Any &  _rValue 
)
overrideprotectedvirtual

handle a single argument from the XInitialization::initialize method

Returns
<TRUE> if the argument could be handled

Reimplemented from svt::OCommonPicker.

Definition at line 1002 of file OfficeFilePicker.cxx.

References m_aDenyList, m_aStandardDir, and m_nServiceType.

◆ initialize()

void SAL_CALL SvtFilePicker::initialize ( const css::uno::Sequence< css::uno::Any > &  aArguments)
overridevirtual

◆ notify()

void SvtFilePicker::notify ( sal_Int16  _nEventId,
sal_Int16  _nControlId 
)
overrideprotectedvirtual

◆ prepareExecute()

void SvtFilePicker::prepareExecute ( )
protected

◆ removeEventListener()

virtual void SAL_CALL SvtFilePicker::removeEventListener ( const css::uno::Reference< css::lang::XEventListener > &  l)
inlineoverridevirtual

Definition at line 171 of file OfficeFilePicker.hxx.

◆ removeFilePickerListener()

void SAL_CALL SvtFilePicker::removeFilePickerListener ( const css::uno::Reference< css::ui::dialogs::XFilePickerListener > &  xListener)
overridevirtual

Definition at line 772 of file OfficeFilePicker.cxx.

References svt::OCommonPicker::checkAlive(), and m_xListener.

◆ setCurrentFilter()

void SAL_CALL SvtFilePicker::setCurrentFilter ( const OUString &  aTitle)
overridevirtual

◆ setDefaultName()

void SAL_CALL SvtFilePicker::setDefaultName ( const OUString &  aName)
overridevirtual

Definition at line 519 of file OfficeFilePicker.cxx.

References aName, svt::OCommonPicker::checkAlive(), and m_aDefaultName.

◆ setDialogTitle()

void SAL_CALL SvtFilePicker::setDialogTitle ( const OUString &  _rTitle)
overridevirtual

Definition at line 492 of file OfficeFilePicker.cxx.

References setTitle().

◆ setDisplayDirectory()

void SAL_CALL SvtFilePicker::setDisplayDirectory ( const OUString &  aDirectory)
overridevirtual

◆ setImage()

void SAL_CALL SvtFilePicker::setImage ( sal_Int16  aImageFormat,
const css::uno::Any &  aImage 
)
overridevirtual

◆ setLabel()

void SAL_CALL SvtFilePicker::setLabel ( sal_Int16  ElementID,
const OUString &  aValue 
)
overridevirtual

◆ setMultiSelectionMode()

void SAL_CALL SvtFilePicker::setMultiSelectionMode ( sal_Bool  bMode)
overridevirtual

Definition at line 511 of file OfficeFilePicker.cxx.

References svt::OCommonPicker::checkAlive(), and m_bMultiSelection.

◆ setShowState()

sal_Bool SAL_CALL SvtFilePicker::setShowState ( sal_Bool  bShowState)
overridevirtual

◆ setTitle()

void SAL_CALL SvtFilePicker::setTitle ( const OUString &  _rTitle)
overridevirtual
Exceptions
css::uno::RuntimeException

Reimplemented from svt::OCommonPicker.

Definition at line 481 of file OfficeFilePicker.cxx.

Referenced by setDialogTitle().

◆ setValue()

void SAL_CALL SvtFilePicker::setValue ( sal_Int16  ElementID,
sal_Int16  ControlAction,
const css::uno::Any &  value 
)
overridevirtual

◆ startExecuteModal()

void SAL_CALL SvtFilePicker::startExecuteModal ( const css::uno::Reference< css::ui::dialogs::XDialogClosedListener > &  xListener)
overridevirtual

◆ supportsService()

sal_Bool SAL_CALL SvtFilePicker::supportsService ( const OUString &  sServiceName)
overridevirtual

Reimplemented in SvtRemoteFilePicker.

Definition at line 1037 of file OfficeFilePicker.cxx.

References sServiceName, and cppu::supportsService().

Member Data Documentation

◆ m_aCurrentFilter

OUString SvtFilePicker::m_aCurrentFilter
protected

◆ m_aDefaultName

OUString SvtFilePicker::m_aDefaultName
protected

Definition at line 68 of file OfficeFilePicker.hxx.

Referenced by prepareExecute(), and setDefaultName().

◆ m_aDenyList

css::uno::Sequence< OUString > SvtFilePicker::m_aDenyList
protected

◆ m_aOldDisplayDirectory

OUString SvtFilePicker::m_aOldDisplayDirectory
protected

Definition at line 71 of file OfficeFilePicker.hxx.

Referenced by getDisplayDirectory().

◆ m_aOldHideDirectory

OUString SvtFilePicker::m_aOldHideDirectory
protected

Definition at line 72 of file OfficeFilePicker.hxx.

Referenced by getDisplayDirectory().

◆ m_aStandardDir

OUString SvtFilePicker::m_aStandardDir
protected

◆ m_bMultiSelection

bool SvtFilePicker::m_bMultiSelection
protected

Definition at line 66 of file OfficeFilePicker.hxx.

Referenced by getPickerFlags(), and setMultiSelectionMode().

◆ m_nServiceType

sal_Int16 SvtFilePicker::m_nServiceType
protected

◆ m_pElemList

std::unique_ptr<ElementList> SvtFilePicker::m_pElemList
protected

◆ m_pFilterList

std::unique_ptr<FilterList> SvtFilePicker::m_pFilterList
protected

◆ m_xDlgClosedListener

css::uno::Reference< css::ui::dialogs::XDialogClosedListener > SvtFilePicker::m_xDlgClosedListener
protected

Definition at line 81 of file OfficeFilePicker.hxx.

Referenced by DialogClosedHdl(), and startExecuteModal().

◆ m_xListener

css::uno::Reference< css::ui::dialogs::XFilePickerListener > SvtFilePicker::m_xListener
protected

Definition at line 79 of file OfficeFilePicker.hxx.

Referenced by addFilePickerListener(), notify(), and removeFilePickerListener().


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