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