sfx2/source/dialog/mgetempl.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
  30 // include ---------------------------------------------------------------
  31 #include <vcl/msgbox.hxx>
  32 #include <vcl/field.hxx>
  33 #include <svl/eitem.hxx>
  34 #include <svl/intitem.hxx>
  35 #include <svl/style.hxx>
  36
  37 #include <sfx2/styfitem.hxx>
  38 #include <sfx2/styledlg.hxx>
  39 #include <sfx2/app.hxx>
  40 #include <sfx2/mgetempl.hxx>
  41 #include <sfx2/objsh.hxx>
  42 #include "sfxtypes.hxx"
  43 #include "sfx2/sfxresid.hxx"
  44 #include <sfx2/module.hxx>
  45
  46 #include <sfx2/sfx.hrc>
  47 #include "dialog.hrc"
  48 #include "mgetempl.hrc"
  49
  50 #include <svl/style.hrc>
  51
  52 // SfxManageStyleSheetPage -----------------------------------------------
  53
  54 SfxManageStyleSheetPage::SfxManageStyleSheetPage( Window* pParent, const SfxItemSet& rAttrSet ) :
  55
  56     SfxTabPage( pParent, SfxResId( TP_MANAGE_STYLES ), rAttrSet ),
  57
  58     aNameFt     ( this, SfxResId( FT_NAME ) ),
  59     aNameEd     ( this, SfxResId( ED_NAME ) ),
  60     aNameMLE    ( this, SfxResId( MLE_NAME ) ),
  61     aAutoCB     ( this, SfxResId( CB_AUTO ) ),
  62
  63     aFollowFt   ( this, SfxResId( FT_NEXT ) ),
  64     aFollowLb   ( this, SfxResId( LB_NEXT ) ),
  65
  66     aBaseFt     ( this, SfxResId( FT_BASE ) ),
  67     aBaseLb     ( this, SfxResId( LB_BASE ) ),
  68
  69     aFilterFt   ( this, SfxResId( FT_REGION ) ),
  70     aFilterLb   ( this, SfxResId( LB_REGION ) ),
  71
  72     aDescGb     ( this, SfxResId( GB_DESC ) ),
  73     aDescFt     ( this, SfxResId( FT_DESC ) ),
  74     aDescED     ( this, SfxResId( ED_DESC ) ),
  75
  76     pStyle( &( (SfxStyleDialog*)pParent->GetParent() )->GetStyleSheet() ),
  77
  78     pItem       ( 0 ),
  79     bModified   ( sal_False ),
  80     aName       ( pStyle->GetName() ),
  81     aFollow     ( pStyle->GetFollow() ),
  82     aParent     ( pStyle->GetParent() ),
  83     nFlags      ( pStyle->GetMask() )
  84
  85 /*  [Description]
  86
  87     Constructor, initializes the list box with the templates
  88 */
  89
  90 {
  91     FreeResource();
  92
  93     if ( IsBackground() )
  94         aDescED.SetBackground( GetBackground() );
  95     FixedInfo* pInfo = new FixedInfo( this );
  96     aDescED.SetFont( pInfo->GetFont() );
  97     delete pInfo;
  98
  99     aDescED.Hide();
 100     aDescFt.Show();
 101
 102     // this Page needs ExchangeSupport
 103     SetExchangeSupport();
 104
 105     ResMgr* pResMgr = SFX_APP()->GetModule_Impl()->GetResMgr();
 106     OSL_ENSURE( pResMgr, "No ResMgr in Module" );
 107     pFamilies = new SfxStyleFamilies( ResId( DLG_STYLE_DESIGNER, *pResMgr ) );
 108
 109     SfxStyleSheetBasePool* pPool = 0;
 110     SfxObjectShell* pDocShell = SfxObjectShell::Current();
 111
 112     if ( pDocShell )
 113         pPool = pDocShell->GetStyleSheetPool();
 114     OSL_ENSURE( pPool, "no Pool or no DocShell" );
 115
 116     if ( pPool )
 117     {
 118         pPool->SetSearchMask( pStyle->GetFamily() );
 119         pPool->First();     // for SW - update internal list
 120     }
 121
 122     if ( !pStyle->GetName().Len() && pPool )
 123     {
 124         // NullString as Name -> generate Name
 125         String aNoName( SfxResId( STR_NONAME ) );
 126         sal_uInt16 nNo = 1;
 127         String aNo( aNoName );
 128         aNoName += String::CreateFromInt32( nNo );
 129         while ( pPool->Find( aNoName ) )
 130         {
 131             ++nNo;
 132             aNoName = aNo;
 133             aNoName += String::CreateFromInt32( nNo );
 134         }
 135         pStyle->SetName( aNoName );
 136         aName = aNoName;
 137         aFollow = pStyle->GetFollow();
 138         aParent = pStyle->GetParent();
 139     }
 140     aNameEd.SetText(pStyle->GetName());
 141
 142     // Set the field read-only if it is NOT an user-defined style
 143     // but allow selecting and copying
 144     if ( !pStyle->IsUserDefined() ) {
 145         aNameEd.SetReadOnly();
 146         aNameEd.Hide();
 147
 148         aNameMLE.SetControlBackground( GetSettings().GetStyleSettings().GetDialogColor() );
 149         aNameMLE.SetText( pStyle->GetName() );
 150         aNameMLE.EnableCursor( sal_False );
 151         aNameMLE.Show();
 152     }
 153
 154     if ( pStyle->HasFollowSupport() && pPool )
 155     {
 156         SfxStyleSheetBase* pPoolStyle = pPool->First();
 157
 158         while ( pPoolStyle )
 159         {
 160             aFollowLb.InsertEntry( pPoolStyle->GetName() );
 161             pPoolStyle = pPool->Next();
 162         }
 163
 164         // A new Template is not jet in the Pool
 165         if ( LISTBOX_ENTRY_NOTFOUND == aFollowLb.GetEntryPos( pStyle->GetName() ) )
 166             aFollowLb.InsertEntry( pStyle->GetName() );
 167     }
 168     else
 169     {
 170         aFollowFt.Hide();
 171         aFollowLb.Hide();
 172
 173         aFilterFt.SetPosPixel( aBaseFt.GetPosPixel() );
 174         aFilterLb.SetPosPixel( aBaseLb.GetPosPixel() );
 175
 176         aBaseFt.SetPosPixel( aFollowFt.GetPosPixel() );
 177         aBaseLb.SetPosPixel( aFollowLb.GetPosPixel() );
 178     }
 179
 180     if ( pStyle->HasParentSupport() && pPool )
 181     {
 182         if ( pStyle->HasClearParentSupport() )
 183             // the base template can be set to NULL
 184             aBaseLb.InsertEntry( String( SfxResId( STR_NONE ) ) );
 185
 186         SfxStyleSheetBase* pPoolStyle = pPool->First();
 187
 188         while ( pPoolStyle )
 189         {
 190             const String aStr( pPoolStyle->GetName() );
 191             // own name as base template
 192             if ( aStr != aName )
 193                 aBaseLb.InsertEntry( aStr );
 194             pPoolStyle = pPool->Next();
 195         }
 196     }
 197     else
 198     {
 199         aBaseFt.Disable();
 200         aBaseLb.Disable();
 201     }
 202
 203     size_t nCount = pFamilies->size();
 204     size_t i;
 205     for ( i = 0; i < nCount; ++i )
 206     {
 207         pItem = pFamilies->at( i );
 208
 209         if ( pItem->GetFamily() == pStyle->GetFamily() )
 210             break;
 211     }
 212
 213     if ( i < nCount )
 214     {
 215         sal_uInt16 nStyleFilterIdx = 0xffff;
 216         // Filter flags
 217         const SfxStyleFilter& rList = pItem->GetFilterList();
 218         nCount = rList.size();
 219         sal_uInt16 nIdx = 0;
 220         sal_uInt16 nMask = pStyle->GetMask() & ~SFXSTYLEBIT_USERDEF;
 221
 222         if ( !nMask )   // User Template?
 223             nMask = pStyle->GetMask();
 224
 225         for ( i = 0; i < nCount; ++i )
 226         {
 227             SfxFilterTupel* pTupel = rList[ i ];
 228
 229             if ( pTupel->nFlags != SFXSTYLEBIT_AUTO     &&
 230                  pTupel->nFlags != SFXSTYLEBIT_USED     &&
 231                  pTupel->nFlags != SFXSTYLEBIT_ALL )
 232             {
 233                 aFilterLb.InsertEntry( pTupel->aName, nIdx );
 234                 aFilterLb.SetEntryData(nIdx, (void*)(long)i);
 235
 236                 if ( ( pTupel->nFlags & nMask ) == nMask )
 237                     nStyleFilterIdx = nIdx;
 238                 ++nIdx;
 239             }
 240         }
 241
 242         if ( nStyleFilterIdx != 0xFFFF )
 243             aFilterLb.SelectEntryPos( nStyleFilterIdx );
 244     }
 245
 246     if ( !aFilterLb.GetEntryCount() || !pStyle->IsUserDefined() )
 247     {
 248         pItem = 0;
 249         aFilterFt.Disable();
 250         aFilterLb.Disable();
 251     }
 252     else
 253         aFilterLb.SaveValue();
 254     SetDescriptionText_Impl();
 255
 256     if ( aFollowLb.IsEnabled() || aBaseLb.IsEnabled() )
 257     {
 258         aNameEd.SetGetFocusHdl(
 259             LINK( this, SfxManageStyleSheetPage, GetFocusHdl ) );
 260         aNameEd.SetLoseFocusHdl(
 261             LINK( this, SfxManageStyleSheetPage, LoseFocusHdl ) );
 262     }
 263     // It is a style with auto update? (SW only)
 264     if(SFX_ITEM_SET == rAttrSet.GetItemState(SID_ATTR_AUTO_STYLE_UPDATE))
 265     {
 266         Size aSize = aNameEd.GetSizePixel();
 267         aSize.Width() /= 2;
 268         aNameEd.SetSizePixel(aSize);
 269         aAutoCB.Show();
 270     }
 271 }
 272
 273 //-------------------------------------------------------------------------
 274
 275 SfxManageStyleSheetPage::~SfxManageStyleSheetPage()
 276
 277 /*  [Description]
 278
 279     Destructor, release of the data
 280 */
 281
 282 {
 283     aNameEd.SetGetFocusHdl( Link() );
 284     aNameEd.SetLoseFocusHdl( Link() );
 285     delete pFamilies;
 286     pItem = 0;
 287     pStyle = 0;
 288
 289 }
 290
 291 //-------------------------------------------------------------------------
 292
 293 void SfxManageStyleSheetPage::UpdateName_Impl( ListBox* pBox,
 294                                                const String& rNew )
 295
 296 /*  [Description]
 297
 298     After the change of a template name update the ListBox pBox
 299
 300     [Parameter]
 301
 302     ListBox* pBox         ListBox, whose entries are to be updated
 303     const String& rNew    the new Name
 304 */
 305
 306 {
 307     if ( pBox->IsEnabled() )
 308     {
 309         // it is the current entry, which name was modified
 310         const sal_Bool bSelect = pBox->GetSelectEntry() == aBuf;
 311         pBox->RemoveEntry( aBuf );
 312         pBox->InsertEntry( rNew );
 313
 314         if ( bSelect )
 315             pBox->SelectEntry( rNew );
 316     }
 317 }
 318
 319 //-------------------------------------------------------------------------
 320
 321 void SfxManageStyleSheetPage::SetDescriptionText_Impl()
 322
 323 /*  [Description]
 324
 325     Set attribute description. Get the set metric for this.
 326 */
 327
 328 {
 329     SfxMapUnit eUnit = SFX_MAPUNIT_CM;
 330     FieldUnit eFieldUnit( FUNIT_CM );
 331     SfxModule* pModule = SfxModule::GetActiveModule();
 332     if ( pModule )
 333     {
 334         const SfxPoolItem* pPoolItem = pModule->GetItem( SID_ATTR_METRIC );
 335         if ( pPoolItem )
 336             eFieldUnit = (FieldUnit)( (SfxUInt16Item*)pPoolItem )->GetValue();
 337     }
 338
 339     switch ( eFieldUnit )
 340     {
 341         case FUNIT_MM:      eUnit = SFX_MAPUNIT_MM; break;
 342         case FUNIT_CM:
 343         case FUNIT_M:
 344         case FUNIT_KM:      eUnit = SFX_MAPUNIT_CM; break;
 345         case FUNIT_POINT:
 346         case FUNIT_PICA:    eUnit = SFX_MAPUNIT_POINT; break;
 347         case FUNIT_INCH:
 348         case FUNIT_FOOT:
 349         case FUNIT_MILE:    eUnit = SFX_MAPUNIT_INCH; break;
 350
 351         default:
 352             OSL_FAIL( "non supported field unit" );
 353     }
 354     aDescFt.SetText( pStyle->GetDescription( eUnit ) );
 355 }
 356
 357 //-------------------------------------------------------------------------
 358
 359 IMPL_LINK_INLINE_START( SfxManageStyleSheetPage, GetFocusHdl, Edit *, pEdit )
 360
 361 /*  [Description]
 362
 363     StarView Handler; GetFocus-Handler of the Edits with the template name.
 364 */
 365
 366 {
 367     aBuf = pEdit->GetText().EraseLeadingChars();
 368     return 0;
 369 }
 370 IMPL_LINK_INLINE_END( SfxManageStyleSheetPage, GetFocusHdl, Edit *, pEdit )
 371
 372 //-------------------------------------------------------------------------
 373
 374 IMPL_LINK_INLINE_START( SfxManageStyleSheetPage, LoseFocusHdl, Edit *, pEdit )
 375
 376 /*  [Description]
 377
 378     StarView Handler; loose-focus-handler of the edits of the template name.
 379     This will update the listbox with the subsequent templates. The current
 380     template itself is not returned in the listbox of the base templates.
 381 */
 382
 383 {
 384     const String aStr( pEdit->GetText().EraseLeadingChars() );
 385     pEdit->SetText( aStr );
 386     // Update the Listbox of the base template if possible
 387     if ( aStr != aBuf )
 388         UpdateName_Impl( &aFollowLb, aStr );
 389     return 0;
 390 }
 391 IMPL_LINK_INLINE_END( SfxManageStyleSheetPage, LoseFocusHdl, Edit *, pEdit )
 392
 393 //-------------------------------------------------------------------------
 394
 395 sal_Bool SfxManageStyleSheetPage::FillItemSet( SfxItemSet& rSet )
 396
 397 /*  [Description]
 398
 399     Handler for setting the (modified) data. I called from the OK of the
 400     SfxTabDialog.
 401
 402     [Parameter]
 403
 404     SfxItemSet &rAttrSet    The set, which receives the data.
 405
 406     [Return value]
 407
 408     sal_Bool                sal_True:  The data had been changed
 409                             sal_False: The data had not been changed
 410
 411     [Cross-reference]
 412
 413     <class SfxTabDialog>
 414 */
 415
 416 {
 417     const sal_uInt16 nFilterIdx = aFilterLb.GetSelectEntryPos();
 418
 419     // Set Filter
 420
 421     if ( LISTBOX_ENTRY_NOTFOUND  != nFilterIdx      &&
 422          nFilterIdx != aFilterLb.GetSavedValue()    &&
 423          aFilterLb.IsEnabled() )
 424     {
 425         bModified = sal_True;
 426         OSL_ENSURE( pItem, "No Item" );
 427         // is only possibly for user templates
 428         sal_uInt16 nMask = pItem->GetFilterList()[ (size_t)aFilterLb.GetEntryData( nFilterIdx ) ]->nFlags | SFXSTYLEBIT_USERDEF;
 429         pStyle->SetMask( nMask );
 430     }
 431     if(aAutoCB.IsVisible() &&
 432         aAutoCB.IsChecked() != aAutoCB.GetSavedValue())
 433     {
 434         rSet.Put(SfxBoolItem(SID_ATTR_AUTO_STYLE_UPDATE, aAutoCB.IsChecked()));
 435     }
 436
 437     return bModified;
 438 }
 439
 440 //-------------------------------------------------------------------------
 441
 442 void SfxManageStyleSheetPage::Reset( const SfxItemSet& /*rAttrSet*/ )
 443
 444 /*  [Description]
 445
 446     Handler to initialize the page with the initial data.
 447
 448     [Parameter]
 449
 450     const SfxItemSet &rAttrSet          The data set
 451
 452     [Cross-reference]
 453
 454     <class SfxTabDialog>
 455 */
 456
 457 {
 458     bModified = sal_False;
 459     String sCmp( pStyle->GetName() );
 460
 461     if ( sCmp != aName )
 462         pStyle->SetName( aName );
 463     aNameEd.SetText( aName );
 464
 465     if ( aFollowLb.IsEnabled() )
 466     {
 467         sCmp = pStyle->GetFollow();
 468
 469         if ( sCmp != aFollow )
 470             pStyle->SetFollow( aFollow );
 471
 472         if ( !aFollow.Len() )
 473             aFollowLb.SelectEntry( aName );
 474         else
 475             aFollowLb.SelectEntry( aFollow );
 476     }
 477
 478     if ( aBaseLb.IsEnabled() )
 479     {
 480         sCmp = pStyle->GetParent();
 481
 482         if ( sCmp != aParent )
 483             pStyle->SetParent( aParent );
 484
 485         if ( !aParent.Len() )
 486             aBaseLb.SelectEntry( String( SfxResId( STR_NONE ) ) );
 487         else
 488             aBaseLb.SelectEntry( aParent );
 489
 490         if ( String( SfxResId( STR_STANDARD ) ) == aName )
 491         {
 492             // the default template can not be linked
 493             aBaseFt.Disable();
 494             aBaseLb.Disable();
 495         }
 496     }
 497
 498     if ( aFilterLb.IsEnabled() )
 499     {
 500         sal_uInt16 nCmp = pStyle->GetMask();
 501
 502         if ( nCmp != nFlags )
 503             pStyle->SetMask( nFlags );
 504         aFilterLb.SelectEntryPos( aFilterLb.GetSavedValue() );
 505     }
 506 }
 507
 508 //-------------------------------------------------------------------------
 509
 510 SfxTabPage* SfxManageStyleSheetPage::Create( Window* pParent,
 511                                              const SfxItemSet &rAttrSet )
 512
 513 /*  [Description]
 514
 515     Factory for the creation of the page.
 516
 517     [Cross-reference]
 518
 519     <class SfxTabDialog>
 520 */
 521
 522 {
 523     return new SfxManageStyleSheetPage( pParent, rAttrSet );
 524 }
 525
 526 //-------------------------------------------------------------------------
 527
 528 void SfxManageStyleSheetPage::ActivatePage( const SfxItemSet& rSet)
 529
 530 /*  [Description]
 531
 532     ActivatePage handler of SfxTabDialog, is used for the the update of the
 533     descriptive text, since this might have changed through changes of data on
 534     other pages.
 535
 536     [Parameter]
 537
 538     const SfxItemSet&    the set for the exchange of data; is not used here.
 539
 540     [Cross-reference]
 541
 542     <SfxTabDialog::ActivatePage(const SfxItemSet &)>
 543 */
 544
 545 {
 546     SetDescriptionText_Impl();
 547
 548     // It is a style with auto update? (SW only)
 549     const SfxPoolItem* pPoolItem;
 550
 551     if ( SFX_ITEM_SET ==
 552          rSet.GetItemState( SID_ATTR_AUTO_STYLE_UPDATE, sal_False, &pPoolItem ) )
 553         aAutoCB.Check( ( (const SfxBoolItem*)pPoolItem )->GetValue() );
 554     aAutoCB.SaveValue();
 555 }
 556
 557 //-------------------------------------------------------------------------
 558
 559 int SfxManageStyleSheetPage::DeactivatePage( SfxItemSet* pItemSet )
 560
 561 /*  [Description]
 562
 563     DeactivatePage-handler of SfxTabDialog; data is set on the template, so
 564     that the correct inheritance on the other pages of the dialog is made.
 565     If an error occurs, leaving the page is prevented.
 566     [Parameter]
 567
 568     SfxItemSet*    the set for the exchange of data; is not used here.
 569
 570     [Cross-reference]
 571
 572     <SfxTabDialog::DeactivatePage(SfxItemSet*)>
 573 */
 574
 575 {
 576     int nRet = SfxTabPage::LEAVE_PAGE;
 577
 578     if ( aNameEd.IsModified() )
 579     {
 580         // By pressing <Enter> LoseFocus() is not trigged through StarView
 581         if ( aNameEd.HasFocus() )
 582             LoseFocusHdl( &aNameEd );
 583
 584         if ( !pStyle->SetName( aNameEd.GetText().EraseLeadingChars() ) )
 585         {
 586             InfoBox aBox( this, SfxResId( MSG_TABPAGE_INVALIDNAME ) );
 587             aBox.Execute();
 588             aNameEd.GrabFocus();
 589             aNameEd.SetSelection( Selection( SELECTION_MIN, SELECTION_MAX ) );
 590             return SfxTabPage::KEEP_PAGE;
 591         }
 592         bModified = sal_True;
 593     }
 594
 595     if ( pStyle->HasFollowSupport() && aFollowLb.IsEnabled() )
 596     {
 597         const String aFollowEntry( aFollowLb.GetSelectEntry() );
 598
 599         if ( pStyle->GetFollow() != aFollowEntry )
 600         {
 601             if ( !pStyle->SetFollow( aFollowEntry ) )
 602             {
 603                 InfoBox aBox( this, SfxResId( MSG_TABPAGE_INVALIDSTYLE ) );
 604                 aBox.Execute();
 605                 aFollowLb.GrabFocus();
 606                 return SfxTabPage::KEEP_PAGE;
 607             }
 608             bModified = sal_True;
 609         }
 610     }
 611
 612     if ( aBaseLb.IsEnabled() )
 613     {
 614         String aParentEntry( aBaseLb.GetSelectEntry() );
 615
 616         if ( String( SfxResId( STR_NONE ) ) == aParentEntry || aParentEntry == pStyle->GetName() )
 617             aParentEntry.Erase();
 618
 619         if ( pStyle->GetParent() != aParentEntry )
 620         {
 621             if ( !pStyle->SetParent( aParentEntry ) )
 622             {
 623                 InfoBox aBox( this, SfxResId( MSG_TABPAGE_INVALIDPARENT ) );
 624                 aBox.Execute();
 625                 aBaseLb.GrabFocus();
 626                 return SfxTabPage::KEEP_PAGE;
 627             }
 628             bModified = sal_True;
 629             nRet |= (int)SfxTabPage::REFRESH_SET;
 630         }
 631     }
 632
 633     if ( pItemSet )
 634         FillItemSet( *pItemSet );
 635
 636     return nRet;
 637 }
 638
 639 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */