svx/source/form/fmexpl.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 <svx/strings.hrc>
  22 #include <fmexpl.hxx>
  23
  24 #include <helpids.h>
  25 #include <svx/svdobjkind.hxx>
  26 #include <svx/fmtools.hxx>
  27 #include <fmexch.hxx>
  28
  29 #include <svx/svxids.hrc>
  30
  31 #include <fmprop.hxx>
  32 #include <bitmaps.hlst>
  33 #include <svx/dialmgr.hxx>
  34 #include <com/sun/star/beans/XPropertySet.hpp>
  35 #include <com/sun/star/lang/XServiceInfo.hpp>
  36 #include <sfx2/objitem.hxx>
  37
  38 #include <svx/fmshell.hxx>
  39 #include <comphelper/types.hxx>
  40 #include <utility>
  41
  42 using namespace ::svxform;
  43 using namespace ::com::sun::star::uno;
  44 using namespace ::com::sun::star::form;
  45 using namespace ::com::sun::star::beans;
  46 using namespace ::com::sun::star::lang;
  47 using namespace ::com::sun::star::container;
  48
  49 FmNavInsertedHint::FmNavInsertedHint( FmEntryData* pInsertedEntryData, sal_uInt32 nRelPos )
  50     :SfxHint(SfxHintId::FmNavInserted)
  51     ,pEntryData( pInsertedEntryData )
  52     ,nPos( nRelPos )
  53
  54 {
  55 }
  56
  57
  58 FmNavInsertedHint::~FmNavInsertedHint()
  59 {
  60 }
  61
  62
  63
  64 FmNavModelReplacedHint::FmNavModelReplacedHint( FmEntryData* pAffectedEntryData )
  65     :SfxHint(SfxHintId::FmNavModelReplaced), pEntryData( pAffectedEntryData )
  66 {
  67 }
  68
  69
  70 FmNavModelReplacedHint::~FmNavModelReplacedHint()
  71 {
  72 }
  73
  74 FmNavRemovedHint::FmNavRemovedHint( FmEntryData* pRemovedEntryData )
  75     :SfxHint(SfxHintId::FmNavRemoved), pEntryData( pRemovedEntryData )
  76 {
  77 }
  78
  79
  80 FmNavRemovedHint::~FmNavRemovedHint()
  81 {
  82 }
  83
  84 FmNavNameChangedHint::FmNavNameChangedHint( FmEntryData* pData, OUString _aNewName )
  85     :SfxHint(SfxHintId::FmNavNameChanged), pEntryData( pData )
  86     ,aNewName(std::move( _aNewName ))
  87 {
  88 }
  89
  90
  91 FmNavNameChangedHint::~FmNavNameChangedHint()
  92 {
  93 }
  94
  95 FmNavClearedHint::FmNavClearedHint() : SfxHint(SfxHintId::FmNavCleared)
  96 {
  97 }
  98
  99
 100 FmNavClearedHint::~FmNavClearedHint()
 101 {
 102 }
 103
 104
 105 FmEntryDataList::FmEntryDataList()
 106 {
 107 }
 108
 109
 110 FmEntryDataList::~FmEntryDataList()
 111 {
 112 }
 113
 114
 115 void FmEntryDataList::removeNoDelete( FmEntryData* pItem )
 116 {
 117     auto it = std::find_if(maEntryDataList.begin(), maEntryDataList.end(),
 118         [&pItem](const std::unique_ptr<FmEntryData>& rEntryData) { return rEntryData.get() == pItem; });
 119     if (it != maEntryDataList.end())
 120     {
 121         // coverity[leaked_storage] - deliberately not deleted, ownership transferred
 122         it->release();
 123         maEntryDataList.erase( it );
 124         return;
 125     }
 126     assert(false);
 127 }
 128
 129
 130 void FmEntryDataList::insert( std::unique_ptr<FmEntryData> pItem, size_t Index )
 131 {
 132     if ( Index < maEntryDataList.size() )
 133     {
 134         maEntryDataList.insert( maEntryDataList.begin() + Index, std::move(pItem) );
 135     }
 136     else
 137         maEntryDataList.push_back( std::move(pItem) );
 138 }
 139
 140
 141 void FmEntryDataList::clear()
 142 {
 143     maEntryDataList.clear();
 144 }
 145
 146
 147 FmEntryData::FmEntryData( FmEntryData* pParentData, const Reference< XInterface >& _rxIFace )
 148     :pParent( pParentData )
 149 {
 150     pChildList.reset( new FmEntryDataList() );
 151
 152     newObject( _rxIFace );
 153 }
 154
 155
 156 FmEntryData::~FmEntryData()
 157 {
 158     pChildList->clear();
 159 }
 160
 161
 162 void FmEntryData::newObject( const css::uno::Reference< css::uno::XInterface >& _rxIFace )
 163 {
 164     // do not just copy, normalize it
 165     m_xNormalizedIFace.set( _rxIFace, UNO_QUERY );
 166     m_xProperties.set(m_xNormalizedIFace, css::uno::UNO_QUERY);
 167     m_xChild.set(m_xNormalizedIFace, css::uno::UNO_QUERY);
 168 }
 169
 170
 171
 172
 173
 174 bool FmEntryData::IsEqualWithoutChildren( FmEntryData* pEntryData )
 175 {
 176     if(this == pEntryData)
 177         return true;
 178
 179     if( !pEntryData )
 180         return false;
 181
 182     if( aText != pEntryData->GetText() )
 183         return false;
 184
 185     if( !pEntryData->GetParent() && pParent )
 186         return false;
 187
 188     if( pEntryData->GetParent() && !pParent )
 189         return false;
 190
 191     if( !pEntryData->GetParent() && !pParent )
 192         return true;
 193
 194     if( !pParent->IsEqualWithoutChildren(pEntryData->GetParent()) )
 195         return false;
 196
 197     return true;
 198 }
 199
 200 FmFormData::FmFormData(const Reference< XForm >& _rxForm, FmFormData* _pParent)
 201     : FmEntryData(_pParent, _rxForm)
 202     , m_xForm(_rxForm)
 203 {
 204     // set images
 205     m_aNormalImage = RID_SVXBMP_FORM;
 206
 207     // set title
 208     if (m_xForm.is())
 209     {
 210         Reference< XPropertySet >  xSet(m_xForm, UNO_QUERY);
 211         if (xSet.is())
 212         {
 213             OUString aEntryName(::comphelper::getString(xSet->getPropertyValue( FM_PROP_NAME )));
 214             SetText(aEntryName);
 215         }
 216     }
 217     else
 218         SetText( OUString() );
 219 }
 220
 221 FmFormData::~FmFormData()
 222 {
 223 }
 224
 225 bool FmFormData::IsEqualWithoutChildren( FmEntryData* pEntryData )
 226 {
 227     if(this == pEntryData)
 228         return true;
 229     FmFormData* pFormData = dynamic_cast<FmFormData*>(pEntryData);
 230     if( !pFormData )
 231         return false;
 232     if( m_xForm.get() != pFormData->GetFormIface().get() )
 233         return false;
 234
 235     return FmEntryData::IsEqualWithoutChildren( pFormData );
 236 }
 237
 238 FmControlData::FmControlData(const Reference< XFormComponent >& _rxComponent, FmFormData* _pParent)
 239 :   FmEntryData( _pParent, _rxComponent ),
 240     m_xFormComponent( _rxComponent )
 241 {
 242
 243     // set images
 244     m_aNormalImage = GetImage();
 245
 246
 247     // set title
 248     Reference< XPropertySet >  xSet(m_xFormComponent, UNO_QUERY);
 249     if( xSet.is() )
 250     {
 251         SetText( ::comphelper::getString(xSet->getPropertyValue( FM_PROP_NAME )));
 252     }
 253 }
 254
 255
 256 FmControlData::~FmControlData()
 257 {
 258 }
 259
 260
 261 OUString FmControlData::GetImage() const
 262 {
 263     // Default-Image
 264     OUString aImage(RID_SVXBMP_CONTROL);
 265
 266     Reference< XServiceInfo > xInfo( m_xFormComponent, UNO_QUERY );
 267     if (!m_xFormComponent.is())
 268         return aImage;
 269
 270
 271     // Spezielle Control-Images
 272     SdrObjKind nObjectType = getControlTypeByObject(xInfo);
 273     switch (nObjectType)
 274     {
 275     case SdrObjKind::FormButton:
 276         aImage = RID_SVXBMP_BUTTON;
 277         break;
 278
 279     case SdrObjKind::FormFixedText:
 280         aImage = RID_SVXBMP_FIXEDTEXT;
 281         break;
 282
 283     case SdrObjKind::FormEdit:
 284         aImage = RID_SVXBMP_EDITBOX;
 285         break;
 286
 287     case SdrObjKind::FormRadioButton:
 288         aImage = RID_SVXBMP_RADIOBUTTON;
 289         break;
 290
 291     case SdrObjKind::FormCheckbox:
 292         aImage = RID_SVXBMP_CHECKBOX;
 293         break;
 294
 295     case SdrObjKind::FormListbox:
 296         aImage = RID_SVXBMP_LISTBOX;
 297         break;
 298
 299     case SdrObjKind::FormCombobox:
 300         aImage = RID_SVXBMP_COMBOBOX;
 301         break;
 302
 303     case SdrObjKind::FormNavigationBar:
 304         aImage = RID_SVXBMP_NAVIGATIONBAR;
 305         break;
 306
 307     case SdrObjKind::FormGroupBox:
 308         aImage = RID_SVXBMP_GROUPBOX;
 309         break;
 310
 311     case SdrObjKind::FormImageButton:
 312         aImage = RID_SVXBMP_IMAGEBUTTON;
 313         break;
 314
 315     case SdrObjKind::FormFileControl:
 316         aImage = RID_SVXBMP_FILECONTROL;
 317         break;
 318
 319     case SdrObjKind::FormHidden:
 320         aImage = RID_SVXBMP_HIDDEN;
 321         break;
 322
 323     case SdrObjKind::FormDateField:
 324         aImage = RID_SVXBMP_DATEFIELD;
 325         break;
 326
 327     case SdrObjKind::FormTimeField:
 328         aImage = RID_SVXBMP_TIMEFIELD;
 329         break;
 330
 331     case SdrObjKind::FormNumericField:
 332         aImage = RID_SVXBMP_NUMERICFIELD;
 333         break;
 334
 335     case SdrObjKind::FormCurrencyField:
 336         aImage = RID_SVXBMP_CURRENCYFIELD;
 337         break;
 338
 339     case SdrObjKind::FormPatternField:
 340         aImage = RID_SVXBMP_PATTERNFIELD;
 341         break;
 342
 343     case SdrObjKind::FormImageControl:
 344         aImage = RID_SVXBMP_IMAGECONTROL;
 345         break;
 346
 347     case SdrObjKind::FormFormattedField:
 348         aImage = RID_SVXBMP_FORMATTEDFIELD;
 349         break;
 350
 351     case SdrObjKind::FormGrid:
 352         aImage = RID_SVXBMP_GRID;
 353         break;
 354
 355     case SdrObjKind::FormScrollbar:
 356         aImage = RID_SVXBMP_SCROLLBAR;
 357         break;
 358
 359     case SdrObjKind::FormSpinButton:
 360         aImage = RID_SVXBMP_SPINBUTTON;
 361         break;
 362
 363     default:;
 364     }
 365
 366     return aImage;
 367 }
 368
 369 bool FmControlData::IsEqualWithoutChildren( FmEntryData* pEntryData )
 370 {
 371     if(this == pEntryData)
 372         return true;
 373
 374     FmControlData* pControlData = dynamic_cast<FmControlData*>(pEntryData);
 375     if( !pControlData )
 376         return false;
 377
 378     if( m_xFormComponent.get() != pControlData->GetFormComponent().get() )
 379         return false;
 380
 381     return FmEntryData::IsEqualWithoutChildren( pControlData );
 382 }
 383
 384 void FmControlData::ModelReplaced(const Reference< XFormComponent >& _rxNew)
 385 {
 386     m_xFormComponent = _rxNew;
 387     newObject( m_xFormComponent );
 388     // set images anew
 389     m_aNormalImage = GetImage();
 390 }
 391
 392 namespace svxform
 393 {
 394
 395     NavigatorFrame::NavigatorFrame( SfxBindings* _pBindings, SfxChildWindow* _pMgr,
 396                                   vcl::Window* _pParent )
 397       : SfxDockingWindow(_pBindings, _pMgr, _pParent, u"FormNavigator"_ustr, u"svx/ui/formnavigator.ui"_ustr)
 398       , SfxControllerItem( SID_FM_FMEXPLORER_CONTROL, *_pBindings )
 399       , m_xNavigatorTree(new NavigatorTree(m_xBuilder->weld_tree_view(u"treeview"_ustr)))
 400     {
 401         SetHelpId( HID_FORM_NAVIGATOR_WIN );
 402
 403         SetText( SvxResId(RID_STR_FMEXPLORER) );
 404         SfxDockingWindow::SetFloatingSize( Size(200,200) );
 405     }
 406
 407     NavigatorFrame::~NavigatorFrame()
 408     {
 409         disposeOnce();
 410     }
 411
 412     void NavigatorFrame::dispose()
 413     {
 414         m_xNavigatorTree.reset();
 415         ::SfxControllerItem::dispose();
 416         SfxDockingWindow::dispose();
 417     }
 418
 419     void NavigatorFrame::UpdateContent( FmFormShell* pFormShell )
 420     {
 421         m_xNavigatorTree->UpdateContent(pFormShell);
 422     }
 423
 424     void NavigatorFrame::StateChangedAtToolBoxControl( sal_uInt16 nSID, SfxItemState eState, const SfxPoolItem* pState )
 425     {
 426         if( !pState  || SID_FM_FMEXPLORER_CONTROL != nSID )
 427             return;
 428
 429         if( eState >= SfxItemState::DEFAULT )
 430         {
 431             FmFormShell* pShell = dynamic_cast<FmFormShell*>( static_cast<const SfxObjectItem*>(pState)->GetShell()  );
 432             UpdateContent( pShell );
 433         }
 434         else
 435             UpdateContent( nullptr );
 436     }
 437
 438     void NavigatorFrame::GetFocus()
 439     {
 440         if (m_xNavigatorTree )
 441             m_xNavigatorTree->GrabFocus();
 442         else
 443             SfxDockingWindow::GetFocus();
 444     }
 445
 446     bool NavigatorFrame::Close()
 447     {
 448         UpdateContent( nullptr );
 449         return SfxDockingWindow::Close();
 450     }
 451
 452     void NavigatorFrame::FillInfo( SfxChildWinInfo& rInfo ) const
 453     {
 454         SfxDockingWindow::FillInfo( rInfo );
 455         rInfo.bVisible = false;
 456     }
 457
 458     Size NavigatorFrame::CalcDockingSize( SfxChildAlignment eAlign )
 459     {
 460         if ( ( eAlign == SfxChildAlignment::TOP ) || ( eAlign == SfxChildAlignment::BOTTOM ) )
 461             return Size();
 462
 463         return SfxDockingWindow::CalcDockingSize( eAlign );
 464     }
 465
 466     SfxChildAlignment NavigatorFrame::CheckAlignment( SfxChildAlignment _eActAlign, SfxChildAlignment _eAlign )
 467     {
 468         if ( ( _eAlign == SfxChildAlignment::LEFT ) || ( _eAlign == SfxChildAlignment::RIGHT ) || ( _eAlign == SfxChildAlignment::NOALIGNMENT ) )
 469             return _eAlign;
 470         return _eActAlign;
 471     }
 472
 473     SFX_IMPL_DOCKINGWINDOW( NavigatorFrameManager, SID_FM_SHOW_FMEXPLORER )
 474
 475     NavigatorFrameManager::NavigatorFrameManager( vcl::Window* _pParent, sal_uInt16 _nId,
 476                                         SfxBindings* _pBindings, SfxChildWinInfo* _pInfo )
 477                      :SfxChildWindow( _pParent, _nId )
 478     {
 479         SetWindow( VclPtr<NavigatorFrame>::Create( _pBindings, this, _pParent ) );
 480         static_cast<SfxDockingWindow*>(GetWindow())->Initialize( _pInfo );
 481     }
 482 }
 483
 484 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */