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

#include <asyncfilepicker.hxx>

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

Public Types

enum  Action {
  ePrevLevel ,
  eOpenURL ,
  eExecuteFilter
}
 

Public Member Functions

 AsyncPickerAction (SvtFileDialog_Base *_pDialog, SvtFileView *_pView, const Action _eAction)
 
void execute (const OUString &_rURL, const OUString &_rFilter, sal_Int32 _nMinTimeout, sal_Int32 _nMaxTimeout, const css::uno::Sequence< OUString > &rDenyList)
 executes the action More...
 
void cancel ()
 cancels the running action More...
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Protected Member Functions

virtual ~AsyncPickerAction () override
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 

Private Member Functions

 DECL_LINK (OnActionDone, void *, void)
 
 AsyncPickerAction (const AsyncPickerAction &)=delete
 
AsyncPickerActionoperator= (const AsyncPickerAction &)=delete
 

Private Attributes

Action m_eAction
 
SvtFileViewm_pView
 
SvtFileDialog_Basem_pDialog
 
OUString m_sURL
 
OUString m_sFileName
 
bool m_bRunning
 

Additional Inherited Members

- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void * operator new (std::size_t nSize)
 
static void * operator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 
static void operator delete (void *pPtr)
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 
- Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

Definition at line 36 of file asyncfilepicker.hxx.

Member Enumeration Documentation

◆ Action

Enumerator
ePrevLevel 
eOpenURL 
eExecuteFilter 

Definition at line 39 of file asyncfilepicker.hxx.

Constructor & Destructor Documentation

◆ AsyncPickerAction() [1/2]

svt::AsyncPickerAction::AsyncPickerAction ( SvtFileDialog_Base _pDialog,
SvtFileView _pView,
const Action  _eAction 
)

Definition at line 32 of file asyncfilepicker.cxx.

References m_eAction, m_pDialog, and m_pView.

◆ ~AsyncPickerAction()

svt::AsyncPickerAction::~AsyncPickerAction ( )
overrideprotectedvirtual

Definition at line 43 of file asyncfilepicker.cxx.

◆ AsyncPickerAction() [2/2]

svt::AsyncPickerAction::AsyncPickerAction ( const AsyncPickerAction )
privatedelete

Member Function Documentation

◆ cancel()

void svt::AsyncPickerAction::cancel ( )

cancels the running action

Definition at line 48 of file asyncfilepicker.cxx.

References SvtFileView::CancelRunningAsyncAction(), DBG_TESTSOLARMUTEX, m_bRunning, and m_pView.

◆ DECL_LINK()

svt::AsyncPickerAction::DECL_LINK ( OnActionDone  ,
void *  ,
void   
)
private

◆ execute()

void svt::AsyncPickerAction::execute ( const OUString &  _rURL,
const OUString &  _rFilter,
sal_Int32  _nMinTimeout,
sal_Int32  _nMaxTimeout,
const css::uno::Sequence< OUString > &  rDenyList 
)

executes the action

Parameters
_nMinTimeoutthe minimum timeout to wait, in milliseconds. If negative, the action will we done synchronously. If between 0 and 999, it will be corrected to 1000, means the smallest valid value is 1000 (which equals one second).
_nMaxTimeoutThe maximum time to wait for a result, in milliseconds. If there's no result of the action within the given time frame, the action will be cancelled. If smaller than or equal to <arg>_nMinTimeout</arg>, it will be corrected to <arg>_nMinTimeout</arg> + 30000.

Definition at line 59 of file asyncfilepicker.cxx.

References salhelper::SimpleReferenceObject::acquire(), DBG_TESTSOLARMUTEX, eExecuteFilter, eFailure, eOpenURL, ePrevLevel, eStillRunning, eSuccess, SvtFileView::ExecuteFilter(), SvtFileDialog_Base::getCurrentFileText(), SvtFileView::Initialize(), LINK, m_bRunning, m_eAction, m_pDialog, m_pView, m_sFileName, m_sURL, SvtFileDialog_Base::onAsyncOperationStarted(), and SvtFileView::PreviousLevel().

◆ operator=()

AsyncPickerAction & svt::AsyncPickerAction::operator= ( const AsyncPickerAction )
privatedelete

Member Data Documentation

◆ m_bRunning

bool svt::AsyncPickerAction::m_bRunning
private

Definition at line 52 of file asyncfilepicker.hxx.

Referenced by cancel(), and execute().

◆ m_eAction

Action svt::AsyncPickerAction::m_eAction
private

Definition at line 47 of file asyncfilepicker.hxx.

Referenced by execute().

◆ m_pDialog

SvtFileDialog_Base* svt::AsyncPickerAction::m_pDialog
private

Definition at line 49 of file asyncfilepicker.hxx.

Referenced by AsyncPickerAction(), and execute().

◆ m_pView

SvtFileView* svt::AsyncPickerAction::m_pView
private

Definition at line 48 of file asyncfilepicker.hxx.

Referenced by AsyncPickerAction(), cancel(), and execute().

◆ m_sFileName

OUString svt::AsyncPickerAction::m_sFileName
private

Definition at line 51 of file asyncfilepicker.hxx.

Referenced by execute().

◆ m_sURL

OUString svt::AsyncPickerAction::m_sURL
private

Definition at line 50 of file asyncfilepicker.hxx.

Referenced by execute().


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