sfx2/source/dialog/itemconnect.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 <sfx2/itemconnect.hxx>
  21
  22 #include <boost/shared_ptr.hpp>
  23 #include <list>
  24 #include <svl/itempool.hxx>
  25
  26 // ============================================================================
  27
  28 namespace sfx {
  29
  30 // ============================================================================
  31 // Helpers
  32 // ============================================================================
  33
  34 namespace {
  35
  36 TriState lclConvertToTriState( bool bKnown, bool bIsKnownFlag, bool bIsUnknownFlag )
  37 {
  38     return (bKnown && bIsKnownFlag) ? STATE_CHECK : ((!bKnown && bIsUnknownFlag) ? STATE_NOCHECK : STATE_DONTKNOW);
  39 }
  40
  41 } // namespace
  42
  43 // ----------------------------------------------------------------------------
  44
  45 sal_uInt16 ItemWrapperHelper::GetWhichId( const SfxItemSet& rItemSet, sal_uInt16 nSlot )
  46 {
  47     return rItemSet.GetPool()->GetWhich( nSlot );
  48 }
  49
  50 bool ItemWrapperHelper::IsKnownItem( const SfxItemSet& rItemSet, sal_uInt16 nSlot )
  51 {
  52     return rItemSet.GetItemState( GetWhichId( rItemSet, nSlot ), sal_True ) != SFX_ITEM_UNKNOWN;
  53 }
  54
  55 const SfxPoolItem* ItemWrapperHelper::GetUniqueItem( const SfxItemSet& rItemSet, sal_uInt16 nSlot )
  56 {
  57     sal_uInt16 nWhich = GetWhichId( rItemSet, nSlot );
  58     return (rItemSet.GetItemState( nWhich, sal_True ) >= SFX_ITEM_DEFAULT) ? rItemSet.GetItem( nWhich, sal_True ) : 0;
  59 }
  60
  61 const SfxPoolItem& ItemWrapperHelper::GetDefaultItem( const SfxItemSet& rItemSet, sal_uInt16 nSlot )
  62 {
  63     return rItemSet.GetPool()->GetDefaultItem( GetWhichId( rItemSet, nSlot ) );
  64 }
  65
  66 void ItemWrapperHelper::RemoveDefaultItem( SfxItemSet& rDestSet, const SfxItemSet& rOldSet, sal_uInt16 nSlot )
  67 {
  68     sal_uInt16 nWhich = GetWhichId( rDestSet, nSlot );
  69     if( rOldSet.GetItemState( nWhich, sal_False ) == SFX_ITEM_DEFAULT )
  70         rDestSet.ClearItem( nWhich );
  71 }
  72
  73 // ============================================================================
  74 // Base control wrapper classes
  75 // ============================================================================
  76
  77 ControlWrapperBase::~ControlWrapperBase()
  78 {
  79 }
  80
  81 // ============================================================================
  82 // Single control wrappers
  83 // ============================================================================
  84
  85 DummyWindowWrapper::DummyWindowWrapper( Window& rWindow ) :
  86     SingleControlWrapperType( rWindow )
  87 {
  88 }
  89
  90 bool DummyWindowWrapper::IsControlDontKnow() const
  91 {
  92     return false;
  93 }
  94
  95 void DummyWindowWrapper::SetControlDontKnow( bool )
  96 {
  97 }
  98
  99 void* DummyWindowWrapper::GetControlValue() const
 100 {
 101     return 0;
 102 }
 103
 104 void DummyWindowWrapper::SetControlValue( void* )
 105 {
 106 }
 107
 108 // ----------------------------------------------------------------------------
 109
 110 CheckBoxWrapper::CheckBoxWrapper( CheckBox& rCheckBox ) :
 111         SingleControlWrapperType( rCheckBox )
 112 {
 113 }
 114
 115 bool CheckBoxWrapper::IsControlDontKnow() const
 116 {
 117     return GetControl().GetState() == STATE_DONTKNOW;
 118 }
 119
 120 void CheckBoxWrapper::SetControlDontKnow( bool bSet )
 121 {
 122     GetControl().EnableTriState( bSet );
 123     GetControl().SetState( bSet ? STATE_DONTKNOW : STATE_NOCHECK );
 124 }
 125
 126 sal_Bool CheckBoxWrapper::GetControlValue() const
 127 {
 128     return GetControl().IsChecked();
 129 }
 130
 131 void CheckBoxWrapper::SetControlValue( sal_Bool bValue )
 132 {
 133     GetControl().Check( bValue );
 134 }
 135
 136 // ----------------------------------------------------------------------------
 137
 138 ColorListBoxWrapper::ColorListBoxWrapper(ColorListBox & rListBox):
 139     SingleControlWrapper< ColorListBox, Color >(rListBox)
 140 {}
 141
 142 ColorListBoxWrapper::~ColorListBoxWrapper()
 143 {}
 144
 145 bool ColorListBoxWrapper::IsControlDontKnow() const
 146 {
 147     return GetControl().GetSelectEntryCount() == 0;
 148 }
 149
 150 void ColorListBoxWrapper::SetControlDontKnow( bool bSet )
 151 {
 152     if( bSet ) GetControl().SetNoSelection();
 153 }
 154
 155 Color ColorListBoxWrapper::GetControlValue() const
 156 {
 157     return GetControl().GetSelectEntryColor();
 158 }
 159
 160 void ColorListBoxWrapper::SetControlValue( Color aColor )
 161 {
 162     GetControl().SelectEntry( aColor );
 163 }
 164
 165 // ============================================================================
 166 // Multi control wrappers
 167 // ============================================================================
 168
 169 typedef std::vector< ControlWrapperBase* >  ControlWrpVec;
 170 typedef ControlWrpVec::iterator             ControlWrpVecI;
 171 typedef ControlWrpVec::const_iterator       ControlWrpVecCI;
 172
 173 struct MultiControlWrapperHelper_Impl
 174 {
 175     ControlWrpVec       maVec;
 176 };
 177
 178 MultiControlWrapperHelper::MultiControlWrapperHelper() :
 179     mxImpl( new MultiControlWrapperHelper_Impl )
 180 {
 181 }
 182
 183 MultiControlWrapperHelper::~MultiControlWrapperHelper()
 184 {
 185 }
 186
 187 void MultiControlWrapperHelper::RegisterControlWrapper( ControlWrapperBase& rWrapper )
 188 {
 189     mxImpl->maVec.push_back( &rWrapper );
 190 }
 191
 192 void MultiControlWrapperHelper::ModifyControl( TriState eEnable, TriState eShow )
 193 {
 194     for( ControlWrpVecI aIt = mxImpl->maVec.begin(), aEnd = mxImpl->maVec.end(); aIt != aEnd; ++aIt )
 195         (*aIt)->ModifyControl( eEnable, eShow );
 196 }
 197
 198 bool MultiControlWrapperHelper::IsControlDontKnow() const
 199 {
 200     bool bIs = !mxImpl->maVec.empty();
 201     for( ControlWrpVecCI aIt = mxImpl->maVec.begin(), aEnd = mxImpl->maVec.end(); bIs && (aIt != aEnd); ++aIt )
 202         bIs &= (*aIt)->IsControlDontKnow();
 203     return bIs;
 204 }
 205
 206 void MultiControlWrapperHelper::SetControlDontKnow( bool bSet )
 207 {
 208     for( ControlWrpVecI aIt = mxImpl->maVec.begin(), aEnd = mxImpl->maVec.end(); aIt != aEnd; ++aIt )
 209         (*aIt)->SetControlDontKnow( bSet );
 210 }
 211
 212 // ============================================================================
 213 // Base connection classes
 214 // ============================================================================
 215
 216 ItemConnectionBase::ItemConnectionBase( ItemConnFlags nFlags ) :
 217     mnFlags( nFlags )
 218 {
 219 }
 220
 221 ItemConnectionBase::~ItemConnectionBase()
 222 {
 223 }
 224
 225 bool ItemConnectionBase::IsActive() const
 226 {
 227     return !(mnFlags & ITEMCONN_INACTIVE);
 228 }
 229
 230 void ItemConnectionBase::DoApplyFlags( const SfxItemSet& rItemSet )
 231 {
 232     if( IsActive() )
 233         ApplyFlags( rItemSet );
 234 }
 235
 236 void ItemConnectionBase::DoReset( const SfxItemSet& rItemSet )
 237 {
 238     if( IsActive() )
 239         Reset( rItemSet );
 240 }
 241
 242 bool ItemConnectionBase::DoFillItemSet( SfxItemSet& rDestSet, const SfxItemSet& rOldSet )
 243 {
 244     return IsActive() && FillItemSet( rDestSet, rOldSet );
 245 }
 246
 247 TriState ItemConnectionBase::GetEnableState( bool bKnown ) const
 248 {
 249     return lclConvertToTriState( bKnown, mnFlags & ITEMCONN_ENABLE_KNOWN, mnFlags & ITEMCONN_DISABLE_UNKNOWN );
 250 }
 251
 252 TriState ItemConnectionBase::GetShowState( bool bKnown ) const
 253 {
 254     return lclConvertToTriState( bKnown, mnFlags & ITEMCONN_SHOW_KNOWN, mnFlags & ITEMCONN_HIDE_UNKNOWN );
 255 }
 256
 257 // ============================================================================
 258 // Standard connections
 259 // ============================================================================
 260
 261 DummyItemConnection::DummyItemConnection( sal_uInt16 nSlot, Window& rWindow, ItemConnFlags nFlags ) :
 262     ItemConnectionBase( nFlags ),
 263     DummyWindowWrapper( rWindow ),
 264     mnSlot( nSlot )
 265 {
 266 }
 267
 268 void DummyItemConnection::ApplyFlags( const SfxItemSet& rItemSet )
 269 {
 270     bool bKnown = ItemWrapperHelper::IsKnownItem( rItemSet, mnSlot );
 271     ModifyControl( GetEnableState( bKnown ), GetShowState( bKnown ) );
 272 }
 273
 274 void DummyItemConnection::Reset( const SfxItemSet& /*rItemSet*/ )
 275 {
 276 }
 277
 278 bool DummyItemConnection::FillItemSet( SfxItemSet& /*rDestSet*/, const SfxItemSet& /*rOldSet*/ )
 279 {
 280     return false;   // item set not changed
 281 }
 282
 283 // ============================================================================
 284 // Array of connections
 285 // ============================================================================
 286
 287 class ItemConnectionArrayImpl
 288 {
 289 public:
 290     void                        Append( ItemConnectionBase* pConnection );
 291
 292     void                        ApplyFlags( const SfxItemSet& rItemSet );
 293     void                        Reset( const SfxItemSet& rItemSet );
 294     bool                        FillItemSet( SfxItemSet& rDestSet, const SfxItemSet& rOldSet );
 295
 296 private:
 297     typedef boost::shared_ptr< ItemConnectionBase > ItemConnectionRef;
 298     typedef std::list< ItemConnectionRef >          ItemConnectionList;
 299     typedef ItemConnectionList::iterator            ItemConnectionListIt;
 300
 301     ItemConnectionList          maList;
 302 };
 303
 304 void ItemConnectionArrayImpl::Append( ItemConnectionBase* pConnection )
 305 {
 306     if( pConnection )
 307         maList.push_back( ItemConnectionRef( pConnection ) );
 308 }
 309
 310 void ItemConnectionArrayImpl::ApplyFlags( const SfxItemSet& rItemSet )
 311 {
 312     for( ItemConnectionListIt aIt = maList.begin(), aEnd = maList.end(); aIt != aEnd; ++aIt )
 313         (*aIt)->DoApplyFlags( rItemSet );
 314 }
 315
 316 void ItemConnectionArrayImpl::Reset( const SfxItemSet& rItemSet )
 317 {
 318     for( ItemConnectionListIt aIt = maList.begin(), aEnd = maList.end(); aIt != aEnd; ++aIt )
 319         (*aIt)->DoReset( rItemSet );
 320 }
 321
 322 bool ItemConnectionArrayImpl::FillItemSet( SfxItemSet& rDestSet, const SfxItemSet& rOldSet )
 323 {
 324     bool bChanged = false;
 325     for( ItemConnectionListIt aIt = maList.begin(), aEnd = maList.end(); aIt != aEnd; ++aIt )
 326         bChanged |= (*aIt)->DoFillItemSet( rDestSet, rOldSet );
 327     return bChanged;
 328 }
 329
 330 // ----------------------------------------------------------------------------
 331
 332 ItemConnectionArray::ItemConnectionArray() :
 333     mxImpl( new ItemConnectionArrayImpl )
 334 {
 335 }
 336
 337 ItemConnectionArray::~ItemConnectionArray()
 338 {
 339 }
 340
 341 void ItemConnectionArray::AddConnection( ItemConnectionBase* pConnection )
 342 {
 343     mxImpl->Append( pConnection );
 344 }
 345
 346 void ItemConnectionArray::ApplyFlags( const SfxItemSet& rItemSet )
 347 {
 348     mxImpl->ApplyFlags( rItemSet );
 349 }
 350
 351 void ItemConnectionArray::Reset( const SfxItemSet& rItemSet )
 352 {
 353     mxImpl->Reset( rItemSet );
 354 }
 355
 356 bool ItemConnectionArray::FillItemSet( SfxItemSet& rDestSet, const SfxItemSet& rOldSet )
 357 {
 358     return mxImpl->FillItemSet( rDestSet, rOldSet );
 359 }
 360
 361 // ============================================================================
 362
 363 } // namespace sfx
 364
 365 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */