svtools/source/notify/lstner.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: lstner.cxx,v $
  10  * $Revision: 1.8.60.1 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_svtools.hxx"
  33 #ifndef GCC
  34 #endif
  35
  36 #ifndef DEBUG_HXX
  37 #include <tools/debug.hxx>
  38 #endif
  39
  40 #include <svtools/hint.hxx>
  41 #include <svtools/brdcst.hxx>
  42
  43 SV_DECL_PTRARR( SfxBroadcasterArr_Impl, SfxBroadcaster*, 0, 2 )
  44
  45 #define _SFX_LSTNER_CXX
  46 #include <svtools/lstner.hxx>
  47
  48 //====================================================================
  49 DBG_NAME(SfxListener)
  50 TYPEINIT0(SfxListener);
  51
  52 //====================================================================
  53 // simple ctor of class SfxListener
  54
  55 SfxListener::SfxListener()
  56 {
  57     DBG_CTOR(SfxListener, 0);
  58 }
  59 //--------------------------------------------------------------------
  60
  61 // copy ctor of class SfxListener
  62
  63 SfxListener::SfxListener( const SfxListener &rListener )
  64 {
  65     DBG_CTOR(SfxListener, 0);
  66
  67     for ( USHORT n = 0; n < rListener.aBCs.Count(); ++n )
  68         StartListening( *rListener.aBCs[n] );
  69 }
  70 //--------------------------------------------------------------------
  71
  72 // unregisteres the SfxListener from its SfxBroadcasters
  73
  74 SfxListener::~SfxListener()
  75 {
  76     DBG_DTOR(SfxListener, 0);
  77
  78     // unregister at all remainding broadcasters
  79     for ( USHORT nPos = 0; nPos < aBCs.Count(); ++nPos )
  80     {
  81         SfxBroadcaster *pBC = aBCs[nPos];
  82         pBC->RemoveListener(*this);
  83     }
  84 }
  85
  86 //--------------------------------------------------------------------
  87
  88 // unregisteres at a specific SfxBroadcaster
  89
  90 void SfxListener::RemoveBroadcaster_Impl( SfxBroadcaster& rBC )
  91 {
  92     DBG_CHKTHIS(SfxListener, 0);
  93
  94     const SfxBroadcaster *pBC = &rBC;
  95     aBCs.Remove( aBCs.GetPos(pBC), 1 );
  96 }
  97
  98 //--------------------------------------------------------------------
  99
 100 // registeres at a specific SfxBroadcaster
 101
 102 BOOL SfxListener::StartListening( SfxBroadcaster& rBroadcaster, BOOL bPreventDups )
 103 {
 104     DBG_CHKTHIS(SfxListener, 0);
 105
 106     if ( !bPreventDups || !IsListening( rBroadcaster ) )
 107     {
 108         if ( rBroadcaster.AddListener(*this) )
 109         {
 110             const SfxBroadcaster *pBC = &rBroadcaster;
 111             aBCs.Insert( pBC, aBCs.Count() );
 112
 113             DBG_ASSERT( IsListening(rBroadcaster), "StartListening failed" );
 114             return TRUE;
 115         }
 116
 117     }
 118     return FALSE;
 119 }
 120
 121 //--------------------------------------------------------------------
 122
 123 // unregisteres at a specific SfxBroadcaster
 124
 125 BOOL SfxListener::EndListening( SfxBroadcaster& rBroadcaster, BOOL bAllDups )
 126 {
 127     DBG_CHKTHIS(SfxListener, 0);
 128
 129     if ( !IsListening( rBroadcaster ) )
 130         return FALSE;
 131
 132     do
 133     {
 134         rBroadcaster.RemoveListener(*this);
 135         const SfxBroadcaster *pBC = &rBroadcaster;
 136         aBCs.Remove( aBCs.GetPos(pBC), 1 );
 137     }
 138     while ( bAllDups && IsListening( rBroadcaster ) );
 139     return TRUE;
 140 }
 141
 142 //--------------------------------------------------------------------
 143
 144 // unregisteres at a specific SfxBroadcaster by index
 145
 146 void SfxListener::EndListening( USHORT nNo )
 147 {
 148     DBG_CHKTHIS(SfxListener, 0);
 149
 150     SfxBroadcaster *pBC = aBCs.GetObject(nNo);
 151     pBC->RemoveListener(*this);
 152     aBCs.Remove( nNo, 1 );
 153 }
 154
 155 //--------------------------------------------------------------------
 156
 157 // unregisteres all Broadcasters
 158
 159 void SfxListener::EndListeningAll()
 160 {
 161     DBG_CHKTHIS(SfxListener, 0);
 162
 163     // MI: bei Optimierung beachten: Seiteneffekte von RemoveListener beachten!
 164     while ( aBCs.Count() )
 165     {
 166         SfxBroadcaster *pBC = aBCs.GetObject(0);
 167         pBC->RemoveListener(*this);
 168         aBCs.Remove( 0, 1 );
 169     }
 170 }
 171
 172 //--------------------------------------------------------------------
 173
 174 BOOL SfxListener::IsListening( SfxBroadcaster& rBroadcaster ) const
 175 {
 176     const SfxBroadcaster *pBC = &rBroadcaster;
 177     return USHRT_MAX != aBCs.GetPos( pBC );
 178 }
 179
 180 //--------------------------------------------------------------------
 181
 182 // base implementation of notification handler
 183
 184 #ifdef DBG_UTIL
 185 void SfxListener::Notify( SfxBroadcaster& rBC, const SfxHint& )
 186 #else
 187 void SfxListener::Notify( SfxBroadcaster&, const SfxHint& )
 188 #endif
 189 {
 190     #ifdef DBG_UTIL
 191     const SfxBroadcaster *pBC = &rBC;
 192     DBG_ASSERT( USHRT_MAX != aBCs.GetPos(pBC),
 193                 "notification from unregistered broadcaster" );
 194     #endif
 195 }
 196