extensions/source/propctrlr/propertyeditor.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 _EXTENSIONS_PROPCTRLR_PROPERTYEDITOR_HXX_
  30 #define _EXTENSIONS_PROPCTRLR_PROPERTYEDITOR_HXX_
  31
  32 #include "pcrcommon.hxx"
  33
  34 /** === begin UNO includes === **/
  35 #include <com/sun/star/inspection/XPropertyControl.hpp>
  36 /** === end UNO includes === **/
  37 #include <vcl/tabctrl.hxx>
  38 #include <comphelper/stl_types.hxx>
  39 #include <boost/mem_fn.hpp>
  40 #include <map>
  41
  42 //............................................................................
  43 namespace pcr
  44 {
  45 //............................................................................
  46
  47     class IPropertyLineListener;
  48     class IPropertyControlObserver;
  49     class OBrowserPage;
  50     struct OLineDescriptor;
  51     class OBrowserListBox;
  52
  53     //========================================================================
  54     //= OPropertyEditor
  55     //========================================================================
  56     class OPropertyEditor : public Control
  57     {
  58     private:
  59         typedef ::std::map< ::rtl::OUString, sal_uInt16 >   MapStringToPageId;
  60         struct HiddenPage
  61         {
  62             sal_uInt16  nPos;
  63             TabPage*    pPage;
  64             HiddenPage() : nPos( 0 ), pPage( NULL ) { }
  65             HiddenPage( sal_uInt16 _nPos, TabPage* _pPage ) : nPos( _nPos ), pPage( _pPage ) { }
  66         };
  67
  68     private:
  69         TabControl                  m_aTabControl;
  70         IPropertyLineListener*      m_pListener;
  71         IPropertyControlObserver*   m_pObserver;
  72         sal_uInt16                  m_nNextId;
  73         Link                        m_aPageActivationHandler;
  74         bool                        m_bHasHelpSection;
  75         sal_Int32                   m_nMinHelpLines;
  76         sal_Int32                   m_nMaxHelpLines;
  77
  78         MapStringToPageId                       m_aPropertyPageIds;
  79         ::std::map< sal_uInt16, HiddenPage >    m_aHiddenPages;
  80
  81     protected:
  82         void                        Resize();
  83         void                        GetFocus();
  84
  85     public:
  86                                     OPropertyEditor (Window* pParent, WinBits nWinStyle = WB_DIALOGCONTROL);
  87
  88                                     ~OPropertyEditor();
  89
  90         void                        EnableUpdate();
  91         void                        DisableUpdate();
  92
  93         void                        SetLineListener( IPropertyLineListener* );
  94         void                        SetControlObserver( IPropertyControlObserver* );
  95
  96         void                        EnableHelpSection( bool _bEnable );
  97         bool                        HasHelpSection() const;
  98         void                        SetHelpText( const ::rtl::OUString& _rHelpText );
  99         void                        SetHelpLineLimites( sal_Int32 _nMinLines, sal_Int32 _nMaxLines );
 100
 101         void                        SetHelpId( const rtl::OString& sHelpId );
 102         sal_uInt16                  AppendPage( const String& r, const rtl::OString& _rHelpId );
 103         void                        SetPage( sal_uInt16 );
 104         void                        RemovePage(sal_uInt16 nID);
 105         sal_uInt16                  GetCurPage();
 106         void                        ClearAll();
 107
 108         void                        SetPropertyValue(const ::rtl::OUString& _rEntryName, const ::com::sun::star::uno::Any& _rValue, bool _bUnknownValue );
 109         ::com::sun::star::uno::Any  GetPropertyValue(const ::rtl::OUString& rEntryName ) const;
 110         sal_uInt16                  GetPropertyPos(const ::rtl::OUString& rEntryName ) const;
 111         ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >
 112                                     GetPropertyControl( const ::rtl::OUString& rEntryName );
 113         void                        EnablePropertyLine( const ::rtl::OUString& _rEntryName, bool _bEnable );
 114         void                        EnablePropertyControls( const ::rtl::OUString& _rEntryName, sal_Int16 _nControls, bool _bEnable );
 115
 116         void                        ShowPropertyPage( sal_uInt16 _nPageId, bool _bShow );
 117
 118         sal_uInt16                  InsertEntry( const OLineDescriptor&, sal_uInt16 _nPageId, sal_uInt16 nPos = EDITOR_LIST_APPEND );
 119         void                        RemoveEntry( const ::rtl::OUString& _rName );
 120         void                        ChangeEntry( const OLineDescriptor& );
 121
 122         void    setPageActivationHandler(const Link& _rHdl) { m_aPageActivationHandler = _rHdl; }
 123         Link    getPageActivationHandler() const { return m_aPageActivationHandler; }
 124
 125         // #95343# -------------------------------
 126         sal_Int32 getMinimumWidth();
 127         sal_Int32 getMinimumHeight();
 128
 129         void                        CommitModified();
 130
 131     protected:
 132         using Window::SetHelpText;
 133         using Window::Update;
 134
 135     private:
 136         OBrowserPage* getPage( sal_uInt16& _rPageId );
 137         const OBrowserPage* getPage( sal_uInt16& _rPageId ) const;
 138
 139         OBrowserPage* getPage( const ::rtl::OUString& _rPropertyName );
 140         const OBrowserPage* getPage( const ::rtl::OUString& _rPropertyName ) const;
 141
 142         void Update(const ::std::mem_fun_t<void,OBrowserListBox>& _aUpdateFunction);
 143
 144         typedef void (OPropertyEditor::*PageOperation)( OBrowserPage&, const void* );
 145         void    forEachPage( PageOperation _pOperation, const void* _pArgument = NULL );
 146
 147         void    setPageLineListener( OBrowserPage& _rPage, const void* );
 148         void    setPageControlObserver( OBrowserPage& _rPage, const void* );
 149         void    enableHelpSection( OBrowserPage& _rPage, const void* );
 150         void    setHelpSectionText( OBrowserPage& _rPage, const void* _pPointerToOUString );
 151         void    setHelpLineLimits( OBrowserPage& _rPage, const void* );
 152
 153     protected:
 154         DECL_LINK(OnPageDeactivate, void *);
 155         DECL_LINK(OnPageActivate, void *);
 156     };
 157
 158 //............................................................................
 159 } // namespace pcr
 160 //............................................................................
 161
 162 #endif // _EXTENSIONS_PROPCTRLR_PROPERTYEDITOR_HXX_
 163
 164
 165 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */