LibreOffice Module extensions (master) 1
Classes | Public Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
pcr::OPropertyEditor Class Referencefinal

#include <propertyeditor.hxx>

Collaboration diagram for pcr::OPropertyEditor:
[legend]

Classes

struct  PropertyPage
 

Public Member Functions

 OPropertyEditor (const css::uno::Reference< css::uno::XComponentContext > &rContext, weld::Builder &rBuilder)
 
 ~OPropertyEditor ()
 
void SetLineListener (IPropertyLineListener *)
 
void SetControlObserver (IPropertyControlObserver *)
 
void EnableHelpSection (bool _bEnable)
 
bool HasHelpSection () const
 
void SetHelpText (const OUString &_rHelpText)
 
void SetHelpId (const OUString &sHelpId)
 
sal_uInt16 AppendPage (const OUString &r, const OUString &_rHelpId)
 
void SetPage (sal_uInt16)
 
void RemovePage (sal_uInt16 nID)
 
sal_uInt16 GetCurPage () const
 
void ClearAll ()
 
void SetPropertyValue (const OUString &_rEntryName, const css::uno::Any &_rValue, bool _bUnknownValue)
 
sal_uInt16 GetPropertyPos (const OUString &rEntryName) const
 
css::uno::Reference< css::inspection::XPropertyControl > GetPropertyControl (const OUString &rEntryName)
 
void EnablePropertyLine (const OUString &_rEntryName, bool _bEnable)
 
void EnablePropertyControls (const OUString &_rEntryName, sal_Int16 _nControls, bool _bEnable)
 
void ShowPropertyPage (sal_uInt16 _nPageId, bool _bShow)
 
void InsertEntry (const OLineDescriptor &, sal_uInt16 _nPageId, sal_uInt16 nPos=EDITOR_LIST_APPEND)
 
void RemoveEntry (const OUString &_rName)
 
void ChangeEntry (const OLineDescriptor &)
 
void setPageActivationHandler (const Link< const OUString &, void > &_rHdl)
 
Size get_preferred_size () const
 
weld::Widget * getWidget () const
 
void Show ()
 
void Hide ()
 
void GrabFocus ()
 
void CommitModified ()
 

Private Types

typedef std::map< OUString, sal_uInt16 > MapStringToPageId
 
typedef void(OPropertyEditor::* PageOperation) (OBrowserPage &, const void *)
 

Private Member Functions

OBrowserPage * getPage (sal_uInt16 _rPageId)
 
const OBrowserPage * getPage (sal_uInt16 _rPageId) const
 
OBrowserPage * getPage (const OUString &_rPropertyName)
 
const OBrowserPage * getPage (const OUString &_rPropertyName) const
 
void forEachPage (PageOperation _pOperation)
 
void setPageLineListener (OBrowserPage &_rPage, const void *)
 
void setPageControlObserver (OBrowserPage &_rPage, const void *)
 
void enableHelpSection (OBrowserPage &_rPage, const void *)
 
 DECL_LINK (OnPageDeactivate, const OUString &, bool)
 
 DECL_LINK (OnPageActivate, const OUString &, void)
 

Static Private Member Functions

static void setHelpSectionText (OBrowserPage &_rPage, const void *_pPointerToOUString)
 

Private Attributes

std::unique_ptr< weld::Container > m_xContainer
 
std::unique_ptr< weld::Notebook > m_xTabControl
 
std::unique_ptr< weld::Container > m_xControlHoldingParent
 
css::uno::Reference< css::uno::XComponentContext > m_xContext
 
IPropertyLineListener * m_pListener
 
IPropertyControlObserver * m_pObserver
 
sal_uInt16 m_nNextId
 
Link< const OUString &, void > m_aPageActivationHandler
 
bool m_bHasHelpSection
 
MapStringToPageId m_aPropertyPageIds
 
std::map< sal_uInt16, PropertyPage > m_aShownPages
 
std::map< sal_uInt16, PropertyPage > m_aHiddenPages
 

Detailed Description

Definition at line 39 of file propertyeditor.hxx.

Member Typedef Documentation

◆ MapStringToPageId

typedef std::map< OUString, sal_uInt16 > pcr::OPropertyEditor::MapStringToPageId
private

Definition at line 42 of file propertyeditor.hxx.

◆ PageOperation

typedef void(OPropertyEditor::* pcr::OPropertyEditor::PageOperation) (OBrowserPage &, const void *)
private

Definition at line 117 of file propertyeditor.hxx.

Constructor & Destructor Documentation

◆ OPropertyEditor()

pcr::OPropertyEditor::OPropertyEditor ( const css::uno::Reference< css::uno::XComponentContext > &  rContext,
weld::Builder &  rBuilder 
)
explicit

Definition at line 35 of file propertyeditor.cxx.

References LINK, m_xContainer, m_xControlHoldingParent, m_xTabControl, and pcr::PropertyHandlerHelper::setBuilderParent().

◆ ~OPropertyEditor()

pcr::OPropertyEditor::~OPropertyEditor ( )

Definition at line 51 of file propertyeditor.cxx.

References ClearAll(), pcr::PropertyHandlerHelper::clearBuilderParent(), and m_xContext.

Member Function Documentation

◆ AppendPage()

sal_uInt16 pcr::OPropertyEditor::AppendPage ( const OUString &  r,
const OUString &  _rHelpId 
)

Definition at line 119 of file propertyeditor.cxx.

References m_aShownPages, m_bHasHelpSection, m_nNextId, m_pListener, m_pObserver, m_xControlHoldingParent, m_xTabControl, and nId.

Referenced by pcr::OPropertyBrowserController::impl_buildCategories_throw(), and pcr::OPropertyBrowserController::UpdateUI().

◆ ChangeEntry()

void pcr::OPropertyEditor::ChangeEntry ( const OLineDescriptor &  rData)

Definition at line 266 of file propertyeditor.cxx.

References pcr::OBrowserListBox::ChangeEntry(), EDITOR_LIST_REPLACE_EXISTING, pcr::OBrowserPage::getListBox(), getPage(), and pcr::OLineDescriptor::sName.

Referenced by pcr::OPropertyBrowserController::rebuildPropertyUI().

◆ ClearAll()

void pcr::OPropertyEditor::ClearAll ( )

Definition at line 57 of file propertyeditor.cxx.

References i, m_aHiddenPages, m_aPropertyPageIds, m_aShownPages, m_nNextId, m_xTabControl, and nCount.

Referenced by pcr::OPropertyBrowserController::stopInspection(), and ~OPropertyEditor().

◆ CommitModified()

void pcr::OPropertyEditor::CommitModified ( )

Definition at line 80 of file propertyeditor.cxx.

References pcr::OBrowserListBox::CommitModified(), pcr::OBrowserPage::getListBox(), pcr::OBrowserListBox::IsModified(), and m_aShownPages.

Referenced by pcr::OPropertyBrowserController::Clicked(), pcr::OPropertyBrowserController::stopInspection(), and pcr::OPropertyBrowserController::suspend().

◆ DECL_LINK() [1/2]

pcr::OPropertyEditor::DECL_LINK ( OnPageActivate  ,
const OUString &  ,
void   
)
private

◆ DECL_LINK() [2/2]

pcr::OPropertyEditor::DECL_LINK ( OnPageDeactivate  ,
const OUString &  ,
bool   
)
private

◆ EnableHelpSection()

void pcr::OPropertyEditor::EnableHelpSection ( bool  _bEnable)

Definition at line 204 of file propertyeditor.cxx.

References enableHelpSection(), forEachPage(), and m_bHasHelpSection.

Referenced by pcr::OPropertyBrowserController::impl_initializeView_nothrow().

◆ enableHelpSection()

void pcr::OPropertyEditor::enableHelpSection ( OBrowserPage &  _rPage,
const void *   
)
private

Definition at line 223 of file propertyeditor.cxx.

References pcr::OBrowserListBox::EnableHelpSection(), pcr::OBrowserPage::getListBox(), and m_bHasHelpSection.

Referenced by EnableHelpSection().

◆ EnablePropertyControls()

void pcr::OPropertyEditor::EnablePropertyControls ( const OUString &  _rEntryName,
sal_Int16  _nControls,
bool  _bEnable 
)

Definition at line 320 of file propertyeditor.cxx.

References pcr::OBrowserListBox::EnablePropertyControls(), pcr::OBrowserPage::getListBox(), and m_aShownPages.

Referenced by pcr::OPropertyBrowserController::enablePropertyUIElements().

◆ EnablePropertyLine()

void pcr::OPropertyEditor::EnablePropertyLine ( const OUString &  _rEntryName,
bool  _bEnable 
)

Definition at line 330 of file propertyeditor.cxx.

References pcr::OBrowserListBox::EnablePropertyLine(), pcr::OBrowserPage::getListBox(), and m_aShownPages.

Referenced by pcr::OPropertyBrowserController::enablePropertyUI().

◆ forEachPage()

void pcr::OPropertyEditor::forEachPage ( PageOperation  _pOperation)
private

Definition at line 169 of file propertyeditor.cxx.

References getPage(), i, m_xTabControl, and nCount.

Referenced by EnableHelpSection(), SetControlObserver(), and SetLineListener().

◆ get_preferred_size()

Size pcr::OPropertyEditor::get_preferred_size ( ) const

Definition at line 75 of file propertyeditor.cxx.

References m_xTabControl.

◆ GetCurPage()

sal_uInt16 pcr::OPropertyEditor::GetCurPage ( ) const

Definition at line 164 of file propertyeditor.cxx.

References m_xTabControl.

◆ getPage() [1/4]

OBrowserPage * pcr::OPropertyEditor::getPage ( const OUString &  _rPropertyName)
private

Definition at line 91 of file propertyeditor.cxx.

References getPage(), and m_aPropertyPageIds.

◆ getPage() [2/4]

const OBrowserPage * pcr::OPropertyEditor::getPage ( const OUString &  _rPropertyName) const
private

Definition at line 100 of file propertyeditor.cxx.

References getPage().

◆ getPage() [3/4]

OBrowserPage * pcr::OPropertyEditor::getPage ( sal_uInt16  _rPageId)
private

Definition at line 105 of file propertyeditor.cxx.

References m_aShownPages.

Referenced by ChangeEntry(), forEachPage(), getPage(), GetPropertyControl(), GetPropertyPos(), InsertEntry(), RemoveEntry(), SetHelpText(), and SetPropertyValue().

◆ getPage() [4/4]

const OBrowserPage * pcr::OPropertyEditor::getPage ( sal_uInt16  _rPageId) const
private

Definition at line 114 of file propertyeditor.cxx.

References getPage().

◆ GetPropertyControl()

Reference< XPropertyControl > pcr::OPropertyEditor::GetPropertyControl ( const OUString &  rEntryName)

Definition at line 340 of file propertyeditor.cxx.

References pcr::OBrowserPage::getListBox(), getPage(), pcr::OBrowserListBox::GetPropertyControl(), and m_xTabControl.

◆ GetPropertyPos()

sal_uInt16 pcr::OPropertyEditor::GetPropertyPos ( const OUString &  rEntryName) const

Definition at line 280 of file propertyeditor.cxx.

References EDITOR_LIST_ENTRY_NOTFOUND, pcr::OBrowserPage::getListBox(), getPage(), and pcr::OBrowserListBox::GetPropertyPos().

Referenced by pcr::OPropertyBrowserController::showPropertyUI().

◆ getWidget()

weld::Widget * pcr::OPropertyEditor::getWidget ( ) const
inline

Definition at line 102 of file propertyeditor.hxx.

References m_xTabControl.

◆ GrabFocus()

void pcr::OPropertyEditor::GrabFocus ( )
inline

Definition at line 106 of file propertyeditor.hxx.

References m_xTabControl.

◆ HasHelpSection()

bool pcr::OPropertyEditor::HasHelpSection ( ) const
inline

Definition at line 75 of file propertyeditor.hxx.

References m_bHasHelpSection.

◆ Hide()

void pcr::OPropertyEditor::Hide ( )
inline

Definition at line 105 of file propertyeditor.hxx.

References m_xTabControl.

Referenced by pcr::OPropertyBrowserController::stopInspection().

◆ InsertEntry()

void pcr::OPropertyEditor::InsertEntry ( const OLineDescriptor &  rData,
sal_uInt16  _nPageId,
sal_uInt16  nPos = EDITOR_LIST_APPEND 
)

Definition at line 238 of file propertyeditor.cxx.

References DBG_ASSERT, pcr::OBrowserPage::getListBox(), getPage(), pcr::OBrowserListBox::InsertEntry(), m_aPropertyPageIds, nPageId, nPos, and pcr::OLineDescriptor::sName.

Referenced by pcr::OPropertyBrowserController::showPropertyUI(), and pcr::OPropertyBrowserController::UpdateUI().

◆ RemoveEntry()

void pcr::OPropertyEditor::RemoveEntry ( const OUString &  _rName)

Definition at line 253 of file propertyeditor.cxx.

References pcr::OBrowserPage::getListBox(), getPage(), m_aPropertyPageIds, and pcr::OBrowserListBox::RemoveEntry().

Referenced by pcr::OPropertyBrowserController::hidePropertyUI().

◆ RemovePage()

void pcr::OPropertyEditor::RemovePage ( sal_uInt16  nID)

Definition at line 148 of file propertyeditor.cxx.

References m_aShownPages, and m_xTabControl.

Referenced by pcr::OPropertyBrowserController::stopInspection(), and pcr::OPropertyBrowserController::UpdateUI().

◆ SetControlObserver()

void pcr::OPropertyEditor::SetControlObserver ( IPropertyControlObserver *  _pObserver)

Definition at line 198 of file propertyeditor.cxx.

References forEachPage(), m_pObserver, and setPageControlObserver().

Referenced by pcr::OPropertyBrowserController::Construct().

◆ SetHelpId()

void pcr::OPropertyEditor::SetHelpId ( const OUString &  sHelpId)

Definition at line 143 of file propertyeditor.cxx.

References m_xTabControl.

◆ setHelpSectionText()

void pcr::OPropertyEditor::setHelpSectionText ( OBrowserPage &  _rPage,
const void *  _pPointerToOUString 
)
staticprivate

Definition at line 228 of file propertyeditor.cxx.

References pcr::OBrowserPage::getListBox(), and pcr::OBrowserListBox::SetHelpText().

Referenced by SetHelpText().

◆ SetHelpText()

void pcr::OPropertyEditor::SetHelpText ( const OUString &  _rHelpText)

Definition at line 210 of file propertyeditor.cxx.

References getPage(), i, m_xTabControl, nCount, and setHelpSectionText().

Referenced by pcr::OPropertyBrowserController::setHelpSectionText().

◆ SetLineListener()

void pcr::OPropertyEditor::SetLineListener ( IPropertyLineListener *  pListener)

Definition at line 187 of file propertyeditor.cxx.

References forEachPage(), m_pListener, and setPageLineListener().

Referenced by pcr::OPropertyBrowserController::Construct().

◆ SetPage()

void pcr::OPropertyEditor::SetPage ( sal_uInt16  nId)

Definition at line 159 of file propertyeditor.cxx.

References m_xTabControl, and nId.

Referenced by pcr::OPropertyBrowserView::activatePage().

◆ setPageActivationHandler()

void pcr::OPropertyEditor::setPageActivationHandler ( const Link< const OUString &, void > &  _rHdl)
inline

Definition at line 98 of file propertyeditor.hxx.

References m_aPageActivationHandler.

◆ setPageControlObserver()

void pcr::OPropertyEditor::setPageControlObserver ( OBrowserPage &  _rPage,
const void *   
)
private

Definition at line 193 of file propertyeditor.cxx.

References pcr::OBrowserPage::getListBox(), m_pObserver, and pcr::OBrowserListBox::SetObserver().

Referenced by SetControlObserver().

◆ setPageLineListener()

void pcr::OPropertyEditor::setPageLineListener ( OBrowserPage &  _rPage,
const void *   
)
private

Definition at line 182 of file propertyeditor.cxx.

References pcr::OBrowserPage::getListBox(), m_pListener, and pcr::OBrowserListBox::SetListener().

Referenced by SetLineListener().

◆ SetPropertyValue()

void pcr::OPropertyEditor::SetPropertyValue ( const OUString &  _rEntryName,
const css::uno::Any &  _rValue,
bool  _bUnknownValue 
)

Definition at line 273 of file propertyeditor.cxx.

References pcr::OBrowserPage::getListBox(), getPage(), and pcr::OBrowserListBox::SetPropertyValue().

Referenced by pcr::OPropertyBrowserController::Commit(), and pcr::OPropertyBrowserController::propertyChange().

◆ Show()

void pcr::OPropertyEditor::Show ( )
inline

Definition at line 104 of file propertyeditor.hxx.

References m_xTabControl.

Referenced by pcr::OPropertyBrowserController::UpdateUI().

◆ ShowPropertyPage()

void pcr::OPropertyEditor::ShowPropertyPage ( sal_uInt16  _nPageId,
bool  _bShow 
)

Definition at line 289 of file propertyeditor.cxx.

References m_aHiddenPages, m_aShownPages, m_xTabControl, and nPageId.

Referenced by pcr::OPropertyBrowserController::showCategory().

Member Data Documentation

◆ m_aHiddenPages

std::map<sal_uInt16, PropertyPage> pcr::OPropertyEditor::m_aHiddenPages
private

Definition at line 65 of file propertyeditor.hxx.

Referenced by ClearAll(), and ShowPropertyPage().

◆ m_aPageActivationHandler

Link<const OUString&,void> pcr::OPropertyEditor::m_aPageActivationHandler
private

Definition at line 60 of file propertyeditor.hxx.

Referenced by setPageActivationHandler().

◆ m_aPropertyPageIds

MapStringToPageId pcr::OPropertyEditor::m_aPropertyPageIds
private

Definition at line 63 of file propertyeditor.hxx.

Referenced by ClearAll(), getPage(), InsertEntry(), and RemoveEntry().

◆ m_aShownPages

std::map<sal_uInt16, PropertyPage> pcr::OPropertyEditor::m_aShownPages
private

Definition at line 64 of file propertyeditor.hxx.

Referenced by AppendPage(), ClearAll(), CommitModified(), EnablePropertyControls(), EnablePropertyLine(), getPage(), RemovePage(), and ShowPropertyPage().

◆ m_bHasHelpSection

bool pcr::OPropertyEditor::m_bHasHelpSection
private

Definition at line 61 of file propertyeditor.hxx.

Referenced by AppendPage(), EnableHelpSection(), enableHelpSection(), and HasHelpSection().

◆ m_nNextId

sal_uInt16 pcr::OPropertyEditor::m_nNextId
private

Definition at line 59 of file propertyeditor.hxx.

Referenced by AppendPage(), and ClearAll().

◆ m_pListener

IPropertyLineListener* pcr::OPropertyEditor::m_pListener
private

Definition at line 57 of file propertyeditor.hxx.

Referenced by AppendPage(), SetLineListener(), and setPageLineListener().

◆ m_pObserver

IPropertyControlObserver* pcr::OPropertyEditor::m_pObserver
private

Definition at line 58 of file propertyeditor.hxx.

Referenced by AppendPage(), SetControlObserver(), and setPageControlObserver().

◆ m_xContainer

std::unique_ptr<weld::Container> pcr::OPropertyEditor::m_xContainer
private

Definition at line 52 of file propertyeditor.hxx.

◆ m_xContext

css::uno::Reference<css::uno::XComponentContext> pcr::OPropertyEditor::m_xContext
private

Definition at line 56 of file propertyeditor.hxx.

Referenced by ~OPropertyEditor().

◆ m_xControlHoldingParent

std::unique_ptr<weld::Container> pcr::OPropertyEditor::m_xControlHoldingParent
private

Definition at line 55 of file propertyeditor.hxx.

Referenced by AppendPage(), and OPropertyEditor().

◆ m_xTabControl

std::unique_ptr<weld::Notebook> pcr::OPropertyEditor::m_xTabControl
private

Definition at line 53 of file propertyeditor.hxx.

Referenced by AppendPage(), ClearAll(), forEachPage(), get_preferred_size(), GetCurPage(), GetPropertyControl(), getWidget(), GrabFocus(), Hide(), OPropertyEditor(), RemovePage(), SetHelpId(), SetHelpText(), SetPage(), Show(), and ShowPropertyPage().

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