UnoControls/source/base/basecontainercontrol.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 <basecontainercontrol.hxx>
  21
  22 #include <cppuhelper/queryinterface.hxx>
  23 #include <cppuhelper/typeprovider.hxx>
  24
  25 #include <com/sun/star/container/ContainerEvent.hpp>
  26 #include <com/sun/star/container/XContainerListener.hpp>
  27 #include <com/sun/star/awt/XControlContainer.hpp>
  28
  29 //  namespaces
  30
  31 using namespace ::cppu;
  32 using namespace ::osl;
  33 using namespace ::com::sun::star::uno;
  34 using namespace ::com::sun::star::lang;
  35 using namespace ::com::sun::star::awt;
  36 using namespace ::com::sun::star::container;
  37
  38 namespace unocontrols {
  39
  40 //  construct/destruct
  41
  42 BaseContainerControl::BaseContainerControl( const Reference< XComponentContext >& rxContext )
  43     : BaseContainerControl_BASE(rxContext)
  44     , m_aListeners  ( m_aMutex  )
  45 {
  46 }
  47
  48 BaseContainerControl::~BaseContainerControl()
  49 {
  50 }
  51
  52 //  XControl
  53
  54 void SAL_CALL BaseContainerControl::createPeer( const   Reference< XToolkit >&      xToolkit    ,
  55                                                 const   Reference< XWindowPeer >&   xParent     )
  56 {
  57     if ( getPeer().is() )
  58         return;
  59
  60     // create own peer
  61     BaseControl::createPeer( xToolkit, xParent );
  62
  63     // create peers at all children
  64     Sequence< Reference< XControl > >   seqControlList  = getControls();
  65
  66     for ( auto& rxControl : asNonConstRange(seqControlList) )
  67     {
  68         rxControl->createPeer( xToolkit, getPeer() );
  69     }
  70 }
  71
  72 //  XControl
  73
  74 sal_Bool SAL_CALL BaseContainerControl::setModel( const Reference< XControlModel >& )
  75 {
  76     // This object has NO model.
  77     return false;
  78 }
  79
  80 //  XControl
  81
  82 Reference< XControlModel > SAL_CALL BaseContainerControl::getModel()
  83 {
  84     // This object has NO model.
  85     // return (XControlModel*)this;
  86     return Reference< XControlModel >();
  87 }
  88
  89 //  XComponent
  90
  91 void SAL_CALL BaseContainerControl::dispose()
  92 {
  93     // Tell everything that this container is now gone.
  94     // It's faster if you listen to both the control and the container.
  95
  96     // Ready for multithreading
  97     MutexGuard aGuard( m_aMutex );
  98
  99     // remove listeners
 100     EventObject aObject;
 101
 102     aObject.Source.set( static_cast<XControlContainer*>(this), UNO_QUERY );
 103     m_aListeners.disposeAndClear( aObject );
 104
 105     // remove controls
 106     const Sequence< Reference< XControl > >   seqCtrls    =   getControls();
 107
 108     maControlInfoList.clear();
 109
 110     for ( Reference< XControl > const & control : seqCtrls )
 111     {
 112         control->removeEventListener    ( static_cast< XEventListener* >( static_cast< XWindowListener* >( this ) ) );
 113         control->dispose                (       );
 114     }
 115
 116     // call baseclass
 117     BaseControl::dispose();
 118 }
 119
 120 //  XEventListener
 121
 122 void SAL_CALL BaseContainerControl::disposing( const EventObject& rEvent )
 123 {
 124     Reference< XControl > xControl( rEvent.Source, UNO_QUERY );
 125
 126     // "removeControl" remove only, when control is an active control
 127     removeControl( xControl );
 128 }
 129
 130 //  XControlContainer
 131
 132 void SAL_CALL BaseContainerControl::addControl ( const OUString& rName, const Reference< XControl > & rControl )
 133 {
 134     if ( !rControl.is () )
 135         return;
 136
 137     // take memory for new item
 138     IMPL_ControlInfo aNewControl;
 139
 140     // Ready for multithreading
 141     MutexGuard aGuard (m_aMutex);
 142
 143     // set control
 144     aNewControl.sName      = rName;
 145     aNewControl.xControl   = rControl;
 146
 147     // and insert in list
 148     maControlInfoList.emplace_back( aNewControl );
 149
 150     // initialize new control
 151     aNewControl.xControl->setContext       (getXWeak());
 152     aNewControl.xControl->addEventListener ( static_cast< XEventListener* >( static_cast< XWindowListener* >( this ) ) );
 153
 154     // when container has a peer...
 155     if (getPeer().is())
 156     {
 157         // ... then create a peer on child
 158         aNewControl.xControl->createPeer ( getPeer()->getToolkit(), getPeer() );
 159     }
 160
 161     // Send message to all listener
 162     comphelper::OInterfaceContainerHelper2* pInterfaceContainer = m_aListeners.getContainer( cppu::UnoType<XContainerListener>::get());
 163
 164     if (!pInterfaceContainer)
 165         return;
 166
 167     // Build event
 168     ContainerEvent  aEvent;
 169
 170     aEvent.Source   = *this;
 171     aEvent.Element <<= rControl;
 172
 173     // Get all listener
 174     comphelper::OInterfaceIteratorHelper2  aIterator (*pInterfaceContainer);
 175
 176     // Send event
 177     while ( aIterator.hasMoreElements() )
 178     {
 179         static_cast<XContainerListener*>(aIterator.next())->elementInserted (aEvent);
 180     }
 181 }
 182
 183 //  XControlContainer
 184
 185 void SAL_CALL BaseContainerControl::removeControl ( const Reference< XControl > & rControl )
 186 {
 187     if ( !rControl.is() )
 188         return;
 189
 190     // Ready for multithreading
 191     MutexGuard aGuard (m_aMutex);
 192
 193     size_t nControls = maControlInfoList.size();
 194
 195     for ( size_t n = 0; n < nControls; n++ )
 196     {
 197         // Search for right control
 198         IMPL_ControlInfo* pControl = &maControlInfoList[ n ];
 199         if ( rControl == pControl->xControl )
 200         {
 201             //.is it found ... remove listener from control
 202             pControl->xControl->removeEventListener (static_cast< XEventListener* >( static_cast< XWindowListener* >( this ) ));
 203             pControl->xControl->setContext          ( Reference< XInterface >  ()   );
 204
 205             // ... free memory
 206             maControlInfoList.erase(maControlInfoList.begin() + n);
 207
 208             // Send message to all other listener
 209             comphelper::OInterfaceContainerHelper2 * pInterfaceContainer = m_aListeners.getContainer( cppu::UnoType<XContainerListener>::get());
 210
 211             if (pInterfaceContainer)
 212             {
 213                 ContainerEvent  aEvent;
 214
 215                 aEvent.Source    = *this;
 216                 aEvent.Element <<= rControl;
 217
 218                 comphelper::OInterfaceIteratorHelper2 aIterator (*pInterfaceContainer);
 219
 220                 while ( aIterator.hasMoreElements() )
 221                 {
 222                     static_cast<XContainerListener*>(aIterator.next())->elementRemoved (aEvent);
 223                 }
 224             }
 225             // Break "for" !
 226             break;
 227         }
 228     }
 229 }
 230
 231 //  XControlContainer
 232
 233 void SAL_CALL BaseContainerControl::setStatusText ( const OUString& rStatusText )
 234 {
 235     // go down to each parent
 236     Reference< XControlContainer >  xContainer ( getContext(), UNO_QUERY );
 237
 238     if ( xContainer.is () )
 239     {
 240         xContainer->setStatusText ( rStatusText );
 241     }
 242 }
 243
 244 //  XControlContainer
 245
 246 Reference< XControl > SAL_CALL BaseContainerControl::getControl ( const OUString& rName )
 247 {
 248     // Ready for multithreading
 249     MutexGuard  aGuard ( Mutex::getGlobalMutex() );
 250
 251     // Search for right control
 252     for( const IMPL_ControlInfo& rSearchControl : maControlInfoList )
 253     {
 254         if ( rSearchControl.sName == rName )
 255         {
 256             // We have found it ...
 257             // Break operation and return.
 258             return rSearchControl.xControl;
 259         }
 260     }
 261
 262     // We have not found it ... return NULL.
 263     return Reference< XControl >  ();
 264 }
 265
 266 //  XControlContainer
 267
 268 Sequence< Reference< XControl > > SAL_CALL BaseContainerControl::getControls ()
 269 {
 270     // Ready for multithreading
 271     MutexGuard  aGuard ( Mutex::getGlobalMutex() );
 272
 273     size_t                              nControls       = maControlInfoList.size();
 274     size_t                              nCount          = 0;
 275     Sequence< Reference< XControl > >   aDescriptor     ( nControls );
 276     Reference< XControl > *             pDestination    = aDescriptor.getArray ();
 277
 278     // Copy controls to sequence
 279     for( const IMPL_ControlInfo& rCopyControl : maControlInfoList )
 280     {
 281         pDestination [ nCount++ ] = rCopyControl.xControl;
 282     }
 283
 284     // Return sequence
 285     return aDescriptor;
 286 }
 287
 288 //  XWindow
 289
 290 void SAL_CALL BaseContainerControl::setVisible ( sal_Bool bVisible )
 291 {
 292     // override baseclass definition
 293     BaseControl::setVisible ( bVisible );
 294
 295     // is it a top window ?
 296     if ( !getContext().is() && bVisible )
 297     {
 298         // then show it automatically
 299         createPeer ( Reference< XToolkit > (), Reference< XWindowPeer > () );
 300     }
 301 }
 302
 303 //  protected method
 304
 305 WindowDescriptor BaseContainerControl::impl_getWindowDescriptor ( const Reference< XWindowPeer > & rParentPeer )
 306 {
 307     WindowDescriptor aDescriptor;
 308
 309     aDescriptor.Type               = WindowClass_CONTAINER;
 310     aDescriptor.WindowServiceName  = "window";
 311     aDescriptor.ParentIndex        = -1;
 312     aDescriptor.Parent             = rParentPeer;
 313     aDescriptor.Bounds             = getPosSize ();
 314     aDescriptor.WindowAttributes   = 0;
 315
 316     return aDescriptor;
 317 }
 318
 319 //  protected method
 320
 321 void BaseContainerControl::impl_paint ( sal_Int32 /*nX*/, sal_Int32 /*nY*/, const Reference< XGraphics > & /*rGraphics*/ )
 322 {
 323 }
 324
 325 } // namespace unocontrols
 326
 327 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */