toolkit/source/controls/stdtabcontroller.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 #include <com/sun/star/beans/XPropertySet.hpp>
  21 #include <com/sun/star/awt/XVclContainerPeer.hpp>
  22
  23 #include <toolkit/controls/stdtabcontroller.hxx>
  24 #include <toolkit/controls/stdtabcontrollermodel.hxx>
  25 #include <toolkit/awt/vclxwindow.hxx>
  26 #include <toolkit/helper/macros.hxx>
  27 #include <cppuhelper/typeprovider.hxx>
  28 #include <rtl/uuid.h>
  29
  30 #include <tools/debug.hxx>
  31 #include <vcl/window.hxx>
  32 #include <comphelper/sequence.hxx>
  33
  34 using namespace ::com::sun::star;
  35 using namespace ::com::sun::star::uno;
  36 using namespace ::com::sun::star::awt;
  37 using namespace ::com::sun::star::lang;
  38 using namespace ::com::sun::star::beans;
  39
  40 //  ----------------------------------------------------
  41 //  class StdTabController
  42 //  ----------------------------------------------------
  43 StdTabController::StdTabController()
  44 {
  45 }
  46
  47 StdTabController::~StdTabController()
  48 {
  49 }
  50
  51 sal_Bool StdTabController::ImplCreateComponentSequence(
  52         Sequence< Reference< XControl > >&              rControls,
  53         const Sequence< Reference< XControlModel > >&   rModels,
  54         Sequence< Reference< XWindow > >&               rComponents,
  55         Sequence< Any>*                                 pTabStops,
  56         sal_Bool bPeerComponent ) const
  57 {
  58     sal_Bool bOK = sal_True;
  59
  60     // Get only the requested controls
  61     sal_Int32 nModels = rModels.getLength();
  62     if (nModels != rControls.getLength())
  63     {
  64         Sequence< Reference< XControl > > aSeq( nModels );
  65         const Reference< XControlModel >* pModels = rModels.getConstArray();
  66         Reference< XControl >  xCurrentControl;
  67
  68         sal_Int32 nRealControls = 0;
  69         for (sal_Int32 n = 0; n < nModels; ++n, ++pModels)
  70         {
  71             xCurrentControl = FindControl(rControls, *pModels);
  72             if (xCurrentControl.is())
  73                 aSeq.getArray()[nRealControls++] = xCurrentControl;
  74         }
  75         aSeq.realloc(nRealControls);
  76         rControls = aSeq;
  77     }
  78 #ifdef DBG_UTIL
  79     DBG_ASSERT( rControls.getLength() <= rModels.getLength(), "StdTabController:ImplCreateComponentSequence: inconsistence!" );
  80         // there may be less controls than models, but never more controls than models
  81 #endif
  82
  83
  84     const Reference< XControl > * pControls = rControls.getConstArray();
  85     sal_uInt32 nCtrls = rControls.getLength();
  86     rComponents.realloc( nCtrls );
  87     Reference< XWindow > * pComps = rComponents.getArray();
  88     Any* pTabs = NULL;
  89
  90
  91     if ( pTabStops )
  92     {
  93         *pTabStops = Sequence< Any>( nCtrls );
  94         pTabs = pTabStops->getArray();
  95     }
  96
  97     for ( sal_uInt32 n = 0; bOK && ( n < nCtrls ); n++ )
  98     {
  99         // Get the matching control for this model
 100         Reference< XControl >  xCtrl(pControls[n]);
 101         if ( xCtrl.is() )
 102         {
 103             if (bPeerComponent)
 104                 pComps[n] = Reference< XWindow > (xCtrl->getPeer(), UNO_QUERY);
 105             else
 106                 pComps[n] = Reference< XWindow > (xCtrl, UNO_QUERY);
 107
 108             // TabStop-Property
 109             if ( pTabs )
 110             {
 111                 // opt: Constant String for TabStop name
 112                 static const ::rtl::OUString aTabStopName( "Tabstop" );
 113
 114                 Reference< XPropertySet >  xPSet( xCtrl->getModel(), UNO_QUERY );
 115                 Reference< XPropertySetInfo >  xInfo = xPSet->getPropertySetInfo();
 116                 if( xInfo->hasPropertyByName( aTabStopName ) )
 117                     *pTabs++ = xPSet->getPropertyValue( aTabStopName );
 118                 else
 119                     ++pTabs;
 120             }
 121         }
 122         else
 123         {
 124             OSL_TRACE( "ImplCreateComponentSequence: Control not found" );
 125             bOK = sal_False;
 126         }
 127     }
 128     return bOK;
 129 }
 130
 131 void StdTabController::ImplActivateControl( sal_Bool bFirst ) const
 132 {
 133     // HACK due to bug #53688#, map controls onto an interface if remote controls may occur
 134     Reference< XTabController >  xTabController(const_cast< ::cppu::OWeakObject* >(static_cast< const ::cppu::OWeakObject* >(this)), UNO_QUERY);
 135     Sequence< Reference< XControl > > aCtrls = xTabController->getControls();
 136     const Reference< XControl > * pControls = aCtrls.getConstArray();
 137     sal_uInt32 nCount = aCtrls.getLength();
 138
 139     for ( sal_uInt32 n = bFirst ? 0 : nCount; bFirst ? ( n < nCount ) : n; )
 140     {
 141         sal_uInt32 nCtrl = bFirst ? n++ : --n;
 142         DBG_ASSERT( pControls[nCtrl].is(), "Control nicht im Container!" );
 143         if ( pControls[nCtrl].is() )
 144         {
 145             Reference< XWindowPeer >  xCP = pControls[nCtrl]->getPeer();
 146             if ( xCP.is() )
 147             {
 148                 VCLXWindow* pC = VCLXWindow::GetImplementation( xCP );
 149                 if ( pC && pC->GetWindow() && ( pC->GetWindow()->GetStyle() & WB_TABSTOP ) )
 150                 {
 151                     pC->GetWindow()->GrabFocus();
 152                     break;
 153                 }
 154             }
 155         }
 156     }
 157 }
 158
 159 // XInterface
 160 Any StdTabController::queryAggregation( const Type & rType ) throw(RuntimeException)
 161 {
 162     Any aRet = ::cppu::queryInterface( rType,
 163                                         (static_cast< XTabController* >(this)),
 164                                         (static_cast< XServiceInfo* >(this)),
 165                                         (static_cast< XTypeProvider* >(this)) );
 166     return (aRet.hasValue() ? aRet : OWeakAggObject::queryAggregation( rType ));
 167 }
 168
 169 // XTypeProvider
 170 IMPL_XTYPEPROVIDER_START( StdTabController )
 171     getCppuType( ( Reference< XTabController>* ) NULL ),
 172     getCppuType( ( Reference< XServiceInfo>* ) NULL )
 173 IMPL_XTYPEPROVIDER_END
 174
 175 void StdTabController::setModel( const Reference< XTabControllerModel >& Model ) throw(RuntimeException)
 176 {
 177     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 178
 179     mxModel = Model;
 180 }
 181
 182 Reference< XTabControllerModel > StdTabController::getModel(  ) throw(RuntimeException)
 183 {
 184     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 185
 186     return mxModel;
 187 }
 188
 189 void StdTabController::setContainer( const Reference< XControlContainer >& Container ) throw(RuntimeException)
 190 {
 191     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 192
 193     mxControlContainer = Container;
 194 }
 195
 196 Reference< XControlContainer > StdTabController::getContainer(  ) throw(RuntimeException)
 197 {
 198     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 199
 200     return mxControlContainer;
 201 }
 202
 203 Sequence< Reference< XControl > > StdTabController::getControls(  ) throw(RuntimeException)
 204 {
 205     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 206
 207     Sequence< Reference< XControl > > aSeq;
 208
 209     if ( mxControlContainer.is() )
 210     {
 211         Sequence< Reference< XControlModel > > aModels = mxModel->getControlModels();
 212         const Reference< XControlModel > * pModels = aModels.getConstArray();
 213
 214         Sequence< Reference< XControl > > xCtrls = mxControlContainer->getControls();
 215
 216         sal_uInt32 nCtrls = aModels.getLength();
 217         aSeq = Sequence< Reference< XControl > >( nCtrls );
 218         for ( sal_uInt32 n = 0; n < nCtrls; n++ )
 219         {
 220             Reference< XControlModel >  xCtrlModel = pModels[n];
 221             // Search matching Control for this Model
 222             Reference< XControl >  xCtrl = FindControl( xCtrls, xCtrlModel );
 223             aSeq.getArray()[n] = xCtrl;
 224         }
 225     }
 226     return aSeq;
 227 }
 228
 229 void StdTabController::autoTabOrder(  ) throw(RuntimeException)
 230 {
 231     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 232
 233     DBG_ASSERT( mxControlContainer.is(), "autoTabOrder: No ControlContainer!" );
 234     if ( !mxControlContainer.is() )
 235         return;
 236
 237     Sequence< Reference< XControlModel > > aSeq = mxModel->getControlModels();
 238     Sequence< Reference< XWindow > > aCompSeq;
 239
 240     // This may return a TabController, which returns desired list of controls faster
 241     Reference< XTabController >  xTabController(static_cast< ::cppu::OWeakObject* >(this), UNO_QUERY);
 242     Sequence< Reference< XControl > > aControls = xTabController->getControls();
 243
 244     // #58317# Some Models may be missing from the Container. Plus there is a
 245     // autoTabOrder call later on.
 246     if( !ImplCreateComponentSequence( aControls, aSeq, aCompSeq, NULL, sal_False ) )
 247         return;
 248
 249     sal_uInt32 nCtrls = aCompSeq.getLength();
 250     Reference< XWindow > * pComponents = aCompSeq.getArray();
 251
 252     // insert sort algorithm
 253     ComponentEntryList aCtrls;
 254     size_t n;
 255     for ( n = 0; n < nCtrls; n++ )
 256     {
 257         XWindow* pC = (XWindow*)pComponents[n].get();
 258         ComponentEntry* pE = new ComponentEntry;
 259         pE->pComponent = pC;
 260         awt::Rectangle aPosSize = pC->getPosSize();
 261         pE->aPos.X() = aPosSize.X;
 262         pE->aPos.Y() = aPosSize.Y;
 263
 264         sal_uInt16 nPos;
 265         for ( nPos = 0; nPos < aCtrls.size(); nPos++ )
 266         {
 267             ComponentEntry* pEntry = aCtrls[ nPos ];
 268             if ( ( pEntry->aPos.Y() > pE->aPos.Y() ) ||
 269                  ( ( pEntry->aPos.Y() == pE->aPos.Y() ) && ( pEntry->aPos.X() > pE->aPos.X() ) ) )
 270                     break;
 271         }
 272         if ( nPos < aCtrls.size() ) {
 273             ComponentEntryList::iterator it = aCtrls.begin();
 274             ::std::advance( it, nPos );
 275             aCtrls.insert( it, pE );
 276         } else {
 277             aCtrls.push_back( pE );
 278         }
 279     }
 280
 281     Sequence< Reference< XControlModel > > aNewSeq( nCtrls );
 282     for ( n = 0; n < nCtrls; n++ )
 283     {
 284         ComponentEntry* pE = aCtrls[ n ];
 285         Reference< XControl >  xUC( pE->pComponent, UNO_QUERY );
 286         aNewSeq.getArray()[n] = xUC->getModel();
 287         delete pE;
 288     }
 289     aCtrls.clear();
 290
 291     mxModel->setControlModels( aNewSeq );
 292 }
 293
 294 void StdTabController::activateTabOrder(  ) throw(RuntimeException)
 295 {
 296     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 297
 298     // Activate tab order for the control container
 299
 300     Reference< XControl >  xC( mxControlContainer, UNO_QUERY );
 301     Reference< XVclContainerPeer >  xVclContainerPeer;
 302     if ( xC.is() )
 303         xVclContainerPeer = xVclContainerPeer.query( xC->getPeer() );
 304      if ( !xC.is() || !xVclContainerPeer.is() )
 305         return;
 306
 307     // This may return a TabController, which returns desired list of controls faster
 308     Reference< XTabController >  xTabController(static_cast< ::cppu::OWeakObject* >(this), UNO_QUERY);
 309
 310     // Get a flattened list of controls sequences
 311     Sequence< Reference< XControlModel > > aModels = mxModel->getControlModels();
 312     Sequence< Reference< XWindow > > aCompSeq;
 313     Sequence< Any> aTabSeq;
 314
 315     // DG: For the sake of optimization, retrieve Controls from getControls(),
 316     // this may sound counterproductive, but leads to performance improvements
 317     // in practical scenarios (Forms)
 318     Sequence< Reference< XControl > > aControls = xTabController->getControls();
 319
 320     // #58317# Some Models may be missing from the Container. Plus there is a
 321     // autoTabOrder call later on.
 322     if( !ImplCreateComponentSequence( aControls, aModels, aCompSeq, &aTabSeq, sal_True ) )
 323         return;
 324
 325     xVclContainerPeer->setTabOrder( aCompSeq, aTabSeq, mxModel->getGroupControl() );
 326
 327     ::rtl::OUString aName;
 328     Sequence< Reference< XControlModel > >  aThisGroupModels;
 329     Sequence< Reference< XWindow > >        aControlComponents;
 330
 331     sal_uInt32 nGroups = mxModel->getGroupCount();
 332     for ( sal_uInt32 nG = 0; nG < nGroups; nG++ )
 333     {
 334         mxModel->getGroup( nG, aThisGroupModels, aName );
 335
 336         aControls = xTabController->getControls();
 337             // ImplCreateComponentSequence has a really strange semantics regarding it's first parameter:
 338             // upon method entry, it expects a super set of the controls which it returns
 339             // this means we need to completely fill this sequence with all available controls before
 340             // calling into ImplCreateComponentSequence
 341
 342         aControlComponents.realloc( 0 );
 343
 344         ImplCreateComponentSequence( aControls, aThisGroupModels, aControlComponents, NULL, sal_True );
 345         xVclContainerPeer->setGroup( aControlComponents );
 346     }
 347 }
 348
 349 void StdTabController::activateFirst(  ) throw(RuntimeException)
 350 {
 351     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 352
 353     ImplActivateControl( sal_True );
 354 }
 355
 356 void StdTabController::activateLast(  ) throw(RuntimeException)
 357 {
 358     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 359
 360     ImplActivateControl( sal_False );
 361 }
 362
 363
 364 Reference< XControl >  StdTabController::FindControl( Sequence< Reference< XControl > >& rCtrls,
 365  const Reference< XControlModel > & rxCtrlModel )
 366 {
 367     DBG_ASSERT( rxCtrlModel.is(), "ImplFindControl - welches ?!" );
 368
 369     const Reference< XControl > * pCtrls = rCtrls.getConstArray();
 370     sal_Int32 nCtrls = rCtrls.getLength();
 371     for ( sal_Int32 n = 0; n < nCtrls; n++ )
 372     {
 373         Reference< XControlModel >  xModel(pCtrls[n].is() ? pCtrls[n]->getModel() : Reference< XControlModel > ());
 374         if ( (XControlModel*)xModel.get() == (XControlModel*)rxCtrlModel.get() )
 375         {
 376             Reference< XControl >  xCtrl( pCtrls[n] );
 377             ::comphelper::removeElementAt( rCtrls, n );
 378             return xCtrl;
 379         }
 380     }
 381     return Reference< XControl > ();
 382 }
 383
 384 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */