LibreOffice Module sfx2 (master) 1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
SfxTabDialogController Class Reference

#include <tabdlg.hxx>

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

Public Member Functions

 SfxTabDialogController (weld::Widget *pParent, const OUString &rUIXMLDescription, const OUString &rID, const SfxItemSet *=nullptr, bool bEditFmt=false)
 
virtual ~SfxTabDialogController () override
 
void AddTabPage (const OUString &rName, CreateTabPage pCreateFunc, GetTabPageRanges pRangesFunc)
 
void AddTabPage (const OUString &rName, sal_uInt16 nPageCreateId)
 
void AddTabPage (const OUString &rName, const OUString &rLabel, CreateTabPage pCreateFunc)
 
void AddTabPage (const OUString &rName, const OUString &rLabel, sal_uInt16 nPageCreateId)
 
void RemoveTabPage (const OUString &rName)
 
void SetCurPageId (const OUString &rName)
 
void ShowPage (const OUString &rName)
 
OUString GetCurPageId () const
 
SfxTabPage * GetCurTabPage () const
 
const WhichRangesContainer & GetInputRanges (const SfxItemPool &)
 
void SetInputSet (const SfxItemSet *pInSet)
 
const SfxItemSet * GetOutputItemSet () const
 
virtual weld::Button & GetOKButton () const override
 
weld::Button & GetCancelButton () const
 
weld::Button * GetUserButton () const
 
weld::Button * GetStandardButton () const
 
weld::Button * GetApplyButton () const
 
weld::Button * GetResetButton () const
 
void RemoveResetButton ()
 
void RemoveStandardButton ()
 
virtual short run () override
 
virtual const SfxItemSet * GetExampleSet () const override
 
void SetApplyHandler (const Link< weld::Button &, void > &_rHdl)
 
bool Apply ()
 
void Applied ()
 
std::vector< OUString > getAllPageUIXMLDescriptions () const
 
bool selectPageByUIXMLDescription (const OUString &rUIXMLDescription)
 
BitmapEx createScreenshot () const
 
OUString GetScreenshotId () const
 
- Public Member Functions inherited from SfxOkDialogController
 SfxOkDialogController (weld::Widget *pParent, const OUString &rUIXMLDescription, const OUString &rID)
 
virtual weld::Button & GetOKButton () const =0
 
virtual const SfxItemSet * GetExampleSet () const =0
 
- Public Member Functions inherited from SfxDialogController
 SfxDialogController (weld::Widget *pParent, const OUString &rUIFile, const OUString &rDialogId)
 
virtual void Activate ()
 
virtual void Deactivate ()
 
virtual void ChildWinDispose ()
 
virtual void Close ()
 
virtual void EndDialog (int nResponse)
 
virtual bool CloseOnHide () const
 
- Public Member Functions inherited from weld::GenericDialogController
 GenericDialogController (weld::Widget *pParent, const OUString &rUIFile, const OUString &rDialogId, bool bMobile=false)
 
virtual Dialog * getDialog () override
 
virtual ~GenericDialogController () COVERITY_NOEXCEPT_FALSE override
 
- Public Member Functions inherited from weld::DialogController
virtual Dialog * getDialog ()=0
 
const Dialog * getConstDialog () const
 
virtual short run ()
 
void set_title (const OUString &rTitle)
 
OUString get_title () const
 
void set_help_id (const OUString &rHelpId)
 
OUString get_help_id () const
 
void response (int nResponse)
 
virtual ~DialogController () COVERITY_NOEXCEPT_FALSE
 

Static Public Member Functions

static bool runAsync (const std::shared_ptr< SfxTabDialogController > &rController, const std::function< void(sal_Int32)> &)
 
- Static Public Member Functions inherited from weld::DialogController
static bool runAsync (const std::shared_ptr< DialogController > &rController, const std::function< void(sal_Int32)> &)
 

Protected Member Functions

 DECL_LINK (OkHdl, weld::Button &, void)
 
 DECL_DLLPRIVATE_LINK (ResetHdl, weld::Button &, void)
 
 DECL_DLLPRIVATE_LINK (BaseFmtHdl, weld::Button &, void)
 
 DECL_DLLPRIVATE_LINK (UserHdl, weld::Button &, void)
 
 DECL_DLLPRIVATE_LINK (CancelHdl, weld::Button &, void)
 
virtual short Ok ()
 
virtual void RefreshInputSet ()
 
virtual SfxItemSet * CreateInputItemSet (const OUString &rName)
 
virtual void PageCreated (const OUString &rName, SfxTabPage &rPage)
 
virtual void ActivatePage (const OUString &rPage)
 
bool DeactivatePage (std::u16string_view aPage)
 
SfxItemSet * GetInputSetImpl ()
 
SfxTabPage * GetTabPage (std::u16string_view rPageId) const
 
bool PrepareLeaveCurrentPage ()
 prepare to leave the current page. More...
 
void SavePosAndId ()
 save the position of the TabDialog and which tab page is the currently active one More...
 

Protected Attributes

std::unique_ptr< weld::Notebook > m_xTabCtrl
 
std::unique_ptr< SfxItemSet > m_xExampleSet
 
- Protected Attributes inherited from weld::GenericDialogController
std::unique_ptr< weld::Builder > m_xBuilder
 
std::shared_ptr< weld::Dialog > m_xDialog
 

Private Member Functions

 DECL_DLLPRIVATE_LINK (ActivatePageHdl, const OUString &, void)
 
 DECL_DLLPRIVATE_LINK (DeactivatePageHdl, const OUString &, bool)
 
SAL_DLLPRIVATE void Start_Impl ()
 
SAL_DLLPRIVATE void CreatePages ()
 
SAL_DLLPRIVATE void setPreviewsToSamePlace ()
 

Private Attributes

std::unique_ptr< weld::Button > m_xOKBtn
 
std::unique_ptr< weld::Button > m_xApplyBtn
 
std::unique_ptr< weld::Button > m_xUserBtn
 
std::unique_ptr< weld::Button > m_xCancelBtn
 
std::unique_ptr< weld::Button > m_xResetBtn
 
std::unique_ptr< weld::Button > m_xBaseFmtBtn
 
std::unique_ptr< weld::SizeGroup > m_xSizeGroup
 
std::unique_ptr< SfxItemSet > m_pSet
 
std::unique_ptr< SfxItemSet > m_pOutSet
 
std::unique_ptr< TabDlg_Impl > m_pImpl
 
WhichRangesContainer m_pRanges
 
OUString m_sAppPageId
 
bool m_bStandardPushed
 
std::unique_ptr< SfxAllItemSet > m_xItemSet
 

Detailed Description

Definition at line 58 of file tabdlg.hxx.

Constructor & Destructor Documentation

◆ SfxTabDialogController()

SfxTabDialogController::SfxTabDialogController ( weld::Widget *  pParent,
const OUString &  rUIXMLDescription,
const OUString &  rID,
const SfxItemSet *  pItemSet = nullptr,
bool  bEditFmt = false 
)

Definition at line 310 of file tabdlg.cxx.

References HID_TABDLG_RESET_BTN, HID_TABDLG_STANDARD_BTN, comphelper::LibreOfficeKit::isActive(), LINK, m_pImpl, m_pOutSet, m_pSet, m_xBaseFmtBtn, m_xCancelBtn, m_xExampleSet, m_xOKBtn, m_xResetBtn, m_xTabCtrl, m_xUserBtn, RemoveResetButton(), and SfxResId().

◆ ~SfxTabDialogController()

virtual SfxTabDialogController::~SfxTabDialogController ( )
overridevirtual

Member Function Documentation

◆ ActivatePage()

virtual void SfxTabDialogController::ActivatePage ( const OUString &  rPage)
protectedvirtual

◆ AddTabPage() [1/4]

void SfxTabDialogController::AddTabPage ( const OUString &  rName,
const OUString &  rLabel,
CreateTabPage  pCreateFunc 
)

◆ AddTabPage() [2/4]

void SfxTabDialogController::AddTabPage ( const OUString &  rName,
const OUString &  rLabel,
sal_uInt16  nPageCreateId 
)

◆ AddTabPage() [3/4]

void SfxTabDialogController::AddTabPage ( const OUString &  rName,
CreateTabPage  pCreateFunc,
GetTabPageRanges  pRangesFunc 
)

Referenced by SfxDocumentInfoDialog::AddFontTabPage(), SfxDocumentInfoDialog::SfxDocumentInfoDialog(), and SfxStyleDialogController::SfxStyleDialogController().

◆ AddTabPage() [4/4]

void SfxTabDialogController::AddTabPage ( const OUString &  rName,
sal_uInt16  nPageCreateId 
)

◆ Applied()

void SfxTabDialogController::Applied ( )
inline

Definition at line 164 of file tabdlg.hxx.

◆ Apply()

bool SfxTabDialogController::Apply ( )

◆ CreateInputItemSet()

virtual SfxItemSet * SfxTabDialogController::CreateInputItemSet ( const OUString &  rName)
protectedvirtual

◆ CreatePages()

SAL_DLLPRIVATE void SfxTabDialogController::CreatePages ( )
private

◆ createScreenshot()

BitmapEx SfxTabDialogController::createScreenshot ( ) const

◆ DeactivatePage()

bool SfxTabDialogController::DeactivatePage ( std::u16string_view  aPage)
protected

◆ DECL_DLLPRIVATE_LINK() [1/6]

SfxTabDialogController::DECL_DLLPRIVATE_LINK ( ActivatePageHdl  ,
const OUString &  ,
void   
)
private

◆ DECL_DLLPRIVATE_LINK() [2/6]

SfxTabDialogController::DECL_DLLPRIVATE_LINK ( BaseFmtHdl  ,
weld::Button &  ,
void   
)
protected

◆ DECL_DLLPRIVATE_LINK() [3/6]

SfxTabDialogController::DECL_DLLPRIVATE_LINK ( CancelHdl  ,
weld::Button &  ,
void   
)
protected

◆ DECL_DLLPRIVATE_LINK() [4/6]

SfxTabDialogController::DECL_DLLPRIVATE_LINK ( DeactivatePageHdl  ,
const OUString &  ,
bool   
)
private

◆ DECL_DLLPRIVATE_LINK() [5/6]

SfxTabDialogController::DECL_DLLPRIVATE_LINK ( ResetHdl  ,
weld::Button &  ,
void   
)
protected

◆ DECL_DLLPRIVATE_LINK() [6/6]

SfxTabDialogController::DECL_DLLPRIVATE_LINK ( UserHdl  ,
weld::Button &  ,
void   
)
protected

◆ DECL_LINK()

SfxTabDialogController::DECL_LINK ( OkHdl  ,
weld::Button &  ,
void   
)
protected

◆ getAllPageUIXMLDescriptions()

std::vector< OUString > SfxTabDialogController::getAllPageUIXMLDescriptions ( ) const

◆ GetApplyButton()

weld::Button * SfxTabDialogController::GetApplyButton ( ) const
inline

Definition at line 149 of file tabdlg.hxx.

◆ GetCancelButton()

weld::Button & SfxTabDialogController::GetCancelButton ( ) const
inline

Definition at line 146 of file tabdlg.hxx.

Referenced by SfxStyleDialogController::SfxStyleDialogController().

◆ GetCurPageId()

OUString SfxTabDialogController::GetCurPageId ( ) const

◆ GetCurTabPage()

SfxTabPage * SfxTabDialogController::GetCurTabPage ( ) const
inline

Definition at line 138 of file tabdlg.hxx.

◆ GetExampleSet()

virtual const SfxItemSet * SfxTabDialogController::GetExampleSet ( ) const
inlineoverridevirtual

Implements SfxOkDialogController.

Definition at line 158 of file tabdlg.hxx.

◆ GetInputRanges()

const WhichRangesContainer & SfxTabDialogController::GetInputRanges ( const SfxItemPool &  )

◆ GetInputSetImpl()

SfxItemSet * SfxTabDialogController::GetInputSetImpl ( )
protected

◆ GetOKButton()

virtual weld::Button & SfxTabDialogController::GetOKButton ( ) const
inlineoverridevirtual

Implements SfxOkDialogController.

Definition at line 145 of file tabdlg.hxx.

◆ GetOutputItemSet()

const SfxItemSet * SfxTabDialogController::GetOutputItemSet ( ) const
inline

Definition at line 143 of file tabdlg.hxx.

◆ GetResetButton()

weld::Button * SfxTabDialogController::GetResetButton ( ) const
inline

Definition at line 150 of file tabdlg.hxx.

◆ GetScreenshotId()

OUString SfxTabDialogController::GetScreenshotId ( ) const

◆ GetStandardButton()

weld::Button * SfxTabDialogController::GetStandardButton ( ) const
inline

Definition at line 148 of file tabdlg.hxx.

◆ GetTabPage()

SfxTabPage * SfxTabDialogController::GetTabPage ( std::u16string_view  rPageId) const
protected

◆ GetUserButton()

weld::Button * SfxTabDialogController::GetUserButton ( ) const
inline

Definition at line 147 of file tabdlg.hxx.

◆ Ok()

virtual short SfxTabDialogController::Ok ( )
protectedvirtual

Reimplemented in SfxStyleDialogController.

Referenced by SfxStyleDialogController::Ok().

◆ PageCreated()

virtual void SfxTabDialogController::PageCreated ( const OUString &  rName,
SfxTabPage &  rPage 
)
protectedvirtual

Reimplemented in SfxDocumentInfoDialog.

◆ PrepareLeaveCurrentPage()

bool SfxTabDialogController::PrepareLeaveCurrentPage ( )
protected

prepare to leave the current page.

Calls the DeactivatePage method of the current page, (if necessary), handles the item sets to copy.

Returns
sal_True if it is allowed to leave the current page, sal_False otherwise

◆ RefreshInputSet()

virtual void SfxTabDialogController::RefreshInputSet ( )
protectedvirtual

◆ RemoveResetButton()

void SfxTabDialogController::RemoveResetButton ( )

Referenced by SfxTabDialogController().

◆ RemoveStandardButton()

void SfxTabDialogController::RemoveStandardButton ( )

Referenced by SfxStyleDialogController::SfxStyleDialogController().

◆ RemoveTabPage()

void SfxTabDialogController::RemoveTabPage ( const OUString &  rName)

Referenced by SfxDocumentInfoDialog::SfxDocumentInfoDialog().

◆ run()

virtual short SfxTabDialogController::run ( )
overridevirtual

Reimplemented from weld::DialogController.

◆ runAsync()

static bool SfxTabDialogController::runAsync ( const std::shared_ptr< SfxTabDialogController > &  rController,
const std::function< void(sal_Int32)> &   
)
static

Referenced by SfxObjectShell::ExecFile_Impl().

◆ SavePosAndId()

void SfxTabDialogController::SavePosAndId ( )
protected

save the position of the TabDialog and which tab page is the currently active one

◆ selectPageByUIXMLDescription()

bool SfxTabDialogController::selectPageByUIXMLDescription ( const OUString &  rUIXMLDescription)

◆ SetApplyHandler()

void SfxTabDialogController::SetApplyHandler ( const Link< weld::Button &, void > &  _rHdl)

◆ SetCurPageId()

void SfxTabDialogController::SetCurPageId ( const OUString &  rName)

Referenced by SfxStyleDialogController::SfxStyleDialogController().

◆ SetInputSet()

void SfxTabDialogController::SetInputSet ( const SfxItemSet *  pInSet)

◆ setPreviewsToSamePlace()

SAL_DLLPRIVATE void SfxTabDialogController::setPreviewsToSamePlace ( )
private

◆ ShowPage()

void SfxTabDialogController::ShowPage ( const OUString &  rName)

◆ Start_Impl()

SAL_DLLPRIVATE void SfxTabDialogController::Start_Impl ( )
private

Member Data Documentation

◆ m_bStandardPushed

bool SfxTabDialogController::m_bStandardPushed
private

Definition at line 82 of file tabdlg.hxx.

◆ m_pImpl

std::unique_ptr<TabDlg_Impl> SfxTabDialogController::m_pImpl
private

Definition at line 79 of file tabdlg.hxx.

Referenced by SfxTabDialogController().

◆ m_pOutSet

std::unique_ptr<SfxItemSet> SfxTabDialogController::m_pOutSet
private

Definition at line 78 of file tabdlg.hxx.

Referenced by SfxTabDialogController().

◆ m_pRanges

WhichRangesContainer SfxTabDialogController::m_pRanges
private

Definition at line 80 of file tabdlg.hxx.

◆ m_pSet

std::unique_ptr<SfxItemSet> SfxTabDialogController::m_pSet
private

Definition at line 77 of file tabdlg.hxx.

Referenced by SfxTabDialogController().

◆ m_sAppPageId

OUString SfxTabDialogController::m_sAppPageId
private

Definition at line 81 of file tabdlg.hxx.

◆ m_xApplyBtn

std::unique_ptr<weld::Button> SfxTabDialogController::m_xApplyBtn
private

Definition at line 70 of file tabdlg.hxx.

◆ m_xBaseFmtBtn

std::unique_ptr<weld::Button> SfxTabDialogController::m_xBaseFmtBtn
private

Definition at line 74 of file tabdlg.hxx.

Referenced by SfxTabDialogController().

◆ m_xCancelBtn

std::unique_ptr<weld::Button> SfxTabDialogController::m_xCancelBtn
private

Definition at line 72 of file tabdlg.hxx.

Referenced by SfxTabDialogController().

◆ m_xExampleSet

std::unique_ptr<SfxItemSet> SfxTabDialogController::m_xExampleSet
protected

Definition at line 100 of file tabdlg.hxx.

Referenced by SfxStyleDialogController::SfxStyleDialogController(), SfxTabDialogController(), and SfxStyleDialogController::~SfxStyleDialogController().

◆ m_xItemSet

std::unique_ptr<SfxAllItemSet> SfxTabDialogController::m_xItemSet
private

Definition at line 83 of file tabdlg.hxx.

◆ m_xOKBtn

std::unique_ptr<weld::Button> SfxTabDialogController::m_xOKBtn
private

Definition at line 69 of file tabdlg.hxx.

Referenced by SfxTabDialogController().

◆ m_xResetBtn

std::unique_ptr<weld::Button> SfxTabDialogController::m_xResetBtn
private

Definition at line 73 of file tabdlg.hxx.

Referenced by SfxTabDialogController().

◆ m_xSizeGroup

std::unique_ptr<weld::SizeGroup> SfxTabDialogController::m_xSizeGroup
private

Definition at line 75 of file tabdlg.hxx.

◆ m_xTabCtrl

std::unique_ptr<weld::Notebook> SfxTabDialogController::m_xTabCtrl
protected

Definition at line 61 of file tabdlg.hxx.

Referenced by SfxTabDialogController().

◆ m_xUserBtn

std::unique_ptr<weld::Button> SfxTabDialogController::m_xUserBtn
private

Definition at line 71 of file tabdlg.hxx.

Referenced by SfxTabDialogController().

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