LibreOffice Module dbaccess (master) 1
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
dbaui::OCommonBehaviourTabPage Class Reference

eases the implementation of tab pages handling user/password and/or character set and/or generic options input
The controls to be used have to be defined within the resource, as usual, but this class does all the handling necessary. More...

#include <detailpages.hxx>

Inheritance diagram for dbaui::OCommonBehaviourTabPage:
[legend]
Collaboration diagram for dbaui::OCommonBehaviourTabPage:
[legend]

Public Member Functions

virtual bool FillItemSet (SfxItemSet *_rCoreAttrs) override
 
 OCommonBehaviourTabPage (weld::Container *pPage, weld::DialogController *pController, const OUString &rUIXMLDescription, const OUString &rId, const SfxItemSet &_rCoreAttrs, OCommonBehaviourTabPageFlags nControlFlags)
 
- Public Member Functions inherited from dbaui::OGenericAdministrationPage
 OGenericAdministrationPage (weld::Container *pPage, weld::DialogController *pController, const OUString &rUIXMLDescription, const OUString &rId, const SfxItemSet &rAttrSet)
 
void SetModifiedHandler (const Link< OGenericAdministrationPage const *, void > &_rHandler)
 set a handler which gets called every time something on the page has been modified More...
 
void SetAdminDialog (IDatabaseSettingsDialog *_pDialog, IItemSetHelper *_pItemSetHelper)
 Sets the ParentDialog. More...
 
void SetServiceFactory (const css::uno::Reference< css::uno::XComponentContext > &rxORB)
 Sets the ServiceFactory. More...
 
bool getSelectedDataSource (OUString &_sReturn, OUString const &_sCurr)
 opens a dialog filled with all data sources available for this type and returns the selected on. More...
 
virtual void initializePage () override
 
virtual bool commitPage (::vcl::WizardTypes::CommitPageReason _eReason) override
 
virtual bool canAdvance () const override
 
void SetRoadmapStateValue (bool _bDoEnable)
 
bool GetRoadmapStateValue () 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
 
OUString GetHelpId () const
 
OUString GetConfigId () const
 
bool IsVisible () const
 
weld::WindowGetFrameWeld () const
 
std::unordered_map< OUString, css::uno::Any > & getAdditionalProperties ()
 

Protected Member Functions

virtual ~OCommonBehaviourTabPage () override
 
virtual void implInitControls (const SfxItemSet &_rSet, bool _bSaveValue) override
 called from within Reset and ActivatePage, use to initialize the controls with the items from the given set More...
 
virtual void fillControls (std::vector< std::unique_ptr< ISaveValueWrapper > > &_rControlList) override
 will be called inside <method>implInitControls</method> to save the value if necessary More...
 
virtual void fillWindows (std::vector< std::unique_ptr< ISaveValueWrapper > > &_rControlList) override
 will be called inside <method>implInitControls</method> to disable if necessary More...
 
- Protected Member Functions inherited from dbaui::OGenericAdministrationPage
virtual DeactivateRC DeactivatePage (SfxItemSet *pSet) override
 default implementation: call FillItemSet, call prepareLeave, More...
 
virtual void Reset (const SfxItemSet *_rCoreAttrs) override
 default implementation: call implInitControls with the given item set and _bSaveValue = sal_False More...
 
virtual void ActivatePage (const SfxItemSet &_rSet) override
 default implementation: call implInitControls with the given item set and _bSaveValue = sal_True More...
 
virtual void Activate () override
 
virtual void callModifiedHdl (weld::Widget *=nullptr)
 
virtual bool prepareLeave ()
 called from within DeactivatePage. The page is allowed to be deactivated if this method returns sal_True More...
 
virtual void implInitControls (const SfxItemSet &_rSet, bool _bSaveValue)
 called from within Reset and ActivatePage, use to initialize the controls with the items from the given set More...
 
virtual void fillControls (std::vector< std::unique_ptr< ISaveValueWrapper > > &_rControlList)=0
 will be called inside <method>implInitControls</method> to save the value if necessary More...
 
virtual void fillWindows (std::vector< std::unique_ptr< ISaveValueWrapper > > &_rControlList)=0
 will be called inside <method>implInitControls</method> to disable if necessary More...
 
 DECL_LINK (OnControlModified, weld::Widget *, void)
 This link be used for controls where the tabpage does not need to take any special action when the control is modified. More...
 
 DECL_LINK (OnControlEntryModifyHdl, weld::Entry &, void)
 
 DECL_LINK (OnControlSpinButtonModifyHdl, weld::SpinButton &, void)
 
 DECL_LINK (OnControlModifiedButtonClick, weld::Toggleable &, void)
 
 DECL_LINK (OnTestConnectionButtonClickHdl, weld::Button &, void)
 
- Protected Member Functions inherited from SfxTabPage
 SfxTabPage (weld::Container *pPage, weld::DialogController *pController, const OUString &rUIXMLDescription, const OUString &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
 

Private Member Functions

 DECL_LINK (CharsetSelectHdl, weld::ComboBox &, void)
 

Private Attributes

OCommonBehaviourTabPageFlags m_nControlFlags
 
std::unique_ptr< weld::Labelm_xOptionsLabel
 
std::unique_ptr< weld::Entrym_xOptions
 
std::unique_ptr< weld::Labelm_xDataConvertLabel
 
std::unique_ptr< weld::Labelm_xCharsetLabel
 
std::unique_ptr< CharSetListBoxm_xCharset
 

Additional Inherited Members

- Static Public Member Functions inherited from dbaui::OGenericAdministrationPage
static void fillBool (SfxItemSet &_rSet, const weld::CheckButton *pCheckBox, sal_uInt16 _nID, bool bOptionalBool, bool &_bChangedSomething, bool _bRevertValue=false)
 fills the Boolean value into the item set when the value changed. More...
 
static void fillInt32 (SfxItemSet &_rSet, const weld::SpinButton *pEdit, TypedWhichId< SfxInt32Item > _nID, bool &_bChangedSomething)
 fills the int value into the item set when the value changed. More...
 
static void fillString (SfxItemSet &_rSet, const weld::Entry *pEdit, TypedWhichId< SfxStringItem > _nID, bool &_bChangedSomething)
 fills the String value into the item set when the value changed. More...
 
static void fillString (SfxItemSet &_rSet, const dbaui::OConnectionURLEdit *pEdit, TypedWhichId< SfxStringItem > _nID, bool &_bChangedSomething)
 
- 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)
 
- Static Protected Member Functions inherited from dbaui::OGenericAdministrationPage
static void getFlags (const SfxItemSet &_rSet, bool &_rValid, bool &_rReadonly)
 analyze the invalid and the readonly flag which may be present in the set More...
 
- Protected Attributes inherited from dbaui::OGenericAdministrationPage
IDatabaseSettingsDialogm_pAdminDialog
 
IItemSetHelperm_pItemSetHelper
 
css::uno::Reference< css::uno::XComponentContext > m_xORB
 

Detailed Description

eases the implementation of tab pages handling user/password and/or character set and/or generic options input
The controls to be used have to be defined within the resource, as usual, but this class does all the handling necessary.

Definition at line 46 of file detailpages.hxx.

Constructor & Destructor Documentation

◆ OCommonBehaviourTabPage()

dbaui::OCommonBehaviourTabPage::OCommonBehaviourTabPage ( weld::Container pPage,
weld::DialogController pController,
const OUString &  rUIXMLDescription,
const OUString &  rId,
const SfxItemSet _rCoreAttrs,
OCommonBehaviourTabPageFlags  nControlFlags 
)

◆ ~OCommonBehaviourTabPage()

dbaui::OCommonBehaviourTabPage::~OCommonBehaviourTabPage ( )
overrideprotectedvirtual

Definition at line 86 of file detailpages.cxx.

References m_xCharset.

Member Function Documentation

◆ DECL_LINK()

dbaui::OCommonBehaviourTabPage::DECL_LINK ( CharsetSelectHdl  ,
weld::ComboBox ,
void   
)
private

◆ fillControls()

void dbaui::OCommonBehaviourTabPage::fillControls ( std::vector< std::unique_ptr< ISaveValueWrapper > > &  _rControlList)
overrideprotectedvirtual

will be called inside <method>implInitControls</method> to save the value if necessary

Parameters
_rControlListThe list must be filled with the controls. It is not allowed to clear the list before pushing data into it.

Implements dbaui::OGenericAdministrationPage.

Reimplemented in dbaui::OUserDriverDetailsPage, dbaui::MySQLNativePage, and dbaui::OTextDetailsPage.

Definition at line 104 of file detailpages.cxx.

References m_nControlFlags, m_xCharset, m_xOptions, UseCharset, and UseOptions.

Referenced by dbaui::OUserDriverDetailsPage::fillControls(), dbaui::MySQLNativePage::fillControls(), and dbaui::OTextDetailsPage::fillControls().

◆ FillItemSet()

bool dbaui::OCommonBehaviourTabPage::FillItemSet ( SfxItemSet _rCoreAttrs)
overridevirtual

◆ fillWindows()

void dbaui::OCommonBehaviourTabPage::fillWindows ( std::vector< std::unique_ptr< ISaveValueWrapper > > &  _rControlList)
overrideprotectedvirtual

will be called inside <method>implInitControls</method> to disable if necessary

Parameters
_rControlListThe list must be filled with the controls. It is not allowed to clear the list before pushing data into it.

Implements dbaui::OGenericAdministrationPage.

Reimplemented in dbaui::OUserDriverDetailsPage, dbaui::MySQLNativePage, and dbaui::OTextDetailsPage.

Definition at line 91 of file detailpages.cxx.

References m_nControlFlags, m_xCharsetLabel, m_xOptionsLabel, UseCharset, and UseOptions.

Referenced by dbaui::OUserDriverDetailsPage::fillWindows(), dbaui::MySQLNativePage::fillWindows(), and dbaui::OTextDetailsPage::fillWindows().

◆ implInitControls()

void dbaui::OCommonBehaviourTabPage::implInitControls ( const SfxItemSet _rSet,
bool  _bSaveValue 
)
overrideprotectedvirtual

Member Data Documentation

◆ m_nControlFlags

OCommonBehaviourTabPageFlags dbaui::OCommonBehaviourTabPage::m_nControlFlags
private

◆ m_xCharset

std::unique_ptr<CharSetListBox> dbaui::OCommonBehaviourTabPage::m_xCharset
private

◆ m_xCharsetLabel

std::unique_ptr<weld::Label> dbaui::OCommonBehaviourTabPage::m_xCharsetLabel
private

Definition at line 54 of file detailpages.hxx.

Referenced by fillWindows(), and OCommonBehaviourTabPage().

◆ m_xDataConvertLabel

std::unique_ptr<weld::Label> dbaui::OCommonBehaviourTabPage::m_xDataConvertLabel
private

Definition at line 53 of file detailpages.hxx.

Referenced by OCommonBehaviourTabPage().

◆ m_xOptions

std::unique_ptr<weld::Entry> dbaui::OCommonBehaviourTabPage::m_xOptions
private

◆ m_xOptionsLabel

std::unique_ptr<weld::Label> dbaui::OCommonBehaviourTabPage::m_xOptionsLabel
private

Definition at line 50 of file detailpages.hxx.

Referenced by fillWindows(), and OCommonBehaviourTabPage().


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