LibreOffice Module cui (master) 1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
SvxConfigPage Class Referenceabstract

#include <cfg.hxx>

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

Public Member Functions

virtual ~SvxConfigPage () override
 
SaveInDataGetSaveInData ()
 
const OUString & GetAppName () const
 
const OUString & GetFileName () const
 
int AddFunction (int nTarget, bool bAllowDuplicates)
 
virtual void MoveEntry (bool bMoveUp)
 
bool MoveEntryData (int SourceEntry, int nTargetEntry)
 
bool FillItemSet (SfxItemSet *) override
 
void Reset (const SfxItemSet *) override
 
virtual void DeleteSelectedContent ()=0
 
virtual void DeleteSelectedTopLevel ()=0
 
virtual void ListModified ()
 
SvxConfigEntryGetTopLevelSelection ()
 
OUString GetScriptURL () const
 
OUString GetSelectedDisplayName () const
 
- Public Member Functions inherited from SfxTabPage
void SetDialogController (SfxOkDialogController *pDialog)
 
virtual ~SfxTabPage () override
 
void set_visible (bool bVisible)
 
const SfxItemSetGetItemSet () const
 
virtual bool FillItemSet (SfxItemSet *)
 
virtual void Reset (const SfxItemSet *)
 
virtual bool DeferResetToFirstActivation ()
 
bool HasExchangeSupport () const
 
void SetExchangeSupport ()
 
virtual void ActivatePage (const SfxItemSet &)
 
virtual DeactivateRC DeactivatePage (SfxItemSet *pSet)
 
void SetUserData (const OUString &rString)
 
const OUString & GetUserData () const
 
virtual void FillUserData ()
 
virtual bool IsReadOnly () const
 
virtual void PageCreated (const SfxAllItemSet &aSet)
 
virtual void ChangesApplied ()
 
void SetFrame (const css::uno::Reference< css::frame::XFrame > &xFrame)
 
css::uno::Reference< css::frame::XFrame > GetFrame () const
 
const SfxItemSetGetDialogExampleSet () const
 
OString GetHelpId () const
 
OString GetConfigId () const
 
bool IsVisible () const
 
weld::WindowGetFrameWeld () const
 
std::unordered_map< OString, css::uno::Any > & getAdditionalProperties ()
 

Static Public Member Functions

static bool CanConfig (std::u16string_view rModuleId)
 
static OUString GetFrameWithDefaultAndIdentify (css::uno::Reference< css::frame::XFrame > &_inout_rxFrame)
 identifies the module in the given frame. More...
 
- Static Public Member Functions inherited from SfxTabPage
static const SfxPoolItemGetItem (const SfxItemSet &rSet, sal_uInt16 nSlot, bool bDeep=true)
 
static const T * GetItem (const SfxItemSet &rSet, TypedWhichId< T > nSlot, bool bDeep=true)
 

Protected Member Functions

 SvxConfigPage (weld::Container *pPage, weld::DialogController *pController, const SfxItemSet &)
 
 DECL_LINK (MoveHdl, weld::Button &, void)
 
 DECL_LINK (SelectFunctionHdl, weld::TreeView &, void)
 
 DECL_LINK (FunctionDoubleClickHdl, weld::TreeView &, bool)
 
 DECL_LINK (SelectSaveInLocation, weld::ComboBox &, void)
 
 DECL_LINK (SelectElementHdl, weld::ComboBox &, void)
 
 DECL_LINK (ImplUpdateDataHdl, Timer *, void)
 
 DECL_LINK (FocusOut_Impl, weld::Widget &, void)
 
virtual SaveInDataCreateSaveInData (const css::uno::Reference< css::ui::XUIConfigurationManager > &, const css::uno::Reference< css::ui::XUIConfigurationManager > &, const OUString &aModuleId, bool docConfig)=0
 
virtual void Init ()=0
 
virtual void UpdateButtonStates ()=0
 
virtual short QueryReset ()=0
 
virtual void SelectElement ()=0
 
int AppendEntry (SvxConfigEntry *pNewEntryData, int nTarget)
 
void AddSubMenusToUI (std::u16string_view rBaseTitle, SvxConfigEntry const *pParentData)
 
void InsertEntryIntoUI (SvxConfigEntry *pNewEntryData, weld::TreeView &rTreeView, int nPos, bool bMenu=false)
 
void InsertEntryIntoUI (SvxConfigEntry *pNewEntryData, weld::TreeView &rTreeView, weld::TreeIter &rIter, bool bMenu=false)
 
void InsertEntryIntoNotebookbarTabUI (std::u16string_view sClassId, const OUString &sUIItemId, const OUString &sUIItemCommand, weld::TreeView &rTreeView, const weld::TreeIter &rIter)
 
SvxEntriesFindParentForChild (SvxEntries *pParentEntries, SvxConfigEntry *pChildData)
 
void ReloadTopLevelListBox (SvxConfigEntry const *pSelection=nullptr)
 
SvxConfigEntryCreateCommandFromSelection (const OUString &aURL)
 
- Protected Member Functions inherited from SfxTabPage
 SfxTabPage (weld::Container *pPage, weld::DialogController *pController, const OUString &rUIXMLDescription, const OString &rID, const SfxItemSet *rAttrSet)
 
sal_uInt16 GetWhich (sal_uInt16 nSlot, bool bDeep=true) const
 
TypedWhichId< T > GetWhich (TypedWhichId< T > nSlot, bool bDeep=true) const
 
const SfxPoolItemGetOldItem (const SfxItemSet &rSet, sal_uInt16 nSlot, bool bDeep=true)
 
const T * GetOldItem (const SfxItemSet &rSet, TypedWhichId< T > nSlot, bool bDeep=true)
 
SfxOkDialogControllerGetDialogController () const
 

Static Protected Member Functions

static bool IsCommandInMenuList (const SvxConfigEntry *pEntryData, const SvxEntries *pEntries)
 

Protected Attributes

OUString m_aURLToSelect
 the ResourceURL to select when opening the dialog More...
 
css::uno::Reference< css::frame::XFrame > m_xFrame
 
OUString m_aModuleId
 
std::unique_ptr< CommandCategoryListBoxm_xCommandCategoryListBox
 
std::unique_ptr< CuiConfigFunctionListBoxm_xFunctions
 
std::unique_ptr< weld::Labelm_xCategoryLabel
 
std::unique_ptr< weld::Labelm_xDescriptionFieldLb
 
std::unique_ptr< weld::TextViewm_xDescriptionField
 
std::unique_ptr< weld::Labelm_xLeftFunctionLabel
 
std::unique_ptr< weld::Entrym_xSearchEdit
 
std::unique_ptr< weld::Labelm_xSearchLabel
 
std::unique_ptr< weld::Labelm_xCustomizeLabel
 
std::unique_ptr< weld::ComboBoxm_xTopLevelListBox
 
std::unique_ptr< weld::MenuButtonm_xGearBtn
 
std::unique_ptr< SvxMenuEntriesListBoxm_xContentsListBox
 
std::unique_ptr< SvxConfigPageFunctionDropTargetm_xDropTargetHelper
 
std::unique_ptr< weld::Buttonm_xMoveUpButton
 
std::unique_ptr< weld::Buttonm_xMoveDownButton
 
std::unique_ptr< weld::ComboBoxm_xSaveInListBox
 
std::unique_ptr< weld::MenuButtonm_xInsertBtn
 
std::unique_ptr< weld::MenuButtonm_xModifyBtn
 
std::unique_ptr< weld::Buttonm_xResetBtn
 
std::unique_ptr< weld::Buttonm_xAddCommandButton
 
std::unique_ptr< weld::Buttonm_xRemoveCommandButton
 
OUString m_sAppName
 
OUString m_sFileName
 

Private Member Functions

 DECL_LINK (SearchUpdateHdl, weld::Entry &, void)
 

Private Attributes

Timer m_aUpdateDataTimer
 
bool bInitialised
 
SaveInDatapCurrentSaveInData
 

Detailed Description

Definition at line 369 of file cfg.hxx.

Constructor & Destructor Documentation

◆ SvxConfigPage()

SvxConfigPage::SvxConfigPage ( weld::Container pPage,
weld::DialogController pController,
const SfxItemSet rSet 
)
protected

◆ ~SvxConfigPage()

SvxConfigPage::~SvxConfigPage ( )
overridevirtual

Definition at line 1042 of file cfg.cxx.

References i, m_xSaveInListBox, and pData.

Member Function Documentation

◆ AddFunction()

int SvxConfigPage::AddFunction ( int  nTarget,
bool  bAllowDuplicates 
)

◆ AddSubMenusToUI()

void SvxConfigPage::AddSubMenusToUI ( std::u16string_view  rBaseTitle,
SvxConfigEntry const *  pParentData 
)
protected

◆ AppendEntry()

int SvxConfigPage::AppendEntry ( SvxConfigEntry pNewEntryData,
int  nTarget 
)
protected

◆ CanConfig()

bool SvxConfigPage::CanConfig ( std::u16string_view  rModuleId)
static

Definition at line 163 of file cfg.cxx.

References u.

Referenced by SvxEventConfigPage::ImplInitDocument(), and Reset().

◆ CreateCommandFromSelection()

SvxConfigEntry * SvxConfigPage::CreateCommandFromSelection ( const OUString &  aURL)
protected

◆ CreateSaveInData()

virtual SaveInData * SvxConfigPage::CreateSaveInData ( const css::uno::Reference< css::ui::XUIConfigurationManager > &  ,
const css::uno::Reference< css::ui::XUIConfigurationManager > &  ,
const OUString &  aModuleId,
bool  docConfig 
)
protectedpure virtual

◆ DECL_LINK() [1/8]

SvxConfigPage::DECL_LINK ( FocusOut_Impl  ,
weld::Widget ,
void   
)
protected

◆ DECL_LINK() [2/8]

SvxConfigPage::DECL_LINK ( FunctionDoubleClickHdl  ,
weld::TreeView ,
bool   
)
protected

◆ DECL_LINK() [3/8]

SvxConfigPage::DECL_LINK ( ImplUpdateDataHdl  ,
Timer ,
void   
)
protected

◆ DECL_LINK() [4/8]

SvxConfigPage::DECL_LINK ( MoveHdl  ,
weld::Button ,
void   
)
protected

◆ DECL_LINK() [5/8]

SvxConfigPage::DECL_LINK ( SearchUpdateHdl  ,
weld::Entry ,
void   
)
private

◆ DECL_LINK() [6/8]

SvxConfigPage::DECL_LINK ( SelectElementHdl  ,
weld::ComboBox ,
void   
)
protected

◆ DECL_LINK() [7/8]

SvxConfigPage::DECL_LINK ( SelectFunctionHdl  ,
weld::TreeView ,
void   
)
protected

◆ DECL_LINK() [8/8]

SvxConfigPage::DECL_LINK ( SelectSaveInLocation  ,
weld::ComboBox ,
void   
)
protected

◆ DeleteSelectedContent()

virtual void SvxConfigPage::DeleteSelectedContent ( )
pure virtual

◆ DeleteSelectedTopLevel()

virtual void SvxConfigPage::DeleteSelectedTopLevel ( )
pure virtual

◆ FillItemSet()

bool SvxConfigPage::FillItemSet ( SfxItemSet )
overridevirtual

Reimplemented from SfxTabPage.

Definition at line 1328 of file cfg.cxx.

References i, m_xSaveInListBox, nCount, notebookbarTabScope, pData, result, and sId.

◆ FindParentForChild()

SvxEntries * SvxConfigPage::FindParentForChild ( SvxEntries pParentEntries,
SvxConfigEntry pChildData 
)
protected

Definition at line 1403 of file cfg.cxx.

References FindParentForChild(), and result.

Referenced by SvxMenuConfigPage::DeleteSelectedTopLevel(), and FindParentForChild().

◆ GetAppName()

const OUString & SvxConfigPage::GetAppName ( ) const
inline

Definition at line 482 of file cfg.hxx.

References m_sAppName.

Referenced by SvxNotebookbarEntriesListBox::ChangedVisibility().

◆ GetFileName()

const OUString & SvxConfigPage::GetFileName ( ) const
inline

Definition at line 483 of file cfg.hxx.

References m_sFileName.

Referenced by SvxNotebookbarEntriesListBox::ChangedVisibility().

◆ GetFrameWithDefaultAndIdentify()

OUString SvxConfigPage::GetFrameWithDefaultAndIdentify ( css::uno::Reference< css::frame::XFrame > &  _inout_rxFrame)
static

identifies the module in the given frame.

If the frame is <NULL>, a default frame will be determined beforehand.

If the given frame is <NULL>, a default frame will be used: The method the active frame of the desktop, then the current frame. If both are <NULL>, the SfxViewFrame::Current's XFrame is used. If this is <NULL>, too, an empty string is returned.

If the given frame is not <NULL>, or a default frame could be successfully determined, then the ModuleManager is asked for the module ID of the component in the frame.

Definition at line 1267 of file cfg.cxx.

References SfxViewFrame::Current(), DBG_UNHANDLED_EXCEPTION, SfxViewFrame::GetFrame(), SfxFrame::GetFrameInterface(), vcl::CommandInfoProvider::GetModuleIdentifier(), and SAL_WARN.

Referenced by SvxEventConfigPage::ImplInitDocument(), Reset(), and SvxConfigDialog::SetFrame().

◆ GetSaveInData()

SaveInData * SvxConfigPage::GetSaveInData ( )
inline

◆ GetScriptURL()

OUString SvxConfigPage::GetScriptURL ( ) const

◆ GetSelectedDisplayName()

OUString SvxConfigPage::GetSelectedDisplayName ( ) const

Definition at line 1323 of file cfg.cxx.

References m_xFunctions.

Referenced by CreateCommandFromSelection().

◆ GetTopLevelSelection()

SvxConfigEntry * SvxConfigPage::GetTopLevelSelection ( )
inline

◆ Init()

virtual void SvxConfigPage::Init ( )
protectedpure virtual

◆ InsertEntryIntoNotebookbarTabUI()

void SvxConfigPage::InsertEntryIntoNotebookbarTabUI ( std::u16string_view  sClassId,
const OUString &  sUIItemId,
const OUString &  sUIItemCommand,
weld::TreeView rTreeView,
const weld::TreeIter rIter 
)
protected

◆ InsertEntryIntoUI() [1/2]

void SvxConfigPage::InsertEntryIntoUI ( SvxConfigEntry pNewEntryData,
weld::TreeView rTreeView,
int  nPos,
bool  bMenu = false 
)
protected

◆ InsertEntryIntoUI() [2/2]

void SvxConfigPage::InsertEntryIntoUI ( SvxConfigEntry pNewEntryData,
weld::TreeView rTreeView,
weld::TreeIter rIter,
bool  bMenu = false 
)
protected

Definition at line 1606 of file cfg.cxx.

References GetSaveInData(), and m_xContentsListBox.

◆ IsCommandInMenuList()

bool SvxConfigPage::IsCommandInMenuList ( const SvxConfigEntry pEntryData,
const SvxEntries pEntries 
)
staticprotected

Definition at line 1455 of file cfg.cxx.

References SvxConfigEntry::GetCommand().

Referenced by AddFunction(), and SvxMenuConfigPage::UpdateButtonStates().

◆ ListModified()

virtual void SvxConfigPage::ListModified ( )
inlinevirtual

Reimplemented in SvxMenuConfigPage, and SvxToolbarConfigPage.

Definition at line 498 of file cfg.hxx.

Referenced by SvxConfigPageFunctionDropTarget::ExecuteDrop().

◆ MoveEntry()

void SvxConfigPage::MoveEntry ( bool  bMoveUp)
virtual

◆ MoveEntryData()

bool SvxConfigPage::MoveEntryData ( int  SourceEntry,
int  nTargetEntry 
)

◆ QueryReset()

virtual short SvxConfigPage::QueryReset ( )
protectedpure virtual

◆ ReloadTopLevelListBox()

void SvxConfigPage::ReloadTopLevelListBox ( SvxConfigEntry const *  pSelection = nullptr)
protected

◆ Reset()

void SvxConfigPage::Reset ( const SfxItemSet )
overridevirtual

◆ SelectElement()

virtual void SvxConfigPage::SelectElement ( )
protectedpure virtual

◆ UpdateButtonStates()

virtual void SvxConfigPage::UpdateButtonStates ( )
protectedpure virtual

Member Data Documentation

◆ bInitialised

bool SvxConfigPage::bInitialised
private

Definition at line 374 of file cfg.hxx.

Referenced by Reset().

◆ m_aModuleId

OUString SvxConfigPage::m_aModuleId
protected

◆ m_aUpdateDataTimer

Timer SvxConfigPage::m_aUpdateDataTimer
private

Definition at line 373 of file cfg.hxx.

Referenced by SvxConfigPage().

◆ m_aURLToSelect

OUString SvxConfigPage::m_aURLToSelect
protected

the ResourceURL to select when opening the dialog

Definition at line 382 of file cfg.hxx.

Referenced by SvxToolbarConfigPage::Init(), Reset(), and SvxToolbarConfigPage::SvxToolbarConfigPage().

◆ m_sAppName

OUString SvxConfigPage::m_sAppName
protected

◆ m_sFileName

OUString SvxConfigPage::m_sFileName
protected

◆ m_xAddCommandButton

std::unique_ptr<weld::Button> SvxConfigPage::m_xAddCommandButton
protected

◆ m_xCategoryLabel

std::unique_ptr<weld::Label> SvxConfigPage::m_xCategoryLabel
protected

Definition at line 392 of file cfg.hxx.

Referenced by SvxNotebookbarConfigPage::SvxNotebookbarConfigPage().

◆ m_xCommandCategoryListBox

std::unique_ptr<CommandCategoryListBox> SvxConfigPage::m_xCommandCategoryListBox
protected

◆ m_xContentsListBox

std::unique_ptr<SvxMenuEntriesListBox> SvxConfigPage::m_xContentsListBox
protected

◆ m_xCustomizeLabel

std::unique_ptr<weld::Label> SvxConfigPage::m_xCustomizeLabel
protected

Definition at line 402 of file cfg.hxx.

Referenced by SvxNotebookbarConfigPage::SvxNotebookbarConfigPage().

◆ m_xDescriptionField

std::unique_ptr<weld::TextView> SvxConfigPage::m_xDescriptionField
protected

◆ m_xDescriptionFieldLb

std::unique_ptr<weld::Label> SvxConfigPage::m_xDescriptionFieldLb
protected

Definition at line 393 of file cfg.hxx.

Referenced by SvxNotebookbarConfigPage::SvxNotebookbarConfigPage().

◆ m_xDropTargetHelper

std::unique_ptr<SvxConfigPageFunctionDropTarget> SvxConfigPage::m_xDropTargetHelper
protected

◆ m_xFrame

css::uno::Reference< css::frame::XFrame > SvxConfigPage::m_xFrame
protected

Definition at line 384 of file cfg.hxx.

Referenced by SvxMenuConfigPage::Init(), SvxToolbarConfigPage::Init(), and Reset().

◆ m_xFunctions

std::unique_ptr<CuiConfigFunctionListBox> SvxConfigPage::m_xFunctions
protected

◆ m_xGearBtn

std::unique_ptr<weld::MenuButton> SvxConfigPage::m_xGearBtn
protected

◆ m_xInsertBtn

std::unique_ptr<weld::MenuButton> SvxConfigPage::m_xInsertBtn
protected

◆ m_xLeftFunctionLabel

std::unique_ptr<weld::Label> SvxConfigPage::m_xLeftFunctionLabel
protected

Definition at line 395 of file cfg.hxx.

Referenced by SvxNotebookbarConfigPage::SvxNotebookbarConfigPage().

◆ m_xModifyBtn

std::unique_ptr<weld::MenuButton> SvxConfigPage::m_xModifyBtn
protected

◆ m_xMoveDownButton

std::unique_ptr<weld::Button> SvxConfigPage::m_xMoveDownButton
protected

◆ m_xMoveUpButton

std::unique_ptr<weld::Button> SvxConfigPage::m_xMoveUpButton
protected

◆ m_xRemoveCommandButton

std::unique_ptr<weld::Button> SvxConfigPage::m_xRemoveCommandButton
protected

◆ m_xResetBtn

std::unique_ptr<weld::Button> SvxConfigPage::m_xResetBtn
protected

◆ m_xSaveInListBox

std::unique_ptr<weld::ComboBox> SvxConfigPage::m_xSaveInListBox
protected

◆ m_xSearchEdit

std::unique_ptr<weld::Entry> SvxConfigPage::m_xSearchEdit
protected

Definition at line 396 of file cfg.hxx.

Referenced by SvxConfigPage(), and SvxNotebookbarConfigPage::SvxNotebookbarConfigPage().

◆ m_xSearchLabel

std::unique_ptr<weld::Label> SvxConfigPage::m_xSearchLabel
protected

Definition at line 397 of file cfg.hxx.

Referenced by SvxNotebookbarConfigPage::SvxNotebookbarConfigPage().

◆ m_xTopLevelListBox

std::unique_ptr<weld::ComboBox> SvxConfigPage::m_xTopLevelListBox
protected

◆ pCurrentSaveInData

SaveInData* SvxConfigPage::pCurrentSaveInData
private

Definition at line 375 of file cfg.hxx.

Referenced by CreateCommandFromSelection(), GetSaveInData(), and Reset().


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