svx/source/form/fmmodel.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: fmmodel.cxx,v $
  10  * $Revision: 1.18 $
  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_svx.hxx"
  33 #include <tools/debug.hxx>
  34
  35 #ifndef SVX_LIGHT
  36 #ifndef _SFX_OBJSH_HXX //autogen
  37 #include <sfx2/objsh.hxx>
  38 #endif
  39 #else
  40 class SfxObjectShell;
  41 #endif
  42
  43 #ifndef _FM_FMMODEL_HXX
  44 #include <svx/fmmodel.hxx>
  45 #endif
  46
  47 #ifndef _FM_PAGE_HXX
  48 #include <svx/fmpage.hxx>
  49 #endif
  50 #include "fmundo.hxx"
  51 #ifndef _SVX_SVDOBJ_HXX
  52 #include <svx/svdobj.hxx>
  53 #endif
  54
  55 using ::com::sun::star::uno::Reference;
  56 using ::com::sun::star::container::XNameContainer;
  57
  58 TYPEINIT1(FmFormModel, SdrModel);
  59
  60 struct FmFormModelImplData
  61 {
  62     FmXUndoEnvironment*         pUndoEnv;
  63     sal_Bool                            bOpenInDesignIsDefaulted;
  64     sal_Bool                            bMovingPage;
  65
  66     FmFormModelImplData()
  67         :pUndoEnv( NULL )
  68         ,bOpenInDesignIsDefaulted( sal_True )
  69         ,bMovingPage( sal_False )
  70     {
  71     }
  72 };
  73
  74 /*************************************************************************
  75 |*
  76 |* Ctor
  77 |*
  78 \************************************************************************/
  79 FmFormModel::FmFormModel(SfxItemPool* pPool, SfxObjectShell* pPers)
  80             :SdrModel(pPool, pPers, LOADREFCOUNTS)
  81             ,m_pImpl(NULL)
  82             ,m_pObjShell(0)
  83             ,m_bOpenInDesignMode(sal_False)
  84             ,m_bAutoControlFocus(sal_False)
  85 {
  86 #ifndef SVX_LIGHT
  87     m_pImpl = new FmFormModelImplData;
  88     m_pImpl->pUndoEnv = new FmXUndoEnvironment(*this);
  89     m_pImpl->pUndoEnv->acquire();
  90 #endif
  91 }
  92
  93 /*************************************************************************
  94 |*
  95 |* Ctor
  96 |*
  97 \************************************************************************/
  98 FmFormModel::FmFormModel(const XubString& rPath, SfxItemPool* pPool, SfxObjectShell* pPers)
  99             :SdrModel(rPath, pPool, pPers)
 100             ,m_pImpl(NULL)
 101             ,m_pObjShell(0)
 102             ,m_bOpenInDesignMode(sal_False)
 103             ,m_bAutoControlFocus(sal_False)
 104 {
 105 #ifndef SVX_LIGHT
 106     m_pImpl = new FmFormModelImplData;
 107     m_pImpl->pUndoEnv = new FmXUndoEnvironment(*this);
 108     m_pImpl->pUndoEnv->acquire();
 109 #endif
 110 }
 111
 112 /*************************************************************************
 113 |*
 114 |* Ctor
 115 |*
 116 \************************************************************************/
 117 FmFormModel::FmFormModel(SfxItemPool* pPool, SfxObjectShell* pPers,
 118                          FASTBOOL bUseExtColorTable
 119                          )
 120             :SdrModel(pPool, pPers, bUseExtColorTable, LOADREFCOUNTS)
 121             ,m_pImpl(NULL)
 122             ,m_pObjShell(0)
 123             ,m_bOpenInDesignMode(sal_False)
 124             ,m_bAutoControlFocus(sal_False)
 125 {
 126 #ifndef SVX_LIGHT
 127     m_pImpl = new FmFormModelImplData;
 128     m_pImpl->pUndoEnv = new FmXUndoEnvironment(*this);
 129     m_pImpl->pUndoEnv->acquire();
 130 #endif
 131 }
 132
 133 /*************************************************************************
 134 |*
 135 |* Ctor
 136 |*
 137 \************************************************************************/
 138 FmFormModel::FmFormModel(const XubString& rPath, SfxItemPool* pPool, SfxObjectShell* pPers,
 139                          FASTBOOL bUseExtColorTable)
 140             :SdrModel(rPath, pPool, pPers, bUseExtColorTable, LOADREFCOUNTS)
 141             ,m_pImpl( NULL )
 142             ,m_pObjShell(0)
 143             ,m_bOpenInDesignMode(sal_False)
 144             ,m_bAutoControlFocus(sal_False)
 145 {
 146 #ifndef SVX_LIGHT
 147     m_pImpl = new FmFormModelImplData;
 148     m_pImpl->pUndoEnv = new FmXUndoEnvironment(*this);
 149     m_pImpl->pUndoEnv->acquire();
 150 #endif
 151 }
 152
 153 /*************************************************************************
 154 |*
 155 |* Dtor
 156 |*
 157 \************************************************************************/
 158 FmFormModel::~FmFormModel()
 159 {
 160 #ifndef SVX_LIGHT
 161     if (m_pObjShell && m_pImpl->pUndoEnv->IsListening(*m_pObjShell))
 162         SetObjectShell(NULL);
 163
 164     ClearUndoBuffer();
 165     // minimale grenze fuer undos
 166     SetMaxUndoActionCount(1);
 167
 168     m_pImpl->pUndoEnv->release();
 169     delete m_pImpl;
 170
 171 #endif
 172 }
 173
 174 /*************************************************************************
 175 |*
 176 |* Erzeugt eine neue Seite
 177 |*
 178 \************************************************************************/
 179 SdrPage* FmFormModel::AllocPage(FASTBOOL bMasterPage)
 180 {
 181     return new FmFormPage(*this, NULL, bMasterPage);
 182 }
 183
 184 /*************************************************************************
 185 |*
 186 |* InsertPage
 187 |*
 188 \************************************************************************/
 189 void FmFormModel::InsertPage(SdrPage* pPage, sal_uInt16 nPos)
 190 {
 191 #ifndef SVX_LIGHT
 192     // hack solange Methode intern
 193     if (m_pObjShell && !m_pImpl->pUndoEnv->IsListening( *m_pObjShell ))
 194         SetObjectShell(m_pObjShell);
 195 #endif
 196
 197     SdrModel::InsertPage( pPage, nPos );
 198 }
 199
 200 /*************************************************************************
 201 |*
 202 |* MovePage
 203 |*
 204 \************************************************************************/
 205 void FmFormModel::MovePage( USHORT nPgNum, USHORT nNewPos )
 206 {
 207 #ifndef SVX_LIGHT
 208     m_pImpl->bMovingPage = sal_True;
 209         // see InsertPage for this
 210 #endif
 211
 212     SdrModel::MovePage( nPgNum, nNewPos );
 213
 214 #ifndef SVX_LIGHT
 215     m_pImpl->bMovingPage = sal_False;
 216 #endif
 217 }
 218
 219 /*************************************************************************
 220 |*
 221 |* RemovePage
 222 |*
 223 \************************************************************************/
 224 SdrPage* FmFormModel::RemovePage(sal_uInt16 nPgNum)
 225 {
 226     FmFormPage* pToBeRemovedPage = dynamic_cast< FmFormPage* >( GetPage( nPgNum ) );
 227     OSL_ENSURE( pToBeRemovedPage, "FmFormModel::RemovePage: *which page*?" );
 228
 229 #ifndef SVX_LIGHT
 230     if ( pToBeRemovedPage )
 231     {
 232         Reference< XNameContainer > xForms( pToBeRemovedPage->GetForms( false ) );
 233         if ( xForms.is() )
 234             m_pImpl->pUndoEnv->RemoveForms( xForms );
 235     }
 236 #endif
 237
 238     FmFormPage* pRemovedPage = (FmFormPage*)SdrModel::RemovePage(nPgNum);
 239     OSL_ENSURE( pRemovedPage == pToBeRemovedPage, "FmFormModel::RemovePage: inconsistency!" );
 240     return pRemovedPage;
 241 }
 242
 243 /*************************************************************************
 244 |*
 245 |* InsertMasterPage
 246 |*
 247 \************************************************************************/
 248 void FmFormModel::InsertMasterPage(SdrPage* pPage, sal_uInt16 nPos)
 249 {
 250 #ifndef SVX_LIGHT
 251     // hack solange Methode intern
 252     if (m_pObjShell && !m_pImpl->pUndoEnv->IsListening( *m_pObjShell ))
 253         SetObjectShell(m_pObjShell);
 254 #endif
 255
 256     SdrModel::InsertMasterPage(pPage, nPos);
 257 }
 258
 259 /*************************************************************************
 260 |*
 261 |* RemoveMasterPage
 262 |*
 263 \************************************************************************/
 264 SdrPage* FmFormModel::RemoveMasterPage(sal_uInt16 nPgNum)
 265 {
 266     FmFormPage* pPage = (FmFormPage*)SdrModel::RemoveMasterPage(nPgNum);
 267
 268 #ifndef SVX_LIGHT
 269     if ( pPage )
 270     {
 271         Reference< XNameContainer > xForms( pPage->GetForms( false ) );
 272         if ( xForms.is() )
 273             m_pImpl->pUndoEnv->RemoveForms( xForms );
 274     }
 275 #endif
 276
 277     return pPage;
 278 }
 279
 280 //------------------------------------------------------------------------
 281 SdrLayerID FmFormModel::GetControlExportLayerId( const SdrObject& rObj ) const
 282 {
 283     return rObj.GetLayer();
 284 }
 285
 286 //------------------------------------------------------------------------
 287 void FmFormModel::implSetOpenInDesignMode( sal_Bool _bOpenDesignMode, sal_Bool _bForce )
 288 {
 289     if( ( _bOpenDesignMode != m_bOpenInDesignMode ) || _bForce )
 290     {
 291         m_bOpenInDesignMode = _bOpenDesignMode;
 292
 293         if ( m_pObjShell )
 294             m_pObjShell->SetModified( sal_True );
 295     }
 296     // no matter if we really did it or not - from now on, it does not count as defaulted anymore
 297     m_pImpl->bOpenInDesignIsDefaulted = sal_False;
 298 }
 299
 300 //------------------------------------------------------------------------
 301 void FmFormModel::SetOpenInDesignMode( sal_Bool bOpenDesignMode )
 302 {
 303 #ifndef SVX_LIGHT
 304     implSetOpenInDesignMode( bOpenDesignMode, sal_False );
 305 #endif
 306 }
 307
 308 #ifndef SVX_LIGHT
 309 //------------------------------------------------------------------------
 310 sal_Bool FmFormModel::OpenInDesignModeIsDefaulted( )
 311 {
 312     return m_pImpl->bOpenInDesignIsDefaulted;
 313 }
 314 #endif
 315
 316 //------------------------------------------------------------------------
 317 void FmFormModel::SetAutoControlFocus( sal_Bool _bAutoControlFocus )
 318 {
 319 #ifndef SVX_LIGHT
 320     if( _bAutoControlFocus != m_bAutoControlFocus )
 321     {
 322         m_bAutoControlFocus = _bAutoControlFocus;
 323         m_pObjShell->SetModified( sal_True );
 324     }
 325 #endif
 326 }
 327
 328 //------------------------------------------------------------------------
 329 void FmFormModel::SetObjectShell( SfxObjectShell* pShell )
 330 {
 331 #ifndef SVX_LIGHT
 332     if (pShell == m_pObjShell)
 333         return;
 334
 335     if (m_pObjShell)
 336     {
 337         m_pImpl->pUndoEnv->EndListening( *this );
 338         m_pImpl->pUndoEnv->EndListening( *m_pObjShell );
 339     }
 340
 341     m_pObjShell = pShell;
 342
 343     if (m_pObjShell)
 344     {
 345         m_pImpl->pUndoEnv->SetReadOnly( m_pObjShell->IsReadOnly() || m_pObjShell->IsReadOnlyUI(), FmXUndoEnvironment::Accessor() );
 346
 347         if (!m_pImpl->pUndoEnv->IsReadOnly())
 348              m_pImpl->pUndoEnv->StartListening(*this);
 349
 350         m_pImpl->pUndoEnv->StartListening( *m_pObjShell );
 351     }
 352 #endif
 353 }
 354
 355 //------------------------------------------------------------------------
 356 FmXUndoEnvironment&     FmFormModel::GetUndoEnv()
 357 {
 358     return *m_pImpl->pUndoEnv;
 359 }