sfx2/source/dialog/itemconnect.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #include <sfx2/itemconnect.hxx>
  30
  31 #include <boost/shared_ptr.hpp>
  32 #include <list>
  33 #include <svl/itempool.hxx>
  34
  35 // ============================================================================
  36
  37 namespace sfx {
  38
  39 // ============================================================================
  40 // Helpers
  41 // ============================================================================
  42
  43 namespace {
  44
  45 TriState lclConvertToTriState( bool bKnown, bool bIsKnownFlag, bool bIsUnknownFlag )
  46 {
  47     return (bKnown && bIsKnownFlag) ? STATE_CHECK : ((!bKnown && bIsUnknownFlag) ? STATE_NOCHECK : STATE_DONTKNOW);
  48 }
  49
  50 } // namespace
  51
  52 // ----------------------------------------------------------------------------
  53
  54 sal_uInt16 ItemWrapperHelper::GetWhichId( const SfxItemSet& rItemSet, sal_uInt16 nSlot )
  55 {
  56     return rItemSet.GetPool()->GetWhich( nSlot );
  57 }
  58
  59 bool ItemWrapperHelper::IsKnownItem( const SfxItemSet& rItemSet, sal_uInt16 nSlot )
  60 {
  61     return rItemSet.GetItemState( GetWhichId( rItemSet, nSlot ), sal_True ) != SFX_ITEM_UNKNOWN;
  62 }
  63
  64 const SfxPoolItem* ItemWrapperHelper::GetUniqueItem( const SfxItemSet& rItemSet, sal_uInt16 nSlot )
  65 {
  66     sal_uInt16 nWhich = GetWhichId( rItemSet, nSlot );
  67     return (rItemSet.GetItemState( nWhich, sal_True ) >= SFX_ITEM_DEFAULT) ? rItemSet.GetItem( nWhich, sal_True ) : 0;
  68 }
  69
  70 const SfxPoolItem& ItemWrapperHelper::GetDefaultItem( const SfxItemSet& rItemSet, sal_uInt16 nSlot )
  71 {
  72     return rItemSet.GetPool()->GetDefaultItem( GetWhichId( rItemSet, nSlot ) );
  73 }
  74
  75 void ItemWrapperHelper::RemoveDefaultItem( SfxItemSet& rDestSet, const SfxItemSet& rOldSet, sal_uInt16 nSlot )
  76 {
  77     sal_uInt16 nWhich = GetWhichId( rDestSet, nSlot );
  78     if( rOldSet.GetItemState( nWhich, sal_False ) == SFX_ITEM_DEFAULT )
  79         rDestSet.ClearItem( nWhich );
  80 }
  81
  82 // ============================================================================
  83 // Base control wrapper classes
  84 // ============================================================================
  85
  86 ControlWrapperBase::~ControlWrapperBase()
  87 {
  88 }
  89
  90 // ============================================================================
  91 // Single control wrappers
  92 // ============================================================================
  93
  94 DummyWindowWrapper::DummyWindowWrapper( Window& rWindow ) :
  95     SingleControlWrapperType( rWindow )
  96 {
  97 }
  98
  99 bool DummyWindowWrapper::IsControlDontKnow() const
 100 {
 101     return false;
 102 }
 103
 104 void DummyWindowWrapper::SetControlDontKnow( bool )
 105 {
 106 }
 107
 108 void* DummyWindowWrapper::GetControlValue() const
 109 {
 110     return 0;
 111 }
 112
 113 void DummyWindowWrapper::SetControlValue( void* )
 114 {
 115 }
 116
 117 // ----------------------------------------------------------------------------
 118
 119 CheckBoxWrapper::CheckBoxWrapper( CheckBox& rCheckBox ) :
 120         SingleControlWrapperType( rCheckBox )
 121 {
 122 }
 123
 124 bool CheckBoxWrapper::IsControlDontKnow() const
 125 {
 126     return GetControl().GetState() == STATE_DONTKNOW;
 127 }
 128
 129 void CheckBoxWrapper::SetControlDontKnow( bool bSet )
 130 {
 131     GetControl().EnableTriState( bSet );
 132     GetControl().SetState( bSet ? STATE_DONTKNOW : STATE_NOCHECK );
 133 }
 134
 135 sal_Bool CheckBoxWrapper::GetControlValue() const
 136 {
 137     return GetControl().IsChecked();
 138 }
 139
 140 void CheckBoxWrapper::SetControlValue( sal_Bool bValue )
 141 {
 142     GetControl().Check( bValue );
 143 }
 144
 145 // ----------------------------------------------------------------------------
 146
 147 ColorListBoxWrapper::ColorListBoxWrapper(ColorListBox & rListBox):
 148     SingleControlWrapper< ColorListBox, Color >(rListBox)
 149 {}
 150
 151 ColorListBoxWrapper::~ColorListBoxWrapper()
 152 {}
 153
 154 bool ColorListBoxWrapper::IsControlDontKnow() const
 155 {
 156     return GetControl().GetSelectEntryCount() == 0;
 157 }
 158
 159 void ColorListBoxWrapper::SetControlDontKnow( bool bSet )
 160 {
 161     if( bSet ) GetControl().SetNoSelection();
 162 }
 163
 164 Color ColorListBoxWrapper::GetControlValue() const
 165 {
 166     return GetControl().GetSelectEntryColor();
 167 }
 168
 169 void ColorListBoxWrapper::SetControlValue( Color aColor )
 170 {
 171     GetControl().SelectEntry( aColor );
 172 }
 173
 174 // ============================================================================
 175 // Multi control wrappers
 176 // ============================================================================
 177
 178 typedef std::vector< ControlWrapperBase* >  ControlWrpVec;
 179 typedef ControlWrpVec::iterator             ControlWrpVecI;
 180 typedef ControlWrpVec::const_iterator       ControlWrpVecCI;
 181
 182 struct MultiControlWrapperHelper_Impl
 183 {
 184     ControlWrpVec       maVec;
 185 };
 186
 187 MultiControlWrapperHelper::MultiControlWrapperHelper() :
 188     mxImpl( new MultiControlWrapperHelper_Impl )
 189 {
 190 }
 191
 192 MultiControlWrapperHelper::~MultiControlWrapperHelper()
 193 {
 194 }
 195
 196 void MultiControlWrapperHelper::RegisterControlWrapper( ControlWrapperBase& rWrapper )
 197 {
 198     mxImpl->maVec.push_back( &rWrapper );
 199 }
 200
 201 void MultiControlWrapperHelper::ModifyControl( TriState eEnable, TriState eShow )
 202 {
 203     for( ControlWrpVecI aIt = mxImpl->maVec.begin(), aEnd = mxImpl->maVec.end(); aIt != aEnd; ++aIt )
 204         (*aIt)->ModifyControl( eEnable, eShow );
 205 }
 206
 207 bool MultiControlWrapperHelper::IsControlDontKnow() const
 208 {
 209     bool bIs = !mxImpl->maVec.empty();
 210     for( ControlWrpVecCI aIt = mxImpl->maVec.begin(), aEnd = mxImpl->maVec.end(); bIs && (aIt != aEnd); ++aIt )
 211         bIs &= (*aIt)->IsControlDontKnow();
 212     return bIs;
 213 }
 214
 215 void MultiControlWrapperHelper::SetControlDontKnow( bool bSet )
 216 {
 217     for( ControlWrpVecI aIt = mxImpl->maVec.begin(), aEnd = mxImpl->maVec.end(); aIt != aEnd; ++aIt )
 218         (*aIt)->SetControlDontKnow( bSet );
 219 }
 220
 221 // ============================================================================
 222 // Base connection classes
 223 // ============================================================================
 224
 225 ItemConnectionBase::ItemConnectionBase( ItemConnFlags nFlags ) :
 226     mnFlags( nFlags )
 227 {
 228 }
 229
 230 ItemConnectionBase::~ItemConnectionBase()
 231 {
 232 }
 233
 234 bool ItemConnectionBase::IsActive() const
 235 {
 236     return !(mnFlags & ITEMCONN_INACTIVE);
 237 }
 238
 239 void ItemConnectionBase::DoApplyFlags( const SfxItemSet& rItemSet )
 240 {
 241     if( IsActive() )
 242         ApplyFlags( rItemSet );
 243 }
 244
 245 void ItemConnectionBase::DoReset( const SfxItemSet& rItemSet )
 246 {
 247     if( IsActive() )
 248         Reset( rItemSet );
 249 }
 250
 251 bool ItemConnectionBase::DoFillItemSet( SfxItemSet& rDestSet, const SfxItemSet& rOldSet )
 252 {
 253     return IsActive() && FillItemSet( rDestSet, rOldSet );
 254 }
 255
 256 TriState ItemConnectionBase::GetEnableState( bool bKnown ) const
 257 {
 258     return lclConvertToTriState( bKnown, mnFlags & ITEMCONN_ENABLE_KNOWN, mnFlags & ITEMCONN_DISABLE_UNKNOWN );
 259 }
 260
 261 TriState ItemConnectionBase::GetShowState( bool bKnown ) const
 262 {
 263     return lclConvertToTriState( bKnown, mnFlags & ITEMCONN_SHOW_KNOWN, mnFlags & ITEMCONN_HIDE_UNKNOWN );
 264 }
 265
 266 // ============================================================================
 267 // Standard connections
 268 // ============================================================================
 269
 270 DummyItemConnection::DummyItemConnection( sal_uInt16 nSlot, Window& rWindow, ItemConnFlags nFlags ) :
 271     ItemConnectionBase( nFlags ),
 272     DummyWindowWrapper( rWindow ),
 273     mnSlot( nSlot )
 274 {
 275 }
 276
 277 void DummyItemConnection::ApplyFlags( const SfxItemSet& rItemSet )
 278 {
 279     bool bKnown = ItemWrapperHelper::IsKnownItem( rItemSet, mnSlot );
 280     ModifyControl( GetEnableState( bKnown ), GetShowState( bKnown ) );
 281 }
 282
 283 void DummyItemConnection::Reset( const SfxItemSet& /*rItemSet*/ )
 284 {
 285 }
 286
 287 bool DummyItemConnection::FillItemSet( SfxItemSet& /*rDestSet*/, const SfxItemSet& /*rOldSet*/ )
 288 {
 289     return false;   // item set not changed
 290 }
 291
 292 // ============================================================================
 293 // Array of connections
 294 // ============================================================================
 295
 296 class ItemConnectionArrayImpl
 297 {
 298 public:
 299     void                        Append( ItemConnectionBase* pConnection );
 300
 301     void                        ApplyFlags( const SfxItemSet& rItemSet );
 302     void                        Reset( const SfxItemSet& rItemSet );
 303     bool                        FillItemSet( SfxItemSet& rDestSet, const SfxItemSet& rOldSet );
 304
 305 private:
 306     typedef boost::shared_ptr< ItemConnectionBase > ItemConnectionRef;
 307     typedef std::list< ItemConnectionRef >          ItemConnectionList;
 308     typedef ItemConnectionList::iterator            ItemConnectionListIt;
 309
 310     ItemConnectionList          maList;
 311 };
 312
 313 void ItemConnectionArrayImpl::Append( ItemConnectionBase* pConnection )
 314 {
 315     if( pConnection )
 316         maList.push_back( ItemConnectionRef( pConnection ) );
 317 }
 318
 319 void ItemConnectionArrayImpl::ApplyFlags( const SfxItemSet& rItemSet )
 320 {
 321     for( ItemConnectionListIt aIt = maList.begin(), aEnd = maList.end(); aIt != aEnd; ++aIt )
 322         (*aIt)->DoApplyFlags( rItemSet );
 323 }
 324
 325 void ItemConnectionArrayImpl::Reset( const SfxItemSet& rItemSet )
 326 {
 327     for( ItemConnectionListIt aIt = maList.begin(), aEnd = maList.end(); aIt != aEnd; ++aIt )
 328         (*aIt)->DoReset( rItemSet );
 329 }
 330
 331 bool ItemConnectionArrayImpl::FillItemSet( SfxItemSet& rDestSet, const SfxItemSet& rOldSet )
 332 {
 333     bool bChanged = false;
 334     for( ItemConnectionListIt aIt = maList.begin(), aEnd = maList.end(); aIt != aEnd; ++aIt )
 335         bChanged |= (*aIt)->DoFillItemSet( rDestSet, rOldSet );
 336     return bChanged;
 337 }
 338
 339 // ----------------------------------------------------------------------------
 340
 341 ItemConnectionArray::ItemConnectionArray() :
 342     mxImpl( new ItemConnectionArrayImpl )
 343 {
 344 }
 345
 346 ItemConnectionArray::~ItemConnectionArray()
 347 {
 348 }
 349
 350 void ItemConnectionArray::AddConnection( ItemConnectionBase* pConnection )
 351 {
 352     mxImpl->Append( pConnection );
 353 }
 354
 355 void ItemConnectionArray::ApplyFlags( const SfxItemSet& rItemSet )
 356 {
 357     mxImpl->ApplyFlags( rItemSet );
 358 }
 359
 360 void ItemConnectionArray::Reset( const SfxItemSet& rItemSet )
 361 {
 362     mxImpl->Reset( rItemSet );
 363 }
 364
 365 bool ItemConnectionArray::FillItemSet( SfxItemSet& rDestSet, const SfxItemSet& rOldSet )
 366 {
 367     return mxImpl->FillItemSet( rDestSet, rOldSet );
 368 }
 369
 370 // ============================================================================
 371
 372 } // namespace sfx
 373
 374 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */