svx/source/form/fmmodel.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
  21 #include <fmundo.hxx>
  22 #include <fmdocumentclassification.hxx>
  23 #include <fmcontrollayout.hxx>
  24
  25 #include <com/sun/star/form/XForms.hpp>
  26 #include <svx/fmmodel.hxx>
  27 #include <svx/fmpage.hxx>
  28
  29 #include <sfx2/objsh.hxx>
  30 #include <osl/diagnose.h>
  31
  32 #include <optional>
  33
  34 using ::com::sun::star::uno::Reference;
  35 using ::com::sun::star::container::XNameContainer;
  36 using namespace svxform;
  37
  38
  39 struct FmFormModelImplData
  40 {
  41     rtl::Reference<FmXUndoEnvironment>  mxUndoEnv;
  42     bool                bOpenInDesignIsDefaulted;
  43     std::optional<bool> aControlsUseRefDevice;
  44
  45     FmFormModelImplData()
  46         :bOpenInDesignIsDefaulted( true )
  47     {
  48     }
  49 };
  50
  51 FmFormModel::FmFormModel(
  52     SfxItemPool* pPool,
  53     SfxObjectShell* pPers)
  54 :   SdrModel(
  55         pPool,
  56         pPers)
  57     , m_pObjShell(nullptr)
  58     , m_bOpenInDesignMode(false)
  59     , m_bAutoControlFocus(false)
  60 {
  61     m_pImpl.reset( new FmFormModelImplData );
  62     m_pImpl->mxUndoEnv = new FmXUndoEnvironment(*this);
  63 }
  64
  65 FmFormModel::~FmFormModel()
  66 {
  67     if (m_pObjShell && m_pImpl->mxUndoEnv->IsListening(*m_pObjShell))
  68         SetObjectShell(nullptr);
  69
  70     ClearUndoBuffer();
  71     // minimum limit for undos
  72     SetMaxUndoActionCount(1);
  73 }
  74
  75 rtl::Reference<SdrPage> FmFormModel::AllocPage(bool bMasterPage)
  76 {
  77     return new FmFormPage(*this, bMasterPage);
  78 }
  79
  80 void FmFormModel::InsertPage(SdrPage* pPage, sal_uInt16 nPos)
  81 {
  82     // hack for as long as the method is internal
  83     if (m_pObjShell && !m_pImpl->mxUndoEnv->IsListening( *m_pObjShell ))
  84         SetObjectShell(m_pObjShell);
  85
  86     SdrModel::InsertPage( pPage, nPos );
  87 }
  88
  89 rtl::Reference<SdrPage> FmFormModel::RemovePage(sal_uInt16 nPgNum)
  90 {
  91     FmFormPage* pToBeRemovedPage = dynamic_cast< FmFormPage* >( GetPage( nPgNum ) );
  92     OSL_ENSURE( pToBeRemovedPage, "FmFormModel::RemovePage: *which page*?" );
  93
  94     if ( pToBeRemovedPage )
  95     {
  96         Reference< XNameContainer > xForms( pToBeRemovedPage->GetForms( false ) );
  97         if ( xForms.is() )
  98             m_pImpl->mxUndoEnv->RemoveForms( xForms );
  99     }
 100
 101     rtl::Reference<FmFormPage> pRemovedPage = static_cast<FmFormPage*>(SdrModel::RemovePage(nPgNum).get());
 102     OSL_ENSURE( pRemovedPage == pToBeRemovedPage, "FmFormModel::RemovePage: inconsistency!" );
 103     return pRemovedPage;
 104 }
 105
 106 void FmFormModel::InsertMasterPage(SdrPage* pPage, sal_uInt16 nPos)
 107 {
 108     // hack for as long as the method is internal
 109     if (m_pObjShell && !m_pImpl->mxUndoEnv->IsListening( *m_pObjShell ))
 110         SetObjectShell(m_pObjShell);
 111
 112     SdrModel::InsertMasterPage(pPage, nPos);
 113 }
 114
 115 rtl::Reference<SdrPage> FmFormModel::RemoveMasterPage(sal_uInt16 nPgNum)
 116 {
 117     rtl::Reference<FmFormPage> pPage = static_cast<FmFormPage*>(SdrModel::RemoveMasterPage(nPgNum).get());
 118
 119     if ( pPage )
 120     {
 121         Reference< XNameContainer > xForms( pPage->GetForms( false ) );
 122         if ( xForms.is() )
 123             m_pImpl->mxUndoEnv->RemoveForms( xForms );
 124     }
 125
 126     return pPage;
 127 }
 128
 129
 130 void FmFormModel::implSetOpenInDesignMode( bool _bOpenDesignMode )
 131 {
 132     if( _bOpenDesignMode != m_bOpenInDesignMode )
 133     {
 134         m_bOpenInDesignMode = _bOpenDesignMode;
 135
 136         if ( m_pObjShell )
 137             m_pObjShell->SetModified();
 138     }
 139     // no matter if we really did it or not - from now on, it does not count as defaulted anymore
 140     m_pImpl->bOpenInDesignIsDefaulted = false;
 141 }
 142
 143
 144 void FmFormModel::SetOpenInDesignMode( bool bOpenDesignMode )
 145 {
 146     implSetOpenInDesignMode( bOpenDesignMode );
 147 }
 148
 149
 150 bool FmFormModel::OpenInDesignModeIsDefaulted( )
 151 {
 152     return m_pImpl->bOpenInDesignIsDefaulted;
 153 }
 154
 155
 156 bool FmFormModel::ControlsUseRefDevice() const
 157 {
 158     if ( !m_pImpl->aControlsUseRefDevice )
 159     {
 160         DocumentType eDocType = eUnknownDocumentType;
 161         if ( m_pObjShell )
 162             eDocType = DocumentClassification::classifyHostDocument( m_pObjShell->GetModel() );
 163         m_pImpl->aControlsUseRefDevice = ControlLayouter::useDocumentReferenceDevice(eDocType);
 164     }
 165     return *m_pImpl->aControlsUseRefDevice;
 166 }
 167
 168
 169 void FmFormModel::SetAutoControlFocus( bool _bAutoControlFocus )
 170 {
 171     if( _bAutoControlFocus != m_bAutoControlFocus )
 172     {
 173         m_bAutoControlFocus = _bAutoControlFocus;
 174         m_pObjShell->SetModified();
 175     }
 176 }
 177
 178
 179 void FmFormModel::SetObjectShell( SfxObjectShell* pShell )
 180 {
 181     if (pShell == m_pObjShell)
 182         return;
 183
 184     if (m_pObjShell)
 185     {
 186         m_pImpl->mxUndoEnv->EndListening( *this );
 187         m_pImpl->mxUndoEnv->EndListening( *m_pObjShell );
 188     }
 189
 190     m_pObjShell = pShell;
 191
 192     if (m_pObjShell)
 193     {
 194         m_pImpl->mxUndoEnv->SetReadOnly( m_pObjShell->IsReadOnly() || m_pObjShell->IsReadOnlyUI(), FmXUndoEnvironment::Accessor() );
 195
 196         if (!m_pImpl->mxUndoEnv->IsReadOnly())
 197              m_pImpl->mxUndoEnv->StartListening(*this);
 198
 199         m_pImpl->mxUndoEnv->StartListening( *m_pObjShell );
 200     }
 201 }
 202
 203
 204 FmXUndoEnvironment& FmFormModel::GetUndoEnv()
 205 {
 206     return *m_pImpl->mxUndoEnv;
 207 }
 208
 209 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */