dbaccess/source/ui/dlg/adminpages.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef _DBAUI_ADMINPAGES_HXX_
  30 #define _DBAUI_ADMINPAGES_HXX_
  31
  32 #include <sfx2/tabdlg.hxx>
  33 #include "dsntypes.hxx"
  34 #include "commontypes.hxx"
  35 #include <svtools/wizardmachine.hxx>
  36 #include <vcl/field.hxx>
  37 #include <vcl/fixed.hxx>
  38
  39
  40 class NumericField;
  41 class Edit;
  42 //.........................................................................
  43 namespace dbaui
  44 {
  45 //.........................................................................
  46     /// helper class to wrap the savevalue and disable call
  47     class SAL_NO_VTABLE ISaveValueWrapper
  48     {
  49     public:
  50         virtual ~ISaveValueWrapper() = 0;
  51         virtual bool SaveValue() = 0;
  52         virtual bool Disable() = 0;
  53     };
  54
  55     template < class T > class OSaveValueWrapper : public ISaveValueWrapper
  56     {
  57         T*  m_pSaveValue;
  58     public:
  59         OSaveValueWrapper(T* _pSaveValue) : m_pSaveValue(_pSaveValue)
  60         { OSL_ENSURE(m_pSaveValue,"Illegal argument!"); }
  61
  62         virtual bool SaveValue() { m_pSaveValue->SaveValue(); return true;} // bool return value only for stl
  63         virtual bool Disable() { m_pSaveValue->Disable(); return true;} // bool return value only for stl
  64     };
  65
  66     template < class T > class ODisableWrapper : public ISaveValueWrapper
  67     {
  68         T*  m_pSaveValue;
  69     public:
  70         ODisableWrapper(T* _pSaveValue) : m_pSaveValue(_pSaveValue)
  71         { OSL_ENSURE(m_pSaveValue,"Illegal argument!"); }
  72
  73         virtual bool SaveValue() { return true;} // bool return value only for stl
  74         virtual bool Disable() { m_pSaveValue->Disable(); return true;} // bool return value only for stl
  75     };
  76
  77     struct TSaveValueWrapperFunctor : public ::std::unary_function< ISaveValueWrapper, bool>
  78     {
  79         bool operator() (ISaveValueWrapper* lhs)
  80         {
  81             return lhs->SaveValue();
  82         }
  83     };
  84     struct TDisableWrapperFunctor : public ::std::unary_function< ISaveValueWrapper, bool>
  85     {
  86         bool operator() (ISaveValueWrapper* lhs)
  87         {
  88             return lhs->Disable();
  89         }
  90     };
  91
  92     struct TDeleteWrapperFunctor : public ::std::unary_function< ISaveValueWrapper, bool>
  93     {
  94         bool operator() (ISaveValueWrapper* lhs)
  95         {
  96             delete lhs;
  97             return true;
  98         }
  99     };
 100
 101     //=========================================================================
 102     //= OGenericAdministrationPage
 103     //=========================================================================
 104     class IDatabaseSettingsDialog;
 105     class IItemSetHelper;
 106     class OGenericAdministrationPage    :public SfxTabPage
 107                                         ,public ::svt::IWizardPageController
 108     {
 109     private:
 110         Link            m_aModifiedHandler;     /// to be called if something on the page has been modified
 111         sal_Bool        m_abEnableRoadmap;
 112     protected:
 113         IDatabaseSettingsDialog*   m_pAdminDialog;
 114         IItemSetHelper* m_pItemSetHelper;
 115         FixedText*      m_pFT_HeaderText;
 116
 117         ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
 118                             m_xORB;
 119     public:
 120         OGenericAdministrationPage(Window* _pParent, const ResId& _rId, const SfxItemSet& _rAttrSet);
 121         ~OGenericAdministrationPage();
 122
 123         /// set a handler which gets called every time something on the page has been modified
 124         void SetModifiedHandler(const Link& _rHandler) { m_aModifiedHandler = _rHandler; }
 125
 126         /** Sets the ParentDialog
 127             @param  _pAdminDialog
 128                 the ParentDialog
 129             @param  _pItemSetHelper
 130                 the itemset helper
 131         */
 132         inline void SetAdminDialog(IDatabaseSettingsDialog* _pDialog,IItemSetHelper* _pItemSetHelper)
 133         {
 134             OSL_ENSURE(_pDialog && _pItemSetHelper,"Values are NULL!");
 135             m_pAdminDialog = _pDialog;
 136             m_pItemSetHelper = _pItemSetHelper;
 137         }
 138
 139         /** Sets the ServiceFactory
 140             @param  _rxORB
 141                 The service factory.
 142         */
 143         virtual void SetServiceFactory(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > _rxORB)
 144         {
 145             m_xORB = _rxORB;
 146         }
 147
 148         /** opens a dialog filled with all data sources available for this type and
 149             returns the selected on.
 150             @param  _eType
 151                 The type for which the data source dialog should be opened.
 152             @param  _sReturn
 153                 <OUT/> contains the selected name.
 154             @return
 155                 <FALSE/> if an error occurred, otherwise <TRUE/>
 156         */
 157         sal_Bool getSelectedDataSource(::rtl::OUString& _sReturn,::rtl::OUString& _sCurr);
 158
 159         // svt::IWizardPageController
 160         virtual void initializePage();
 161         virtual sal_Bool commitPage( ::svt::WizardTypes::CommitPageReason _eReason );
 162         virtual bool canAdvance() const;
 163
 164         void                SetRoadmapStateValue( sal_Bool _bDoEnable ) { m_abEnableRoadmap = _bDoEnable; }
 165         bool                GetRoadmapStateValue() const { return m_abEnableRoadmap; }
 166
 167     protected:
 168         /// default implementation: call FillItemSet, call prepareLeave,
 169         virtual int DeactivatePage(SfxItemSet* pSet);
 170         using SfxTabPage::DeactivatePage;
 171         /// default implementation: call implInitControls with the given item set and _bSaveValue = sal_False
 172         virtual void Reset(const SfxItemSet& _rCoreAttrs);
 173         /// default implementation: call implInitControls with the given item set and _bSaveValue = sal_True
 174         virtual void ActivatePage(const SfxItemSet& _rSet);
 175
 176         // TabPage overridables
 177         virtual void    ActivatePage();
 178
 179     protected:
 180         void callModifiedHdl() const { if (m_aModifiedHandler.IsSet()) m_aModifiedHandler.Call((void*)this); }
 181
 182         /// called from within DeactivatePage. The page is allowed to be deactivated if this method returns sal_True
 183         virtual sal_Bool prepareLeave() { return sal_True; }
 184
 185         /** called from within Reset and ActivatePage, use to initialize the controls with the items from the given set
 186             @param      _bSaveValue     if set to sal_True, the implementation should call SaveValue on all relevant controls
 187         */
 188         virtual void implInitControls(const SfxItemSet& _rSet, sal_Bool _bSaveValue);
 189
 190         /// analyze the invalid and the readonly flag which may be present in the set
 191         void getFlags(const SfxItemSet& _rSet, sal_Bool& _rValid, sal_Bool& _rReadonly);
 192
 193         /** will be called inside <method>implInitControls</method> to save the value if necessary
 194             @param  _rControlList
 195                 The list must be filled with the controls.
 196                 It is not allowed to clear the list before pusching data into it.
 197         */
 198         virtual void fillControls(::std::vector< ISaveValueWrapper* >& _rControlList) = 0;
 199
 200         /** will be called inside <method>implInitControls</method> to disable if necessary
 201             @param  _rControlList
 202                 The list must be filled with the controls.
 203                 It is not allowed to clear the list before pusching data into it.
 204         */
 205         virtual void fillWindows(::std::vector< ISaveValueWrapper* >& _rControlList) = 0;
 206
 207     public:
 208         /** fills the Boolean value into the item set when the value changed.
 209             @param  _rSet
 210                 The item set where to put the new value into.
 211             @param  _pCheckBox
 212                 The check box which is checked.
 213             @param  _nID
 214                 The id in the itemset to set whith the new value.
 215             @param  _bChangedSomething
 216                 <TRUE/> if something changed otherwise <FALSE/>
 217             @param _bRevertValue
 218                 set to <TRUE/> if the display value should be reverted before putting it into the set
 219         */
 220         static void fillBool( SfxItemSet& _rSet, CheckBox* _pCheckBox, sal_uInt16 _nID, sal_Bool& _bChangedSomething, bool _bRevertValue = false);
 221
 222         /** fills the int value into the item set when the value changed.
 223             @param  _rSet
 224                 The item set where to put the new value into.
 225             @param  _pEdit
 226                 The check box which is checked.
 227             @param  _nID
 228                 The id in the itemset to set whith the new value.
 229             @param  _bChangedSomething
 230                 <TRUE/> if something changed otherwise <FALSE/>
 231         */
 232         static void fillInt32(SfxItemSet& _rSet,NumericField* _pEdit,sal_uInt16 _nID,sal_Bool& _bChangedSomething);
 233
 234         /** fills the String value into the item set when the value changed.
 235             @param  _rSet
 236                 The item set where to put the new value into.
 237             @param  _pEdit
 238                 The check box which is checked.
 239             @param  _nID
 240                 The id in the itemset to set whith the new value.
 241             @param  _bChangedSomething
 242                 <TRUE/> if something changed otherwise <FALSE/>
 243         */
 244         static void fillString(SfxItemSet& _rSet,Edit* _pEdit,sal_uInt16 _nID,sal_Bool& _bChangedSomething);
 245
 246     protected:
 247         // used to set the right Pane header of a wizard to bold
 248         void SetControlFontWeight(Window* _pWindow, FontWeight _eWeight = WEIGHT_BOLD);
 249         void SetHeaderText( sal_uInt16 _nFTResId, sal_uInt16 _StringResId);
 250
 251         /** This link be used for controls where the tabpage does not need to take any special action when the control
 252             is modified. The implementation just calls callModifiedHdl.
 253         */
 254         DECL_LINK(OnControlModified, void*);
 255         DECL_LINK(OnTestConnectionClickHdl,PushButton*);
 256
 257         /// may be used in SetXXXHdl calls to controls, is a link to <method>OnControlModified</method>
 258         virtual Link getControlModifiedLink() { return LINK(this, OGenericAdministrationPage, OnControlModified); }
 259     };
 260
 261     //=========================================================================
 262     //= ControlRelation
 263     //=========================================================================
 264     enum ControlRelation
 265     {
 266         RelatedControls, UnrelatedControls
 267     };
 268
 269     //=========================================================================
 270     //= LayoutHelper
 271     //=========================================================================
 272     class LayoutHelper
 273     {
 274     public:
 275         static void     positionBelow(
 276                             const Control& _rReference,
 277                             Control& _rControl,
 278                             const ControlRelation _eRelation,
 279                             const long _nIndentAppFont
 280                         );
 281         /** fits the button size to be large enough to contain the buttons text
 282         */
 283         static void fitSizeRightAligned( PushButton& io_button );
 284             // why is CalcMinimumSize not a virtual method of ::Window?
 285     };
 286
 287 //.........................................................................
 288 }   // namespace dbaui
 289 //.........................................................................
 290
 291 #endif // _DBAUI_ADMINPAGES_HXX_
 292
 293
 294 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */