vcl/source/window/btndlg.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: btndlg.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_vcl.hxx"
  33
  34 #include <tools/ref.hxx>
  35 #include <tools/debug.hxx>
  36 #include <vcl/svdata.hxx>
  37 #include <vcl/button.hxx>
  38 #include <vcl/btndlg.hxx>
  39
  40 #ifndef _SV_RC_H
  41 #include <tools/rc.h>
  42 #endif
  43
  44
  45
  46 // =======================================================================
  47
  48 struct ImplBtnDlgItem
  49 {
  50     USHORT                              mnId;
  51     BOOL                                mbOwnButton;
  52     BOOL                                mbDummyAlign;
  53     long                                mnSepSize;
  54     PushButton*                 mpPushButton;
  55 };
  56
  57 DECLARE_LIST( ImplBtnDlgItemList, ImplBtnDlgItem* )
  58
  59 // =======================================================================
  60
  61 void ButtonDialog::ImplInitButtonDialogData()
  62 {
  63     mpItemList                          = new ImplBtnDlgItemList( 8, 8 );
  64     mnButtonSize                        = 0;
  65     mnCurButtonId                       = 0;
  66     mnFocusButtonId             = BUTTONDIALOG_BUTTON_NOTFOUND;
  67     mbFormat                            = TRUE;
  68 }
  69
  70 // -----------------------------------------------------------------------
  71
  72 ButtonDialog::ButtonDialog( WindowType nType ) :
  73     Dialog( nType )
  74 {
  75     ImplInitButtonDialogData();
  76 }
  77
  78 // -----------------------------------------------------------------------
  79
  80 ButtonDialog::ButtonDialog( Window* pParent, WinBits nStyle ) :
  81     Dialog( WINDOW_BUTTONDIALOG )
  82 {
  83     ImplInitButtonDialogData();
  84     ImplInit( pParent, nStyle );
  85 }
  86
  87 // -----------------------------------------------------------------------
  88
  89 ButtonDialog::ButtonDialog( Window* pParent, const ResId& rResId ) :
  90     Dialog( WINDOW_BUTTONDIALOG )
  91 {
  92     ImplInitButtonDialogData();
  93     rResId.SetRT( RSC_DIALOG );         // !!!!!!!!!! RSC_BUTTONDIALOG !!!!!!!!
  94     ImplInit( pParent, ImplInitRes( rResId ) );
  95     ImplLoadRes( rResId );
  96 }
  97
  98 // -----------------------------------------------------------------------
  99
 100 ButtonDialog::~ButtonDialog()
 101 {
 102     ImplBtnDlgItem* pItem = mpItemList->First();
 103     while ( pItem )
 104     {
 105         if ( pItem->mpPushButton && pItem->mbOwnButton )
 106             delete pItem->mpPushButton;
 107         delete pItem;
 108         pItem = mpItemList->Next();
 109     }
 110
 111     delete mpItemList;
 112 }
 113
 114 // -----------------------------------------------------------------------
 115
 116 PushButton* ButtonDialog::ImplCreatePushButton( USHORT nBtnFlags )
 117 {
 118     PushButton* pBtn;
 119     WinBits     nStyle = 0;
 120
 121     if ( nBtnFlags & BUTTONDIALOG_DEFBUTTON )
 122         nStyle |= WB_DEFBUTTON;
 123     if ( nBtnFlags & BUTTONDIALOG_CANCELBUTTON )
 124         pBtn = new CancelButton( this, nStyle );
 125     else if ( nBtnFlags & BUTTONDIALOG_OKBUTTON )
 126         pBtn = new OKButton( this, nStyle );
 127     else if ( nBtnFlags & BUTTONDIALOG_HELPBUTTON )
 128         pBtn = new HelpButton( this, nStyle );
 129     else
 130         pBtn = new PushButton( this, nStyle );
 131
 132     if ( !(nBtnFlags & BUTTONDIALOG_HELPBUTTON) )
 133         pBtn->SetClickHdl( LINK( this, ButtonDialog, ImplClickHdl ) );
 134
 135     return pBtn;
 136 }
 137
 138 // -----------------------------------------------------------------------
 139
 140 ImplBtnDlgItem* ButtonDialog::ImplGetItem( USHORT nId ) const
 141 {
 142     ImplBtnDlgItem* pItem = mpItemList->First();
 143     while ( pItem )
 144     {
 145         if ( pItem->mnId == nId )
 146             return pItem;
 147
 148         pItem = mpItemList->Next();
 149     }
 150
 151     return NULL;
 152 }
 153
 154 // -----------------------------------------------------------------------
 155
 156 long ButtonDialog::ImplGetButtonSize()
 157 {
 158     if ( !mbFormat )
 159         return mnButtonSize;
 160
 161     // Calculate ButtonSize
 162     long        nLastSepSize = 0;
 163     long        nSepSize = 0;
 164     long        nButtonCount = 0;
 165     maCtrlSize = Size( IMPL_MINSIZE_BUTTON_WIDTH, IMPL_MINSIZE_BUTTON_HEIGHT );
 166     ImplBtnDlgItem* pItem = mpItemList->First();
 167     while ( pItem )
 168     {
 169         nSepSize += nLastSepSize;
 170
 171         long nTxtWidth = pItem->mpPushButton->GetCtrlTextWidth( pItem->mpPushButton->GetText() );
 172         nTxtWidth += IMPL_EXTRA_BUTTON_WIDTH;
 173         if ( nTxtWidth > maCtrlSize.Width() )
 174             maCtrlSize.Width() = nTxtWidth;
 175         long nTxtHeight = pItem->mpPushButton->GetTextHeight();
 176         nTxtHeight += IMPL_EXTRA_BUTTON_HEIGHT;
 177         if ( nTxtHeight > maCtrlSize.Height() )
 178             maCtrlSize.Height() = nTxtHeight;
 179
 180         nSepSize += pItem->mnSepSize;
 181
 182         if ( GetStyle() & WB_HORZ )
 183             nLastSepSize = IMPL_SEP_BUTTON_X;
 184         else
 185             nLastSepSize = IMPL_SEP_BUTTON_Y;
 186
 187         nButtonCount++;
 188
 189         pItem = mpItemList->Next();
 190     }
 191
 192     if ( GetStyle() & WB_HORZ )
 193         mnButtonSize  = nSepSize + (nButtonCount*maCtrlSize.Width());
 194     else
 195         mnButtonSize = nSepSize + (nButtonCount*maCtrlSize.Height());
 196
 197     return mnButtonSize;
 198 }
 199
 200 // -----------------------------------------------------------------------
 201
 202 void ButtonDialog::ImplPosControls()
 203 {
 204     if ( !mbFormat )
 205         return;
 206
 207     // Create PushButtons and determine Sizes
 208     ImplGetButtonSize();
 209
 210     // determine dialog size
 211     ImplBtnDlgItem* pItem;
 212     Size                        aDlgSize = maPageSize;
 213     long                        nX;
 214     long                        nY;
 215     if ( GetStyle() & WB_HORZ )
 216     {
 217         if ( mnButtonSize+(IMPL_DIALOG_OFFSET*2) > aDlgSize.Width() )
 218             aDlgSize.Width() = mnButtonSize+(IMPL_DIALOG_OFFSET*2);
 219         if ( GetStyle() & WB_LEFT )
 220             nX = IMPL_DIALOG_OFFSET;
 221         else if ( GetStyle() & WB_RIGHT )
 222             nX = aDlgSize.Width()-mnButtonSize-IMPL_DIALOG_OFFSET;
 223         else
 224             nX = (aDlgSize.Width()-mnButtonSize)/2;
 225
 226         aDlgSize.Height() += IMPL_DIALOG_OFFSET+maCtrlSize.Height();
 227         nY = aDlgSize.Height()-maCtrlSize.Height()-IMPL_DIALOG_OFFSET;
 228     }
 229     else
 230     {
 231         if ( mnButtonSize+(IMPL_DIALOG_OFFSET*2) > aDlgSize.Height() )
 232             aDlgSize.Height() = mnButtonSize+(IMPL_DIALOG_OFFSET*2);
 233         if ( GetStyle() & WB_BOTTOM )
 234             nY = aDlgSize.Height()-mnButtonSize-IMPL_DIALOG_OFFSET;
 235         else if ( GetStyle() & WB_VCENTER )
 236             nY = (aDlgSize.Height()-mnButtonSize)/2;
 237         else
 238             nY = IMPL_DIALOG_OFFSET;
 239
 240         aDlgSize.Width() += IMPL_DIALOG_OFFSET+maCtrlSize.Width();
 241         nX = aDlgSize.Width()-maCtrlSize.Width()-IMPL_DIALOG_OFFSET;
 242     }
 243
 244     // Arrange PushButtons
 245     pItem = mpItemList->First();
 246     while ( pItem )
 247     {
 248         if ( GetStyle() & WB_HORZ )
 249             nX += pItem->mnSepSize;
 250         else
 251             nY += pItem->mnSepSize;
 252         pItem->mpPushButton->SetPosSizePixel( Point( nX, nY ), maCtrlSize );
 253         pItem->mpPushButton->Show();
 254         if ( GetStyle() & WB_HORZ )
 255             nX += maCtrlSize.Width()+IMPL_SEP_BUTTON_X;
 256         else
 257             nY += maCtrlSize.Height()+IMPL_SEP_BUTTON_Y;
 258
 259         pItem = mpItemList->Next();
 260     }
 261
 262     SetOutputSizePixel( aDlgSize );
 263
 264     mbFormat = FALSE;
 265 }
 266
 267 // -----------------------------------------------------------------------
 268
 269 IMPL_LINK( ButtonDialog, ImplClickHdl, PushButton*, pBtn )
 270 {
 271     ImplBtnDlgItem* pItem = mpItemList->First();
 272     while ( pItem )
 273     {
 274         if ( pItem->mpPushButton == pBtn )
 275         {
 276             mnCurButtonId = pItem->mnId;
 277             Click();
 278             break;
 279         }
 280
 281         pItem = mpItemList->Next();
 282     }
 283
 284     return 0;
 285 }
 286
 287 // -----------------------------------------------------------------------
 288
 289 void ButtonDialog::Resize()
 290 {
 291 }
 292
 293 // -----------------------------------------------------------------------
 294
 295 void ButtonDialog::StateChanged( StateChangedType nType )
 296 {
 297     if ( nType == STATE_CHANGE_INITSHOW )
 298     {
 299         ImplPosControls();
 300
 301         // Focus evt. auf den entsprechenden Button setzen
 302         if ( mnFocusButtonId != BUTTONDIALOG_BUTTON_NOTFOUND )
 303         {
 304             ImplBtnDlgItem* pItem = mpItemList->First();
 305             while ( pItem )
 306             {
 307                 if ( pItem->mnId == mnFocusButtonId )
 308                 {
 309                     if ( pItem->mpPushButton->IsVisible() )
 310                         pItem->mpPushButton->GrabFocus();
 311                     break;
 312                 }
 313
 314                 pItem = mpItemList->Next();
 315             }
 316         }
 317     }
 318
 319     Dialog::StateChanged( nType );
 320 }
 321
 322 // -----------------------------------------------------------------------
 323
 324 void ButtonDialog::Click()
 325 {
 326     if ( !maClickHdl )
 327     {
 328         if ( IsInExecute() )
 329             EndDialog( GetCurButtonId() );
 330     }
 331     else
 332         maClickHdl.Call( this );
 333 }
 334
 335 // -----------------------------------------------------------------------
 336
 337 void ButtonDialog::AddButton( const XubString& rText, USHORT nId,
 338                               USHORT nBtnFlags, long nSepPixel )
 339 {
 340     // PageItem anlegen
 341     ImplBtnDlgItem* pItem       = new ImplBtnDlgItem;
 342     pItem->mnId                         = nId;
 343     pItem->mbOwnButton          = TRUE;
 344     pItem->mnSepSize            = nSepPixel;
 345     pItem->mpPushButton         = ImplCreatePushButton( nBtnFlags );
 346     if ( rText.Len() )
 347         pItem->mpPushButton->SetText( rText );
 348
 349     // In die Liste eintragen
 350     mpItemList->Insert( pItem, LIST_APPEND );
 351
 352     if ( nBtnFlags & BUTTONDIALOG_FOCUSBUTTON )
 353         mnFocusButtonId = nId;
 354
 355     mbFormat = TRUE;
 356 }
 357
 358 // -----------------------------------------------------------------------
 359
 360 void ButtonDialog::AddButton( StandardButtonType eType, USHORT nId,
 361                               USHORT nBtnFlags, long nSepPixel )
 362 {
 363     // PageItem anlegen
 364     ImplBtnDlgItem* pItem       = new ImplBtnDlgItem;
 365     pItem->mnId                         = nId;
 366     pItem->mbOwnButton          = TRUE;
 367     pItem->mnSepSize            = nSepPixel;
 368
 369     if ( eType == BUTTON_OK )
 370         nBtnFlags |= BUTTONDIALOG_OKBUTTON;
 371     else if ( eType == BUTTON_HELP )
 372         nBtnFlags |= BUTTONDIALOG_HELPBUTTON;
 373     else if ( (eType == BUTTON_CANCEL) || (eType == BUTTON_CLOSE) )
 374         nBtnFlags |= BUTTONDIALOG_CANCELBUTTON;
 375     pItem->mpPushButton = ImplCreatePushButton( nBtnFlags );
 376
 377     // Standard-Buttons have the right text already
 378     if ( !((eType == BUTTON_OK)         && (pItem->mpPushButton->GetType() == WINDOW_OKBUTTON)) ||
 379          !((eType == BUTTON_CANCEL) && (pItem->mpPushButton->GetType() == WINDOW_CANCELBUTTON)) ||
 380          !((eType == BUTTON_HELP)       && (pItem->mpPushButton->GetType() == WINDOW_HELPBUTTON)) )
 381     {
 382         pItem->mpPushButton->SetText( Button::GetStandardText( eType ) );
 383         pItem->mpPushButton->SetHelpText( Button::GetStandardHelpText( eType ) );
 384     }
 385
 386     if ( nBtnFlags & BUTTONDIALOG_FOCUSBUTTON )
 387         mnFocusButtonId = nId;
 388
 389     // In die Liste eintragen
 390     mpItemList->Insert( pItem, LIST_APPEND );
 391
 392     mbFormat = TRUE;
 393 }
 394
 395 // -----------------------------------------------------------------------
 396
 397 void ButtonDialog::AddButton( PushButton* pBtn, USHORT nId,
 398                               USHORT nBtnFlags, long nSepPixel )
 399 {
 400     // PageItem anlegen
 401     ImplBtnDlgItem* pItem       = new ImplBtnDlgItem;
 402     pItem->mnId                         = nId;
 403     pItem->mbOwnButton          = FALSE;
 404     pItem->mnSepSize            = nSepPixel;
 405     pItem->mpPushButton         = pBtn;
 406
 407     if ( nBtnFlags & BUTTONDIALOG_FOCUSBUTTON )
 408         mnFocusButtonId = nId;
 409
 410     // In die View-Liste eintragen
 411     mpItemList->Insert( pItem, LIST_APPEND );
 412
 413     mbFormat = TRUE;
 414 }
 415
 416 // -----------------------------------------------------------------------
 417
 418 void ButtonDialog::RemoveButton( USHORT nId )
 419 {
 420     ImplBtnDlgItem* pItem = mpItemList->First();
 421     while ( pItem )
 422     {
 423         if ( pItem->mnId == nId )
 424         {
 425             pItem->mpPushButton->Hide();
 426             if ( pItem->mbOwnButton )
 427                 delete pItem->mpPushButton;
 428             delete pItem;
 429             mpItemList->Remove();
 430             mbFormat = TRUE;
 431             break;
 432         }
 433
 434         pItem = mpItemList->Next();
 435     }
 436
 437     DBG_ERRORFILE( "ButtonDialog::RemoveButton(): ButtonId invalid" );
 438 }
 439
 440 // -----------------------------------------------------------------------
 441
 442 void ButtonDialog::Clear()
 443 {
 444     ImplBtnDlgItem* pItem = mpItemList->First();
 445     while ( pItem )
 446     {
 447         pItem->mpPushButton->Hide();
 448         if ( pItem->mbOwnButton )
 449             delete pItem->mpPushButton;
 450         delete pItem;
 451         pItem = mpItemList->Next();
 452     }
 453
 454     mpItemList->Clear();
 455     mbFormat = TRUE;
 456 }
 457
 458 // -----------------------------------------------------------------------
 459
 460 USHORT ButtonDialog::GetButtonCount() const
 461 {
 462     return (USHORT)mpItemList->Count();
 463 }
 464
 465 // -----------------------------------------------------------------------
 466
 467 USHORT ButtonDialog::GetButtonId( USHORT nButton ) const
 468 {
 469     if ( nButton < mpItemList->Count() )
 470         return (USHORT)mpItemList->GetObject( nButton )->mnId;
 471     else
 472         return BUTTONDIALOG_BUTTON_NOTFOUND;
 473 }
 474
 475 // -----------------------------------------------------------------------
 476
 477 PushButton* ButtonDialog::GetPushButton( USHORT nId ) const
 478 {
 479     ImplBtnDlgItem* pItem = ImplGetItem( nId );
 480
 481     if ( pItem )
 482         return pItem->mpPushButton;
 483     else
 484         return NULL;
 485 }
 486
 487 // -----------------------------------------------------------------------
 488
 489 void ButtonDialog::SetButtonText( USHORT nId, const XubString& rText )
 490 {
 491     ImplBtnDlgItem* pItem = ImplGetItem( nId );
 492
 493     if ( pItem )
 494     {
 495         pItem->mpPushButton->SetText( rText );
 496         mbFormat = TRUE;
 497     }
 498 }
 499
 500 // -----------------------------------------------------------------------
 501
 502 XubString ButtonDialog::GetButtonText( USHORT nId ) const
 503 {
 504     ImplBtnDlgItem* pItem = ImplGetItem( nId );
 505
 506     if ( pItem )
 507         return pItem->mpPushButton->GetText();
 508     else
 509         return ImplGetSVEmptyStr();
 510 }
 511
 512 // -----------------------------------------------------------------------
 513
 514 void ButtonDialog::SetButtonHelpText( USHORT nId, const XubString& rText )
 515 {
 516     ImplBtnDlgItem* pItem = ImplGetItem( nId );
 517
 518     if ( pItem )
 519         pItem->mpPushButton->SetHelpText( rText );
 520 }
 521
 522 // -----------------------------------------------------------------------
 523
 524 XubString ButtonDialog::GetButtonHelpText( USHORT nId ) const
 525 {
 526     ImplBtnDlgItem* pItem = ImplGetItem( nId );
 527
 528     if ( pItem )
 529         return pItem->mpPushButton->GetHelpText();
 530     else
 531         return ImplGetSVEmptyStr();
 532 }
 533
 534 // -----------------------------------------------------------------------
 535
 536 void ButtonDialog::SetButtonHelpId( USHORT nId, ULONG nHelpId )
 537 {
 538     ImplBtnDlgItem* pItem = ImplGetItem( nId );
 539
 540     if ( pItem )
 541         pItem->mpPushButton->SetHelpId( nHelpId );
 542 }
 543
 544 // -----------------------------------------------------------------------
 545
 546 ULONG ButtonDialog::GetButtonHelpId( USHORT nId ) const
 547 {
 548     ImplBtnDlgItem* pItem = ImplGetItem( nId );
 549
 550     if ( pItem )
 551         return pItem->mpPushButton->GetHelpId();
 552     else
 553         return 0;
 554 }