framework/source/classes/fwktabwindow.cxx

   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: backingwindow.cxx,v $
  10  * $Revision: 1.12 $
  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 // autogen include statement, do not remove
  32 #include "precompiled_framework.hxx"
  33
  34 #include <classes/fwktabwindow.hxx>
  35 #include "framework.hrc"
  36 #include <classes/fwlresid.hxx>
  37
  38 #include <com/sun/star/awt/PosSize.hpp>
  39 #include <com/sun/star/awt/XContainerWindowEventHandler.hpp>
  40 #include <com/sun/star/awt/XContainerWindowProvider.hpp>
  41 #include <com/sun/star/awt/XWindow.hpp>
  42 #include <com/sun/star/awt/XWindowPeer.hpp>
  43 #include <com/sun/star/awt/XControl.hpp>
  44 #include <com/sun/star/beans/NamedValue.hpp>
  45 #include <com/sun/star/graphic/XGraphic.hpp>
  46 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  47
  48 #include <comphelper/processfactory.hxx>
  49 #include <toolkit/helper/vclunohelper.hxx>
  50 #include <tools/stream.hxx>
  51 #include <vcl/bitmap.hxx>
  52 #include <vcl/image.hxx>
  53 #include <vcl/msgbox.hxx>
  54
  55 const ::rtl::OUString SERVICENAME_WINPROVIDER
  56                                         = ::rtl::OUString::createFromAscii("com.sun.star.awt.ContainerWindowProvider");
  57 const ::rtl::OUString EXTERNAL_EVENT    = ::rtl::OUString::createFromAscii("external_event");
  58 const ::rtl::OUString BACK_METHOD       = ::rtl::OUString::createFromAscii("back");
  59 const ::rtl::OUString INITIALIZE_METHOD = ::rtl::OUString::createFromAscii("initialize");
  60 const ::rtl::OUString OK_METHOD         = ::rtl::OUString::createFromAscii("ok");
  61
  62 using namespace ::com::sun::star;
  63
  64 namespace framework
  65 {
  66
  67 // class FwkTabControl ---------------------------------------------------
  68
  69 FwkTabControl::FwkTabControl( Window* pParent, const ResId& rResId ) :
  70
  71     TabControl( pParent, rResId )
  72 {
  73 }
  74
  75 // -----------------------------------------------------------------------
  76
  77 void FwkTabControl::BroadcastEvent( ULONG nEvent )
  78 {
  79     if ( VCLEVENT_TABPAGE_ACTIVATE == nEvent || VCLEVENT_TABPAGE_DEACTIVATE == nEvent )
  80         ImplCallEventListeners( nEvent, (void*)(ULONG)GetCurPageId() );
  81     else
  82     {
  83         DBG_ERRORFILE( "FwkTabControl::BroadcastEvent(): illegal event" );
  84     }
  85 }
  86
  87 // class FwkTabPage ------------------------------------------------
  88
  89 FwkTabPage::FwkTabPage(
  90                Window* pParent, const rtl::OUString& rPageURL,
  91                const css::uno::Reference< css::awt::XContainerWindowEventHandler >& rEventHdl,
  92                const css::uno::Reference< css::awt::XContainerWindowProvider >& rProvider ) :
  93
  94     TabPage( pParent, WB_DIALOGCONTROL | WB_TABSTOP | WB_CHILDDLGCTRL ),
  95
  96     m_sPageURL          ( rPageURL ),
  97     m_xEventHdl         ( rEventHdl ),
  98     m_xWinProvider      ( rProvider )
  99
 100 {
 101 }
 102
 103 // -----------------------------------------------------------------------
 104
 105 FwkTabPage::~FwkTabPage()
 106 {
 107     Hide();
 108     DeactivatePage();
 109 }
 110
 111 // -----------------------------------------------------------------------
 112
 113 void FwkTabPage::CreateDialog()
 114 {
 115     try
 116     {
 117         uno::Reference< uno::XInterface > xHandler;
 118         if ( m_xEventHdl.is() )
 119       xHandler = m_xEventHdl;
 120
 121         uno::Reference< awt::XWindowPeer > xParent( VCLUnoHelper::GetInterface( this ), uno::UNO_QUERY );
 122         m_xPage = uno::Reference < awt::XWindow >(
 123             m_xWinProvider->createContainerWindow(
 124                 m_sPageURL, rtl::OUString(), xParent, xHandler ), uno::UNO_QUERY );
 125
 126         uno::Reference< awt::XControl > xPageControl( m_xPage, uno::UNO_QUERY );
 127         if ( xPageControl.is() )
 128         {
 129             uno::Reference< awt::XWindowPeer > xWinPeer( xPageControl->getPeer() );
 130             if ( xWinPeer.is() )
 131             {
 132                 Window* pWindow = VCLUnoHelper::GetWindow( xWinPeer );
 133                 if ( pWindow )
 134                     pWindow->SetStyle( pWindow->GetStyle() | WB_DIALOGCONTROL | WB_CHILDDLGCTRL );
 135             }
 136         }
 137
 138         CallMethod( INITIALIZE_METHOD );
 139     }
 140     catch ( lang::IllegalArgumentException& )
 141     {
 142         DBG_ERRORFILE( "FwkTabPage::CreateDialog(): illegal argument" );
 143     }
 144     catch ( uno::Exception& )
 145     {
 146         DBG_ERRORFILE( "FwkTabPage::CreateDialog(): exception of XDialogProvider2::createContainerWindow()" );
 147     }
 148 }
 149
 150 // -----------------------------------------------------------------------
 151
 152 sal_Bool FwkTabPage::CallMethod( const rtl::OUString& rMethod )
 153 {
 154     sal_Bool bRet = sal_False;
 155     if ( m_xEventHdl.is() )
 156     {
 157         try
 158         {
 159             bRet = m_xEventHdl->callHandlerMethod( m_xPage, uno::makeAny( rMethod ), EXTERNAL_EVENT );
 160         }
 161         catch ( uno::Exception& )
 162         {
 163             DBG_ERRORFILE( "FwkTabPage::CallMethod(): exception of XDialogEventHandler::callHandlerMethod()" );
 164         }
 165     }
 166     return bRet;
 167 }
 168
 169 // -----------------------------------------------------------------------
 170
 171 void FwkTabPage::ActivatePage()
 172 {
 173     TabPage::ActivatePage();
 174
 175     if ( !m_xPage.is() )
 176         CreateDialog();
 177
 178     if ( m_xPage.is() )
 179     {
 180         Resize ();
 181         m_xPage->setVisible( sal_True );
 182     }
 183 }
 184
 185 // -----------------------------------------------------------------------
 186
 187 void FwkTabPage::DeactivatePage()
 188 {
 189     TabPage::DeactivatePage();
 190
 191     if ( m_xPage.is() )
 192         m_xPage->setVisible( sal_False );
 193 }
 194
 195 // -----------------------------------------------------------------------
 196
 197 void FwkTabPage::Resize()
 198 {
 199     if ( m_xPage.is () )
 200     {
 201         Size  aSize = GetSizePixel ();
 202         Point aPos  = GetPosPixel  ();
 203
 204         m_xPage->setPosSize( 0, 0, aSize.Width()-1 , aSize.Height()-1, awt::PosSize::POSSIZE );
 205     }
 206 }
 207
 208 // -----------------------------------------------------------------------
 209
 210 void FwkTabPage::Reset()
 211 {
 212     CallMethod( BACK_METHOD );
 213     ActivatePage();
 214 }
 215
 216 // -----------------------------------------------------------------------
 217
 218 void FwkTabPage::Save()
 219 {
 220     CallMethod( OK_METHOD );
 221 }
 222
 223 // class FwkTabWindow ---------------------------------------------
 224
 225 FwkTabWindow::FwkTabWindow( Window* pParent ) :
 226
 227     Window( pParent, FwlResId( WIN_TABWINDOW ) ),
 228
 229     m_aTabCtrl  ( this, FwlResId( TC_TABCONTROL ) )
 230 {
 231     uno::Reference < lang::XMultiServiceFactory > xFactory( ::comphelper::getProcessServiceFactory() );
 232     m_xWinProvider = uno::Reference < awt::XContainerWindowProvider >(
 233         xFactory->createInstance( SERVICENAME_WINPROVIDER ), uno::UNO_QUERY );
 234
 235     SetPaintTransparent(true);
 236
 237     m_aTabCtrl.SetActivatePageHdl( LINK( this, FwkTabWindow, ActivatePageHdl ) );
 238     m_aTabCtrl.SetDeactivatePageHdl( LINK( this, FwkTabWindow, DeactivatePageHdl ) );
 239     m_aTabCtrl.Show();
 240 }
 241
 242 // -----------------------------------------------------------------------
 243
 244 FwkTabWindow::~FwkTabWindow()
 245 {
 246     ClearEntryList();
 247 }
 248
 249 // -----------------------------------------------------------------------
 250
 251 void FwkTabWindow::ClearEntryList()
 252 {
 253     TabEntryList::const_iterator pIt;
 254     for (  pIt  = m_TabList.begin();
 255            pIt != m_TabList.end();
 256          ++pIt )
 257     {
 258         delete *pIt;
 259     }
 260
 261     m_TabList.clear();
 262 }
 263
 264 // -----------------------------------------------------------------------
 265
 266 bool FwkTabWindow::RemoveEntry( sal_Int32 nIndex )
 267 {
 268     TabEntryList::iterator pIt;
 269     for (  pIt  = m_TabList.begin();
 270            pIt != m_TabList.end();
 271          ++pIt )
 272     {
 273         if ( (*pIt)->m_nIndex == nIndex )
 274             break;
 275     }
 276
 277     // remove entry from vector
 278     if ( pIt != m_TabList.end())
 279     {
 280         m_TabList.erase(pIt);
 281         return true;
 282     }
 283     else
 284         return false;
 285 }
 286
 287 // -----------------------------------------------------------------------
 288 TabEntry* FwkTabWindow::FindEntry( sal_Int32 nIndex ) const
 289 {
 290     TabEntry* pEntry = NULL;
 291
 292     TabEntryList::const_iterator pIt;
 293     for (  pIt  = m_TabList.begin();
 294            pIt != m_TabList.end();
 295          ++pIt )
 296     {
 297         if ( (*pIt)->m_nIndex == nIndex )
 298         {
 299             pEntry = *pIt;
 300             break;
 301         }
 302     }
 303
 304     return pEntry;
 305 }
 306
 307 // -----------------------------------------------------------------------
 308
 309 IMPL_LINK( FwkTabWindow, ActivatePageHdl, TabControl *, EMPTYARG )
 310 {
 311     const USHORT nId = m_aTabCtrl.GetCurPageId();
 312     FwkTabPage* pTabPage = static_cast< FwkTabPage* >( m_aTabCtrl.GetTabPage( nId ) );
 313     if ( !pTabPage )
 314     {
 315         TabEntry* pEntry = FindEntry( nId );
 316         if ( pEntry )
 317         {
 318             pTabPage = new FwkTabPage( &m_aTabCtrl, pEntry->m_sPageURL, pEntry->m_xEventHdl, m_xWinProvider );
 319             pEntry->m_pPage = pTabPage;
 320             m_aTabCtrl.SetTabPage( nId, pTabPage );
 321             pTabPage->Show();
 322             pTabPage->ActivatePage();
 323         }
 324     } else {
 325         pTabPage->ActivatePage();
 326     }
 327     m_aTabCtrl.BroadcastEvent( VCLEVENT_TABPAGE_ACTIVATE );
 328     return 1;
 329 }
 330
 331 // -----------------------------------------------------------------------
 332
 333 IMPL_LINK( FwkTabWindow, DeactivatePageHdl, TabControl *, EMPTYARG )
 334 {
 335     m_aTabCtrl.BroadcastEvent( VCLEVENT_TABPAGE_DEACTIVATE );
 336     return 1;
 337 }
 338
 339 // -----------------------------------------------------------------------
 340
 341 IMPL_LINK( FwkTabWindow, CloseHdl, PushButton *, EMPTYARG )
 342 {
 343 //    Close();
 344     return 0;
 345 }
 346
 347 // -----------------------------------------------------------------------
 348
 349 void FwkTabWindow::AddEventListener( const Link& rEventListener )
 350 {
 351     m_aTabCtrl.AddEventListener( rEventListener );
 352 }
 353
 354 // -----------------------------------------------------------------------
 355
 356 FwkTabPage* FwkTabWindow::AddTabPage( sal_Int32 nIndex, const uno::Sequence< beans::NamedValue >& rProperties )
 357 {
 358     ::rtl::OUString sTitle, sToolTip, sPageURL;
 359     uno::Reference< css::awt::XContainerWindowEventHandler > xEventHdl;
 360     uno::Reference< graphic::XGraphic > xImage;
 361     bool bDisabled = false;
 362
 363     sal_Int32 i = 0, nLen = rProperties.getLength();
 364     for ( i = 0; i < nLen; ++i )
 365     {
 366         beans::NamedValue aValue = rProperties[i];
 367         ::rtl::OUString sName = aValue.Name;
 368
 369         if ( sName.equalsAscii("Title") )
 370             aValue.Value >>= sTitle;
 371         else if ( sName.equalsAscii("ToolTip") )
 372             aValue.Value >>= sToolTip;
 373         else if ( sName.equalsAscii("PageURL") )
 374             aValue.Value >>= sPageURL;
 375         else if ( sName.equalsAscii("EventHdl") )
 376             aValue.Value >>= xEventHdl;
 377         else if ( sName.equalsAscii("Image") )
 378             aValue.Value >>= xImage;
 379         else if ( sName.equalsAscii("Disabled") )
 380             aValue.Value >>= bDisabled;
 381     }
 382
 383     TabEntry* pEntry = new TabEntry( nIndex, sPageURL, xEventHdl );
 384     m_TabList.push_back( pEntry );
 385     USHORT nIdx = static_cast< USHORT >( nIndex );
 386     m_aTabCtrl.InsertPage( nIdx, sTitle );
 387     if ( sToolTip.getLength() > 0 )
 388         m_aTabCtrl.SetHelpText( nIdx, sToolTip );
 389     if ( xImage.is() )
 390         m_aTabCtrl.SetPageImage( nIdx, Image( xImage ) );
 391     if ( bDisabled )
 392         m_aTabCtrl.EnablePage( nIdx, false );
 393
 394     return pEntry->m_pPage;
 395 }
 396
 397 // -----------------------------------------------------------------------
 398
 399 void FwkTabWindow::ActivatePage( sal_Int32 nIndex )
 400 {
 401     m_aTabCtrl.SetCurPageId( static_cast< USHORT >( nIndex ) );
 402     ActivatePageHdl( &m_aTabCtrl );
 403 }
 404
 405 // -----------------------------------------------------------------------
 406
 407 void FwkTabWindow::RemovePage( sal_Int32 nIndex )
 408 {
 409     TabEntry* pEntry = FindEntry(nIndex);
 410     if ( pEntry )
 411     {
 412         m_aTabCtrl.RemovePage( static_cast< USHORT >( nIndex ) );
 413         if (RemoveEntry(nIndex))
 414             delete pEntry;
 415     }
 416 }
 417
 418 // -----------------------------------------------------------------------
 419
 420 sal_Int32 FwkTabWindow::GetActivePageId() const
 421 {
 422     return m_aTabCtrl.GetCurPageId();
 423 }
 424
 425 // -----------------------------------------------------------------------
 426 void FwkTabWindow::Resize()
 427 {
 428     Size aPageSize = GetSizePixel();
 429     m_aTabCtrl.SetTabPageSizePixel( aPageSize );
 430 }
 431
 432 } // namespace framework
 433