framework/source/classes/fwktabwindow.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 // autogen include statement, do not remove
  21
  22 #include <classes/fwktabwindow.hxx>
  23 #include "framework.hrc"
  24 #include <classes/fwkresid.hxx>
  25
  26 #include <com/sun/star/awt/PosSize.hpp>
  27 #include <com/sun/star/awt/XContainerWindowEventHandler.hpp>
  28 #include <com/sun/star/awt/ContainerWindowProvider.hpp>
  29 #include <com/sun/star/awt/XWindow.hpp>
  30 #include <com/sun/star/awt/XWindowPeer.hpp>
  31 #include <com/sun/star/awt/XControl.hpp>
  32 #include <com/sun/star/beans/NamedValue.hpp>
  33 #include <com/sun/star/graphic/XGraphic.hpp>
  34
  35 #include <comphelper/processfactory.hxx>
  36 #include <toolkit/helper/vclunohelper.hxx>
  37 #include <tools/stream.hxx>
  38 #include <tools/diagnose_ex.h>
  39 #include <vcl/bitmap.hxx>
  40 #include <vcl/image.hxx>
  41 #include <vcl/msgbox.hxx>
  42
  43 const char EXTERNAL_EVENT[] = "external_event";
  44 const char INITIALIZE_METHOD[] = "initialize";
  45
  46 using namespace ::com::sun::star;
  47
  48 namespace framework
  49 {
  50
  51 // class FwkTabControl ---------------------------------------------------
  52 FwkTabControl::FwkTabControl( Window* pParent, const ResId& rResId ) :
  53
  54     TabControl( pParent, rResId )
  55 {
  56 }
  57
  58 // -----------------------------------------------------------------------
  59
  60 void FwkTabControl::BroadcastEvent( sal_uLong nEvent )
  61 {
  62     if ( VCLEVENT_TABPAGE_ACTIVATE == nEvent || VCLEVENT_TABPAGE_DEACTIVATE == nEvent )
  63         ImplCallEventListeners( nEvent, (void*)(sal_uIntPtr)GetCurPageId() );
  64     else
  65     {
  66         SAL_WARN( "fwk", "FwkTabControl::BroadcastEvent(): illegal event" );
  67     }
  68 }
  69
  70 // class FwkTabPage ------------------------------------------------
  71
  72 FwkTabPage::FwkTabPage(
  73                Window* pParent, const OUString& rPageURL,
  74                const css::uno::Reference< css::awt::XContainerWindowEventHandler >& rEventHdl,
  75                const css::uno::Reference< css::awt::XContainerWindowProvider >& rProvider ) :
  76
  77     TabPage( pParent, WB_DIALOGCONTROL | WB_TABSTOP | WB_CHILDDLGCTRL ),
  78
  79     m_sPageURL          ( rPageURL ),
  80     m_xEventHdl         ( rEventHdl ),
  81     m_xWinProvider      ( rProvider )
  82
  83 {
  84 }
  85
  86 // -----------------------------------------------------------------------
  87
  88 FwkTabPage::~FwkTabPage()
  89 {
  90     Hide();
  91     DeactivatePage();
  92 }
  93
  94 // -----------------------------------------------------------------------
  95
  96 void FwkTabPage::CreateDialog()
  97 {
  98     try
  99     {
 100         uno::Reference< uno::XInterface > xHandler;
 101         if ( m_xEventHdl.is() )
 102       xHandler = m_xEventHdl;
 103
 104         uno::Reference< awt::XWindowPeer > xParent( VCLUnoHelper::GetInterface( this ), uno::UNO_QUERY );
 105         m_xPage = uno::Reference < awt::XWindow >(
 106             m_xWinProvider->createContainerWindow(
 107                 m_sPageURL, OUString(), xParent, xHandler ), uno::UNO_QUERY );
 108
 109         uno::Reference< awt::XControl > xPageControl( m_xPage, uno::UNO_QUERY );
 110         if ( xPageControl.is() )
 111         {
 112             uno::Reference< awt::XWindowPeer > xWinPeer( xPageControl->getPeer() );
 113             if ( xWinPeer.is() )
 114             {
 115                 Window* pWindow = VCLUnoHelper::GetWindow( xWinPeer );
 116                 if ( pWindow )
 117                     pWindow->SetStyle( pWindow->GetStyle() | WB_DIALOGCONTROL | WB_CHILDDLGCTRL );
 118             }
 119         }
 120
 121         CallMethod( OUString(INITIALIZE_METHOD) );
 122     }
 123     catch ( const lang::IllegalArgumentException& )
 124     {
 125         SAL_WARN( "fwk", "FwkTabPage::CreateDialog(): illegal argument" );
 126     }
 127     catch ( const uno::Exception& )
 128     {
 129         SAL_WARN( "fwk", "FwkTabPage::CreateDialog(): exception of XDialogProvider2::createContainerWindow()" );
 130     }
 131 }
 132
 133 // -----------------------------------------------------------------------
 134
 135 sal_Bool FwkTabPage::CallMethod( const OUString& rMethod )
 136 {
 137     sal_Bool bRet = sal_False;
 138     if ( m_xEventHdl.is() )
 139     {
 140         try
 141         {
 142             bRet = m_xEventHdl->callHandlerMethod( m_xPage, uno::makeAny( rMethod ), OUString(EXTERNAL_EVENT) );
 143         }
 144         catch ( const uno::Exception& )
 145         {
 146             DBG_UNHANDLED_EXCEPTION();
 147         }
 148     }
 149     return bRet;
 150 }
 151
 152 // -----------------------------------------------------------------------
 153
 154 void FwkTabPage::ActivatePage()
 155 {
 156     TabPage::ActivatePage();
 157
 158     if ( !m_xPage.is() )
 159         CreateDialog();
 160
 161     if ( m_xPage.is() )
 162     {
 163         Resize ();
 164         m_xPage->setVisible( sal_True );
 165     }
 166 }
 167
 168 // -----------------------------------------------------------------------
 169
 170 void FwkTabPage::DeactivatePage()
 171 {
 172     TabPage::DeactivatePage();
 173
 174     if ( m_xPage.is() )
 175         m_xPage->setVisible( sal_False );
 176 }
 177
 178 // -----------------------------------------------------------------------
 179
 180 void FwkTabPage::Resize()
 181 {
 182     if ( m_xPage.is () )
 183     {
 184         Size aSize = GetSizePixel();
 185
 186         m_xPage->setPosSize( 0, 0, aSize.Width()-1 , aSize.Height()-1, awt::PosSize::POSSIZE );
 187     }
 188 }
 189
 190 // class FwkTabWindow ---------------------------------------------
 191
 192 FwkTabWindow::FwkTabWindow( Window* pParent ) :
 193
 194     Window( pParent, FwkResId( WIN_TABWINDOW ) ),
 195
 196     m_aTabCtrl  ( this, FwkResId( TC_TABCONTROL ) )
 197 {
 198     m_xWinProvider = awt::ContainerWindowProvider::create( ::comphelper::getProcessComponentContext() );
 199
 200     SetPaintTransparent(true);
 201
 202     m_aTabCtrl.SetActivatePageHdl( LINK( this, FwkTabWindow, ActivatePageHdl ) );
 203     m_aTabCtrl.SetDeactivatePageHdl( LINK( this, FwkTabWindow, DeactivatePageHdl ) );
 204     m_aTabCtrl.Show();
 205 }
 206
 207 // -----------------------------------------------------------------------
 208
 209 FwkTabWindow::~FwkTabWindow()
 210 {
 211     ClearEntryList();
 212 }
 213
 214 // -----------------------------------------------------------------------
 215
 216 void FwkTabWindow::ClearEntryList()
 217 {
 218     TabEntryList::const_iterator pIt;
 219     for (  pIt  = m_TabList.begin();
 220            pIt != m_TabList.end();
 221          ++pIt )
 222     {
 223         delete *pIt;
 224     }
 225
 226     m_TabList.clear();
 227 }
 228
 229 // -----------------------------------------------------------------------
 230
 231 bool FwkTabWindow::RemoveEntry( sal_Int32 nIndex )
 232 {
 233     TabEntryList::iterator pIt;
 234     for (  pIt  = m_TabList.begin();
 235            pIt != m_TabList.end();
 236          ++pIt )
 237     {
 238         if ( (*pIt)->m_nIndex == nIndex )
 239             break;
 240     }
 241
 242     // remove entry from vector
 243     if ( pIt != m_TabList.end())
 244     {
 245         m_TabList.erase(pIt);
 246         return true;
 247     }
 248     else
 249         return false;
 250 }
 251
 252 // -----------------------------------------------------------------------
 253 TabEntry* FwkTabWindow::FindEntry( sal_Int32 nIndex ) const
 254 {
 255     TabEntry* pEntry = NULL;
 256
 257     TabEntryList::const_iterator pIt;
 258     for (  pIt  = m_TabList.begin();
 259            pIt != m_TabList.end();
 260          ++pIt )
 261     {
 262         if ( (*pIt)->m_nIndex == nIndex )
 263         {
 264             pEntry = *pIt;
 265             break;
 266         }
 267     }
 268
 269     return pEntry;
 270 }
 271
 272 // -----------------------------------------------------------------------
 273
 274 IMPL_LINK_NOARG(FwkTabWindow, ActivatePageHdl)
 275 {
 276     const sal_uInt16 nId = m_aTabCtrl.GetCurPageId();
 277     FwkTabPage* pTabPage = static_cast< FwkTabPage* >( m_aTabCtrl.GetTabPage( nId ) );
 278     if ( !pTabPage )
 279     {
 280         TabEntry* pEntry = FindEntry( nId );
 281         if ( pEntry )
 282         {
 283             pTabPage = new FwkTabPage( &m_aTabCtrl, pEntry->m_sPageURL, pEntry->m_xEventHdl, m_xWinProvider );
 284             pEntry->m_pPage = pTabPage;
 285             m_aTabCtrl.SetTabPage( nId, pTabPage );
 286             pTabPage->Show();
 287             pTabPage->ActivatePage();
 288         }
 289     } else {
 290         pTabPage->ActivatePage();
 291     }
 292     m_aTabCtrl.BroadcastEvent( VCLEVENT_TABPAGE_ACTIVATE );
 293     return 1;
 294 }
 295
 296 // -----------------------------------------------------------------------
 297
 298 IMPL_LINK_NOARG(FwkTabWindow, DeactivatePageHdl)
 299 {
 300     m_aTabCtrl.BroadcastEvent( VCLEVENT_TABPAGE_DEACTIVATE );
 301     return 1;
 302 }
 303
 304 // -----------------------------------------------------------------------
 305
 306 void FwkTabWindow::AddEventListener( const Link& rEventListener )
 307 {
 308     m_aTabCtrl.AddEventListener( rEventListener );
 309 }
 310
 311 void FwkTabWindow::RemoveEventListener( const Link& rEventListener )
 312 {
 313     m_aTabCtrl.RemoveEventListener( rEventListener );
 314 }
 315
 316 // -----------------------------------------------------------------------
 317
 318 FwkTabPage* FwkTabWindow::AddTabPage( sal_Int32 nIndex, const uno::Sequence< beans::NamedValue >& rProperties )
 319 {
 320     OUString sTitle, sToolTip, sPageURL;
 321     uno::Reference< css::awt::XContainerWindowEventHandler > xEventHdl;
 322     uno::Reference< graphic::XGraphic > xImage;
 323     bool bDisabled = false;
 324
 325     sal_Int32 i = 0, nLen = rProperties.getLength();
 326     for ( i = 0; i < nLen; ++i )
 327     {
 328         beans::NamedValue aValue = rProperties[i];
 329         OUString sName = aValue.Name;
 330
 331         if ( sName == "Title" )
 332             aValue.Value >>= sTitle;
 333         else if ( sName == "ToolTip" )
 334             aValue.Value >>= sToolTip;
 335         else if ( sName == "PageURL" )
 336             aValue.Value >>= sPageURL;
 337         else if ( sName == "EventHdl" )
 338             aValue.Value >>= xEventHdl;
 339         else if ( sName == "Image" )
 340             aValue.Value >>= xImage;
 341         else if ( sName == "Disabled" )
 342             aValue.Value >>= bDisabled;
 343     }
 344
 345     TabEntry* pEntry = new TabEntry( nIndex, sPageURL, xEventHdl );
 346     m_TabList.push_back( pEntry );
 347     sal_uInt16 nIdx = static_cast< sal_uInt16 >( nIndex );
 348     m_aTabCtrl.InsertPage( nIdx, sTitle );
 349     if ( !sToolTip.isEmpty() )
 350         m_aTabCtrl.SetHelpText( nIdx, sToolTip );
 351     if ( xImage.is() )
 352         m_aTabCtrl.SetPageImage( nIdx, Image( xImage ) );
 353     if ( bDisabled )
 354         m_aTabCtrl.EnablePage( nIdx, false );
 355
 356     return pEntry->m_pPage;
 357 }
 358
 359 // -----------------------------------------------------------------------
 360
 361 void FwkTabWindow::ActivatePage( sal_Int32 nIndex )
 362 {
 363     m_aTabCtrl.SetCurPageId( static_cast< sal_uInt16 >( nIndex ) );
 364     ActivatePageHdl( &m_aTabCtrl );
 365 }
 366
 367 // -----------------------------------------------------------------------
 368
 369 void FwkTabWindow::RemovePage( sal_Int32 nIndex )
 370 {
 371     TabEntry* pEntry = FindEntry(nIndex);
 372     if ( pEntry )
 373     {
 374         m_aTabCtrl.RemovePage( static_cast< sal_uInt16 >( nIndex ) );
 375         if (RemoveEntry(nIndex))
 376             delete pEntry;
 377     }
 378 }
 379
 380 // -----------------------------------------------------------------------
 381 void FwkTabWindow::Resize()
 382 {
 383     Size aPageSize = GetSizePixel();
 384     m_aTabCtrl.SetTabPageSizePixel( aPageSize );
 385 }
 386
 387 } // namespace framework
 388
 389 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */