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

#include <fileview.hxx>

Public Member Functions

 SvtFileView (weld::Window *pTopLevel, std::unique_ptr< weld::TreeView > xTreeView, std::unique_ptr< weld::IconView > xIconView, bool bOnlyFolder, bool bMultiSelection, bool bShowType=true)
 
 ~SvtFileView ()
 
void SetViewMode (FileViewMode eMode)
 
const OUString & GetViewURL () const
 
OUString GetURL (const weld::TreeIter &rEntry) const
 
OUString GetCurrentURL () const
 
bool GetParentURL (OUString &_rParentURL) const
 
void CreatedFolder (const OUString &rUrl, const OUString &rNewFolder)
 
void set_help_id (const OString &rHelpId)
 
OString get_help_id () const
 
void grab_focus ()
 
bool has_focus () const
 
OUString get_selected_text () const
 
weld::Widgetidentifier () const
 
FileViewResult Initialize (const OUString &rFolderURL, const OUString &rFilter, const FileViewAsyncAction *pAsyncDescriptor, const css::uno::Sequence< OUString > &rDenyList)
 initialize the view with the content of a folder given by URL, and apply an immediate filter More...
 
FileViewResult ExecuteFilter (const OUString &rFilter, const FileViewAsyncAction *pAsyncDescriptor)
 reads the current content of the current folder again, and applies the given filter to it More...
 
void CancelRunningAsyncAction ()
 cancels a running async action (if any) More...
 
FileViewResult PreviousLevel (const FileViewAsyncAction *pAsyncDescriptor)
 initializes the view with the parent folder of the current folder More...
 
void SetNoSelection ()
 
void SetSelectHdl (const Link< SvtFileView *, void > &rHdl)
 
void SetDoubleClickHdl (const Link< SvtFileView *, bool > &rHdl)
 
void SetOpenDoneHdl (const Link< SvtFileView *, void > &rHdl)
 
sal_uInt32 GetSelectionCount () const
 
SvtContentEntryFirstSelected () const
 
void selected_foreach (const std::function< bool(weld::TreeIter &)> &func)
 
void EnableDelete (bool bEnable)
 
OUString GetConfigString () const
 
void SetConfigString (const OUString &rCfgStr)
 
void EndInplaceEditing ()
 
::std::vector< SvtContentEntryGetContent ()
 

Private Member Functions

 DECL_LINK (HeaderSelect_Impl, int, void)
 

Private Attributes

std::unique_ptr< SvtFileView_ImplmpImpl
 
css::uno::Sequence< OUString > maDenyList
 

Detailed Description

Definition at line 62 of file fileview.hxx.

Constructor & Destructor Documentation

SvtFileView::SvtFileView ( weld::Window pTopLevel,
std::unique_ptr< weld::TreeView xTreeView,
std::unique_ptr< weld::IconView xIconView,
bool  bOnlyFolder,
bool  bMultiSelection,
bool  bShowType = true 
)
SvtFileView::~SvtFileView ( )

Definition at line 818 of file fileview.cxx.

Member Function Documentation

void SvtFileView::CancelRunningAsyncAction ( )

cancels a running async action (if any)

Initialize ExecuteFilter FileViewAsyncAction

Definition at line 971 of file fileview.cxx.

References mpImpl.

Referenced by svt::AsyncPickerAction::cancel().

void SvtFileView::CreatedFolder ( const OUString &  rUrl,
const OUString &  rNewFolder 
)

Definition at line 860 of file fileview.cxx.

References mpImpl, and sId.

SvtFileView::DECL_LINK ( HeaderSelect_Impl  ,
int  ,
void   
)
private
void SvtFileView::EnableDelete ( bool  bEnable)

Definition at line 1027 of file fileview.cxx.

References mpImpl.

void SvtFileView::EndInplaceEditing ( )

Definition at line 1032 of file fileview.cxx.

References mpImpl.

FileViewResult SvtFileView::ExecuteFilter ( const OUString &  rFilter,
const FileViewAsyncAction pAsyncDescriptor 
)

reads the current content of the current folder again, and applies the given filter to it

Note 1: The folder is really read a second time. This implies that any new elements (which were not present when you called Initialize the last time) are now displayed.

Note 2: This method must not be called when you previously initialized the view from a sequence of strings, or a UNO content object.

Parameters
rFilterthe filter to be applied
pAsyncDescriptorIf not <NULL>, this struct describes the parameters for doing the action asynchronously.

Definition at line 961 of file fileview.cxx.

References eStillRunning, maDenyList, and mpImpl.

Referenced by svt::AsyncPickerAction::execute(), and Initialize().

SvtContentEntry * SvtFileView::FirstSelected ( ) const

Definition at line 999 of file fileview.cxx.

References mpImpl.

OString SvtFileView::get_help_id ( ) const

Definition at line 913 of file fileview.cxx.

References mpImpl.

Referenced by svt::OControlAccess::getHelpURL().

OUString SvtFileView::get_selected_text ( ) const

Definition at line 923 of file fileview.cxx.

References mpImpl.

OUString SvtFileView::GetConfigString ( ) const
std::vector< SvtContentEntry > SvtFileView::GetContent ( )

Definition at line 1085 of file fileview.cxx.

References mpImpl.

OUString SvtFileView::GetCurrentURL ( ) const

Definition at line 839 of file fileview.cxx.

References SvtContentEntry::maURL, and mpImpl.

bool SvtFileView::GetParentURL ( OUString &  _rParentURL) const
sal_uInt32 SvtFileView::GetSelectionCount ( ) const

Definition at line 992 of file fileview.cxx.

References mpImpl.

OUString SvtFileView::GetURL ( const weld::TreeIter rEntry) const

Definition at line 827 of file fileview.cxx.

References SvtContentEntry::maURL, and mpImpl.

const OUString & SvtFileView::GetViewURL ( ) const

Definition at line 1017 of file fileview.cxx.

References mpImpl.

Referenced by SvtUpButton_Impl::FillURLMenu().

void SvtFileView::grab_focus ( )

Definition at line 808 of file fileview.cxx.

References mpImpl.

bool SvtFileView::has_focus ( ) const

Definition at line 813 of file fileview.cxx.

References mpImpl.

weld::Widget * SvtFileView::identifier ( ) const

Definition at line 1804 of file fileview.cxx.

References mpImpl.

Referenced by svt::OControlAccess::IsFileViewWidget().

FileViewResult SvtFileView::Initialize ( const OUString &  rFolderURL,
const OUString &  rFilter,
const FileViewAsyncAction pAsyncDescriptor,
const css::uno::Sequence< OUString > &  rDenyList 
)

initialize the view with the content of a folder given by URL, and apply an immediate filter

Parameters
rFolderURLthe URL of the folder whose content is to be read
rFilterthe initial filter to be applied
pAsyncDescriptorIf not <NULL>, this struct describes the parameters for doing the action asynchronously.

Definition at line 930 of file fileview.cxx.

References eFailure, eStillRunning, eSuccess, eTimeout, ExecuteFilter(), maDenyList, and mpImpl.

Referenced by svt::AsyncPickerAction::execute(), and PreviousLevel().

FileViewResult SvtFileView::PreviousLevel ( const FileViewAsyncAction pAsyncDescriptor)

initializes the view with the parent folder of the current folder

Parameters
rNewURLthe URL of the folder which we just navigated to
pAsyncDescriptorIf not <NULL>, this struct describes the parameters for doing the action asynchronously.

Definition at line 876 of file fileview.cxx.

References eFailure, GetParentURL(), Initialize(), maDenyList, and mpImpl.

Referenced by svt::AsyncPickerAction::execute().

void SvtFileView::selected_foreach ( const std::function< bool(weld::TreeIter &)> &  func)

Definition at line 1796 of file fileview.cxx.

References mpImpl.

void SvtFileView::set_help_id ( const OString &  rHelpId)

Definition at line 918 of file fileview.cxx.

References mpImpl.

Referenced by svt::OControlAccess::setHelpURL().

void SvtFileView::SetConfigString ( const OUString &  rCfgStr)
void SvtFileView::SetDoubleClickHdl ( const Link< SvtFileView *, bool > &  rHdl)

Definition at line 987 of file fileview.cxx.

References mpImpl.

void SvtFileView::SetNoSelection ( )

Definition at line 976 of file fileview.cxx.

References mpImpl.

void SvtFileView::SetOpenDoneHdl ( const Link< SvtFileView *, void > &  rHdl)

Definition at line 1022 of file fileview.cxx.

References mpImpl.

void SvtFileView::SetSelectHdl ( const Link< SvtFileView *, void > &  rHdl)

Definition at line 982 of file fileview.cxx.

References mpImpl.

void SvtFileView::SetViewMode ( FileViewMode  eMode)

Definition at line 822 of file fileview.cxx.

References mpImpl.

Member Data Documentation

css::uno::Sequence<OUString> SvtFileView::maDenyList
private

Definition at line 66 of file fileview.hxx.

Referenced by ExecuteFilter(), Initialize(), and PreviousLevel().

std::unique_ptr<SvtFileView_Impl> SvtFileView::mpImpl
private

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