framework/inc/services/tabwindowservice.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: urltransformer.hxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __FRAMEWORK_SERVICES_TABWINDOWSERVICE_HXX_
  32 #define __FRAMEWORK_SERVICES_TABWINDOWSERVICE_HXX_
  33
  34 /** Attention: stl headers must(!) be included at first. Otherwhise it can make trouble
  35                with solaris headers ...
  36 */
  37 #include <vector>
  38
  39 //_________________________________________________________________________________________________________________
  40 //      my own includes
  41 //_________________________________________________________________________________________________________________
  42
  43 #include <classes/fwktabwindow.hxx>
  44 #include <classes/propertysethelper.hxx>
  45 #include <threadhelp/threadhelpbase.hxx>
  46 #include <macros/generic.hxx>
  47 #include <macros/debug.hxx>
  48 #include <macros/xinterface.hxx>
  49 #include <macros/xtypeprovider.hxx>
  50 #include <macros/xserviceinfo.hxx>
  51 #include <general.h>
  52 #include <stdtypes.h>
  53
  54 //_________________________________________________________________________________________________________________
  55 //      interface includes
  56 //_________________________________________________________________________________________________________________
  57
  58 #include <com/sun/star/awt/XSimpleTabController.hpp>
  59 #include <com/sun/star/awt/XWindow.hpp>
  60 #include <com/sun/star/beans/XPropertySet.hpp>
  61
  62 //_________________________________________________________________________________________________________________
  63 //      other includes
  64 //_________________________________________________________________________________________________________________
  65
  66 #include <cppuhelper/weak.hxx>
  67 #include <vcl/window.hxx>
  68
  69 //_________________________________________________________________________________________________________________
  70 //      namespace
  71 //_________________________________________________________________________________________________________________
  72
  73 namespace framework{
  74
  75 //_________________________________________________________________________________________________________________
  76 //      exported const
  77 //_________________________________________________________________________________________________________________
  78
  79 //_________________________________________________________________________________________________________________
  80 //      exported definitions
  81 //_________________________________________________________________________________________________________________
  82
  83 struct TTabPageInfo
  84 {
  85     public:
  86
  87         TTabPageInfo()
  88             : m_nIndex      ( -1      )
  89             , m_bCreated    (sal_False)
  90             , m_pPage       ( NULL    )
  91             , m_lProperties (         )
  92         {}
  93
  94         TTabPageInfo(::sal_Int32 nID)
  95             : m_nIndex      ( nID     )
  96             , m_bCreated    (sal_False)
  97             , m_pPage       ( NULL    )
  98             , m_lProperties (         )
  99         {}
 100
 101     public:
 102
 103         ::sal_Int32                                   m_nIndex;
 104         ::sal_Bool                                    m_bCreated;
 105         FwkTabPage*                                   m_pPage;
 106         css::uno::Sequence< css::beans::NamedValue >  m_lProperties;
 107 };
 108
 109 typedef ::std::hash_map< ::sal_Int32                    ,
 110                          TTabPageInfo                   ,
 111                          Int32HashCode                  ,
 112                          ::std::equal_to< ::sal_Int32 > > TTabPageInfoHash;
 113
 114 /*-************************************************************************************************************//**
 115     @short  implements a helper service providing a dockable tab control window
 116 *//*-*************************************************************************************************************/
 117
 118 class TabWindowService :  public css::lang::XTypeProvider
 119                          ,  public css::lang::XServiceInfo
 120                          ,  public css::awt::XSimpleTabController
 121                          ,  public ThreadHelpBase
 122                          ,  public TransactionBase
 123                          ,  public PropertySetHelper
 124                          ,  public ::cppu::OWeakObject
 125 {
 126     //-------------------------------------------------------------------------------------------------------------
 127     //  public methods
 128     //-------------------------------------------------------------------------------------------------------------
 129
 130     public:
 131
 132         //---------------------------------------------------------------------------------------------------------
 133         //      constructor / destructor
 134         //---------------------------------------------------------------------------------------------------------
 135
 136         TabWindowService( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
 137         virtual ~TabWindowService();
 138
 139         //---------------------------------------------------------------------------------------------------------
 140         //      XInterface, XTypeProvider, XServiceInfo
 141         //---------------------------------------------------------------------------------------------------------
 142
 143         FWK_DECLARE_XINTERFACE
 144         FWK_DECLARE_XTYPEPROVIDER
 145         DECLARE_XSERVICEINFO
 146
 147         //---------------------------------------------------------------------------------------------------------
 148         //  XSimpleTabController
 149         //---------------------------------------------------------------------------------------------------------
 150
 151         virtual sal_Int32 SAL_CALL insertTab() throw ( css::uno::RuntimeException );
 152         virtual void SAL_CALL removeTab( sal_Int32 nID ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException );
 153         virtual void SAL_CALL setTabProps( sal_Int32 nID, const css::uno::Sequence< css::beans::NamedValue >& aProperties ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException );
 154         virtual css::uno::Sequence< css::beans::NamedValue > SAL_CALL getTabProps( sal_Int32 nID ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException );
 155         virtual void SAL_CALL activateTab( sal_Int32 nID ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException );
 156         virtual sal_Int32 SAL_CALL getActiveTabID() throw ( css::uno::RuntimeException );
 157         virtual void SAL_CALL addTabListener( const css::uno::Reference< css::awt::XTabListener >& Listener ) throw ( css::uno::RuntimeException );
 158         virtual void SAL_CALL removeTabListener( const css::uno::Reference< css::awt::XTabListener >& Listener ) throw ( css::uno::RuntimeException );
 159
 160         //---------------------------------------------------------------------------------------------------------
 161         //  XComponent
 162         //---------------------------------------------------------------------------------------------------------
 163
 164         virtual void SAL_CALL dispose() throw ( css::uno::RuntimeException );
 165         virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) throw ( css::uno::RuntimeException );
 166         virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) throw ( css::uno::RuntimeException );
 167
 168     //-------------------------------------------------------------------------------------------------------------
 169     //  protected methods
 170     //-------------------------------------------------------------------------------------------------------------
 171
 172     protected:
 173
 174     //-------------------------------------------------------------------------------------------------------------
 175     //  private methods
 176     //-------------------------------------------------------------------------------------------------------------
 177
 178     private:
 179
 180         void impl_initializePropInfo();
 181         virtual void SAL_CALL impl_setPropertyValue(const ::rtl::OUString& sProperty,
 182                                                           sal_Int32        nHandle  ,
 183                                                     const css::uno::Any&   aValue   );
 184         virtual css::uno::Any SAL_CALL impl_getPropertyValue(const ::rtl::OUString& sProperty,
 185                                                                    sal_Int32        nHandle  );
 186
 187         DECL_DLLPRIVATE_LINK( EventListener, VclSimpleEvent * );
 188
 189         void impl_checkTabIndex (::sal_Int32 nID) throw (css::lang::IndexOutOfBoundsException);
 190         TTabPageInfoHash::iterator impl_getTabPageInfo(::sal_Int32 nID) throw (css::lang::IndexOutOfBoundsException);
 191         FwkTabWindow* mem_TabWin ();
 192 /*
 193         ::cppu::IPropertyArrayHelper& SAL_CALL              getInfoHelper();
 194         const css::uno::Sequence< css::beans::Property >    impl_getStaticPropertyDescriptor();
 195         static css::uno::Reference < css::beans::XPropertySetInfo > SAL_CALL
 196                                                             createPropertySetInfo( ::cppu::IPropertyArrayHelper& rProperties ) SAL_THROW( () );
 197 */
 198     //-------------------------------------------------------------------------------------------------------------
 199     //  variables
 200     //  (should be private everyway!)
 201     //-------------------------------------------------------------------------------------------------------------
 202
 203     private:
 204
 205         /// reference to factory, which has created this instance
 206         css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory;
 207
 208         /// the tab window as XWindow ( to hold window* alive !)
 209         css::uno::Reference< css::awt::XWindow > m_xTabWin;
 210
 211         /// the VCL tab window
 212         FwkTabWindow* m_pTabWin;
 213
 214         /// container of inserted tab pages
 215         TTabPageInfoHash m_lTabPageInfos;
 216
 217         /// container of the added TabListener
 218         ::cppu::OMultiTypeInterfaceContainerHelper m_lListener;
 219
 220         /// counter of the tabpage indexes
 221         ::sal_Int32 m_nPageIndexCounter;
 222
 223         /// index of the current active page
 224         ::sal_Int32 m_nCurrentPageIndex;
 225
 226         /// title of the tabcontrolled window
 227         ::rtl::OUString m_sTitle;
 228
 229 };      //  class TabWindowService
 230
 231 }               //      namespace framework
 232
 233 #endif  //  #ifndef __FRAMEWORK_SERVICES_TABWINDOWSERVICE_HXX_
 234