toolkit/source/layout/vcl/wbutton.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$
  10  *
  11  * $Revision$
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #include "wrapper.hxx"
  33
  34 #include <com/sun/star/awt/PosSize.hpp>
  35 #include <com/sun/star/awt/XActionListener.hpp>
  36 #include <com/sun/star/awt/XButton.hpp>
  37 #include <com/sun/star/awt/XCheckBox.hpp>
  38 #include <com/sun/star/awt/XRadioButton.hpp>
  39 #include <com/sun/star/graphic/XGraphic.hpp>
  40 #include <cppuhelper/implbase1.hxx>
  41 #include <toolkit/awt/vclxwindow.hxx>
  42 #include <toolkit/awt/vclxwindows.hxx>
  43 #include <toolkit/helper/convert.hxx>
  44 #include <vcl/button.hxx>
  45 #include <vcl/event.hxx>
  46 #include <vcl/msgbox.hxx>
  47 #include <vcl/svapp.hxx>
  48 #include <vcl/window.hxx>
  49
  50 #include <list>
  51
  52 #include <layout/core/helper.hxx>
  53
  54 using namespace ::com::sun::star;
  55
  56 using rtl::OUString;
  57
  58 namespace layout
  59 {
  60
  61 class ImageImpl
  62 {
  63   public:
  64     uno::Reference< graphic::XGraphic > mxGraphic;
  65     ImageImpl( const char *pName )
  66         : mxGraphic( layoutimpl::loadGraphic( pName ) )
  67     {
  68         if ( !mxGraphic.is() )
  69         {
  70             DBG_ERROR1( "ERROR: failed to load image: `%s'\n", pName );
  71         }
  72     }
  73 };
  74
  75 Image::Image( const char *pName )
  76     : pImpl( new ImageImpl( pName ) )
  77 {
  78 }
  79
  80 Image::~Image()
  81 {
  82     delete pImpl;
  83 }
  84
  85 class ButtonImpl : public ControlImpl
  86                  , public ::cppu::WeakImplHelper1< awt::XActionListener >
  87 {
  88     Link maClickHdl;
  89
  90 public:
  91     uno::Reference< awt::XButton > mxButton;
  92     ButtonImpl( Context *context, const PeerHandle &peer, Window *window )
  93         : ControlImpl( context, peer, window )
  94         , mxButton( peer, uno::UNO_QUERY )
  95     {
  96         /* We have default action when clicked, always listen. */
  97         mxButton->addActionListener( this );
  98     }
  99
 100     ~ButtonImpl()
 101     {
 102     }
 103
 104     virtual void Click() { /* make me pure virtual? */ };
 105
 106     Link& GetClickHdl ()
 107     {
 108         return maClickHdl;
 109     }
 110
 111     virtual void SetClickHdl( Link const& link )
 112     {
 113         maClickHdl = link;
 114     }
 115
 116     void SAL_CALL disposing( lang::EventObject const& e )
 117         throw (uno::RuntimeException)
 118     {
 119         mxButton->removeActionListener( this );
 120         ControlImpl::disposing (e);
 121         mxButton.clear ();
 122     }
 123
 124     virtual void SAL_CALL actionPerformed( const awt::ActionEvent& )
 125         throw (uno::RuntimeException)
 126     {
 127         if ( !maClickHdl )
 128             Click();
 129         else
 130             maClickHdl.Call( static_cast<Window *>( mpWindow ) );
 131     }
 132
 133     bool SetModeImage( uno::Reference< graphic::XGraphic > xGraph )
 134     {
 135         setProperty( "Graphic", uno::Any( xGraph ) );
 136         return true;
 137     }
 138 };
 139
 140 Button::~Button ()
 141 {
 142 }
 143
 144 String Button::GetStandardText (sal_uInt16 button_type)
 145 {
 146     return ::Button::GetStandardText (button_type);
 147 }
 148
 149 void Button::SetText( OUString const& rStr )
 150 {
 151     if ( !getImpl().mxButton.is() )
 152         return;
 153     getImpl().mxButton->setLabel( rStr );
 154 }
 155
 156 void Button::SetClickHdl( const Link& link )
 157 {
 158     if (&getImpl () && getImpl().mxButton.is ())
 159         getImpl().SetClickHdl( link );
 160 }
 161
 162 Link& Button::GetClickHdl ()
 163 {
 164     return getImpl().GetClickHdl ();
 165 }
 166
 167 bool Button::SetModeImage (Image const& image)
 168 {
 169     return getImpl().SetModeImage (image.getImpl().mxGraphic);
 170 }
 171
 172 bool Button::SetModeImage (::Image const& image, BmpColorMode mode)
 173 {
 174     return GetButton ()->SetModeImage (image, mode);
 175 }
 176
 177 void Button::SetImageAlign( ImageAlign eAlign )
 178 {
 179     getImpl().setProperty( "ImageAlign", uno::Any( (sal_Int16) eAlign ) );
 180 }
 181
 182 void Button::Click()
 183 {
 184 }
 185
 186 IMPL_GET_IMPL( Button );
 187 IMPL_CONSTRUCTORS( Button, Control, "button" );
 188 IMPL_GET_WINDOW (Button);
 189
 190 class PushButtonImpl : public ButtonImpl
 191                  , public ::cppu::WeakImplHelper1< awt::XItemListener >
 192 {
 193     Link maToggleHdl;
 194 public:
 195     PushButtonImpl( Context *context, const PeerHandle &peer, Window *window )
 196         : ButtonImpl( context, peer, window )
 197     {
 198     }
 199
 200     void SetToggleHdl( const Link& link )
 201     {
 202         // XButton doesn't have an explicit event for Toggle. Anyway, it is a
 203         // superset of the clicks: all clicks, and explicit toggles
 204         if (!link && !!maToggleHdl)
 205             mxButton->removeActionListener( this );
 206         else if (!!link && !maToggleHdl)
 207             mxButton->addActionListener( this );
 208         maToggleHdl = link;
 209     }
 210     void SAL_CALL disposing( lang::EventObject const& e )
 211         throw (uno::RuntimeException)
 212     {
 213         ButtonImpl::disposing (e);
 214     }
 215     virtual void SAL_CALL actionPerformed( awt::ActionEvent const& e )
 216         throw (uno::RuntimeException)
 217     {
 218         ButtonImpl::actionPerformed( e );
 219         fireToggle();
 220     }
 221     virtual void SAL_CALL itemStateChanged( const awt::ItemEvent& )
 222         throw (uno::RuntimeException)
 223     {
 224         maToggleHdl.Call( static_cast<Window *>( mpWindow ) );
 225     }
 226     void fireToggle()
 227     {
 228         maToggleHdl.Call(  static_cast<Window *>( mpWindow ) );
 229     }
 230
 231 };
 232
 233 PushButton::~PushButton ()
 234 {
 235     SetToggleHdl (Link ());
 236 }
 237
 238 void PushButton::Check( bool bCheck )
 239 {
 240     getImpl().setProperty( "State", uno::Any( (sal_Int16) !!bCheck ) );
 241     // XButton doesn't have explicit toggle event
 242     getImpl().fireToggle();
 243 }
 244
 245 bool PushButton::IsChecked() const
 246 {
 247     return !!( getImpl().getProperty( "State" ).get< sal_Int16 >() );
 248 }
 249
 250 void PushButton::Toggle()
 251 {
 252     Check( true );
 253 }
 254
 255 void PushButton::SetToggleHdl( const Link& link )
 256 {
 257     if (&getImpl () && getImpl().mxButton.is ())
 258         getImpl().SetToggleHdl( link );
 259 }
 260
 261 IMPL_GET_IMPL( PushButton );
 262 IMPL_CONSTRUCTORS( PushButton, Button, "pushbutton" );
 263 IMPL_GET_WINDOW (PushButton);
 264
 265 class RadioButtonImpl : public ButtonImpl
 266                       , public ::cppu::WeakImplHelper1< awt::XItemListener >
 267 {
 268     Link maToggleHdl;
 269 public:
 270     uno::Reference< awt::XRadioButton > mxRadioButton;
 271     RadioButtonImpl( Context *context, const PeerHandle &peer, Window *window )
 272         : ButtonImpl( context, peer, window )
 273         , mxRadioButton( peer, uno::UNO_QUERY )
 274     {
 275     }
 276
 277     void Check( bool bCheck )
 278     {
 279         if ( !mxRadioButton.is() )
 280             return;
 281
 282 #if 1
 283         // Have setState fire item event for
 284         // RadioGroups::RadioGroup::itemStateChanged ()
 285         ::RadioButton *r = static_cast<RadioButton*>(mpWindow)->GetRadioButton ();
 286         bool state = r->IsRadioCheckEnabled ();
 287         r->EnableRadioCheck();
 288         mxRadioButton->setState( !!bCheck );
 289         r->EnableRadioCheck (state);
 290 #else
 291         mxRadioButton->setState( !!bCheck );
 292 #endif
 293         fireToggle();
 294     }
 295
 296     bool IsChecked()
 297     {
 298         if ( !mxRadioButton.is() )
 299             return false;
 300         return mxRadioButton->getState();
 301     }
 302
 303     void SetToggleHdl( const Link& link )
 304     {
 305         if (!link && !!maToggleHdl)
 306             mxRadioButton->removeItemListener( this );
 307         else if (!!link && !maToggleHdl)
 308             mxRadioButton->addItemListener( this );
 309         maToggleHdl = link;
 310     }
 311
 312     inline void fireToggle()
 313     {
 314         maToggleHdl.Call(  static_cast<Window *>( mpWindow ) );
 315     }
 316
 317     virtual void SetClickHdl( const Link& link )
 318     {
 319         // Keep RadioGroups::RadioGroup's actionListener at HEAD
 320         // of list.  This way, it can handle RadioGroup's button
 321         // states before all other callbacks and make sure the
 322         // client code has the right state.
 323
 324         // IWBN to add an XRadioButton2 and layout::VCLXRadioButton
 325         // with {get,set}RadioGroup() (and a "radiogroup" property
 326         // even) and handle the grouping here in RadioButtonImpl.
 327         uno::Reference< uno::XInterface > x = static_cast<VCLXRadioButton*> (mpWindow->GetVCLXWindow ())->getFirstActionListener ();
 328         uno::Reference< awt::XActionListener > a = uno::Reference< awt::XActionListener> (x ,uno::UNO_QUERY );
 329         mxButton->removeActionListener (a);
 330         ButtonImpl::SetClickHdl (link);
 331         mxButton->addActionListener (a);
 332     }
 333
 334     void SAL_CALL disposing( lang::EventObject const& e )
 335         throw (uno::RuntimeException)
 336     {
 337         ButtonImpl::disposing (e);
 338     }
 339
 340     virtual void SAL_CALL itemStateChanged( const awt::ItemEvent& )
 341         throw (uno::RuntimeException)
 342     {
 343         maToggleHdl.Call( static_cast<Window *>( mpWindow ) );
 344     }
 345 };
 346
 347 RadioButton::~RadioButton ()
 348 {
 349     SetToggleHdl (Link ());
 350 }
 351
 352 void RadioButton::Check( bool bCheck )
 353 {
 354     getImpl().Check( bCheck );
 355 }
 356
 357 bool RadioButton::IsChecked() const
 358 {
 359     return getImpl().IsChecked();
 360 }
 361
 362 void RadioButton::SetToggleHdl( const Link& link )
 363 {
 364     if (&getImpl () && getImpl().mxRadioButton.is ())
 365         getImpl().SetToggleHdl( link );
 366 }
 367
 368 IMPL_GET_IMPL( RadioButton );
 369 IMPL_GET_WINDOW( RadioButton );
 370 IMPL_GET_VCLXWINDOW( RadioButton );
 371 IMPL_CONSTRUCTORS( RadioButton, Button, "radiobutton" );
 372
 373 class CheckBoxImpl : public ButtonImpl
 374                  , public ::cppu::WeakImplHelper1< awt::XItemListener >
 375 {
 376     Link maToggleHdl;
 377   public:
 378     uno::Reference< awt::XCheckBox > mxCheckBox;
 379     CheckBoxImpl( Context *context, const PeerHandle &peer, Window *window )
 380         : ButtonImpl( context, peer, window )
 381         , mxCheckBox( peer, uno::UNO_QUERY )
 382     {
 383     }
 384
 385     void SetToggleHdl( const Link& link )
 386     {
 387         if (!link && !!maToggleHdl)
 388             mxCheckBox->removeItemListener( this );
 389         else if (!!link && !maToggleHdl)
 390             mxCheckBox->addItemListener( this );
 391         maToggleHdl = link;
 392     }
 393     void SAL_CALL disposing( lang::EventObject const& e )
 394         throw (uno::RuntimeException)
 395     {
 396         ButtonImpl::disposing (e);
 397     }
 398     virtual void SAL_CALL itemStateChanged( const awt::ItemEvent& )
 399         throw (uno::RuntimeException)
 400     {
 401         maToggleHdl.Call( static_cast<Window *>( mpWindow ) );
 402     }
 403 };
 404
 405 CheckBox::~CheckBox ()
 406 {
 407     SetToggleHdl (Link ());
 408 }
 409
 410 void CheckBox::Check( bool bCheck )
 411 {
 412     if ( !getImpl().mxCheckBox.is() )
 413         return;
 414     getImpl().mxCheckBox->setState( !!bCheck );
 415 }
 416
 417 bool CheckBox::IsChecked() const
 418 {
 419     if ( !getImpl().mxCheckBox.is() )
 420         return false;
 421     return getImpl().mxCheckBox->getState() != 0;
 422 }
 423
 424 void CheckBox::SetToggleHdl( const Link& link )
 425 {
 426     if (&getImpl () && getImpl().mxCheckBox.is ())
 427         getImpl().SetToggleHdl( link );
 428 }
 429
 430 IMPL_GET_IMPL( CheckBox );
 431 IMPL_CONSTRUCTORS( CheckBox, Button, "checkbox" );
 432
 433 #define BUTTON_IMPL(t, parent, response) \
 434     class t##Impl : public parent##Impl \
 435     { \
 436     public: \
 437         t##Impl( Context *context, PeerHandle const& peer, Window *window ) \
 438             : parent##Impl( context, peer, window ) \
 439         { \
 440         } \
 441         void Click() \
 442         { \
 443             if (Dialog *d = static_cast<Dialog *> (mpCtx)) \
 444                 d->EndDialog( response ); \
 445         } \
 446     }
 447
 448 /* Common button types currently unavailable in OOo: */
 449 /* mpReset */
 450 /* mpApply */
 451 /* mpAction */
 452 #define RET_RESET 6
 453 #define RET_APPLY 7
 454 #define BUTTONID_RESET RET_RESET
 455 #define BUTTONID_APPLY RET_APPLY
 456
 457 BUTTON_IMPL( OKButton, PushButton, BUTTONID_OK );
 458 BUTTON_IMPL( CancelButton, PushButton, BUTTONID_CANCEL );
 459 BUTTON_IMPL( YesButton, PushButton, BUTTONID_YES );
 460 BUTTON_IMPL( NoButton, PushButton, BUTTONID_NO );
 461 BUTTON_IMPL( RetryButton, PushButton, BUTTONID_RETRY );
 462 BUTTON_IMPL( IgnoreButton, PushButton, BUTTONID_IGNORE );
 463 BUTTON_IMPL( ResetButton, PushButton, BUTTONID_RESET );
 464 BUTTON_IMPL( ApplyButton, PushButton, BUTTONID_APPLY ); /* Deprecated? */
 465 BUTTON_IMPL( HelpButton, PushButton, BUTTONID_HELP );
 466
 467 IMPL_CONSTRUCTORS( OKButton, PushButton, "okbutton" );
 468 IMPL_CONSTRUCTORS( CancelButton, PushButton, "cancelbutton" );
 469 IMPL_CONSTRUCTORS( YesButton, PushButton, "yesbutton" );
 470 IMPL_CONSTRUCTORS( NoButton, PushButton, "nobutton" );
 471 IMPL_CONSTRUCTORS( RetryButton, PushButton, "retrybutton" );
 472 IMPL_CONSTRUCTORS( IgnoreButton, PushButton, "ignorebutton" );
 473 IMPL_CONSTRUCTORS( ResetButton, PushButton, "resetbutton" );
 474 IMPL_CONSTRUCTORS( ApplyButton, PushButton, "applybutton" );  /* Deprecated? */
 475 IMPL_CONSTRUCTORS( HelpButton, PushButton, "helpbutton" );
 476
 477 IMPL_IMPL (ImageButton, PushButton)
 478
 479
 480 IMPL_CONSTRUCTORS( ImageButton, PushButton, "imagebutton" );
 481
 482 class AdvancedButtonImpl : public PushButtonImpl
 483 {
 484 protected:
 485     bool bAdvancedMode;
 486     std::list< Window*> maAdvanced;
 487     std::list< Window*> maSimple;
 488
 489 public:
 490     rtl::OUString mAdvancedLabel;
 491     rtl::OUString mSimpleLabel;
 492
 493 protected:
 494     Window* Remove( std::list< Window*> lst, Window* w )
 495     {
 496         for ( std::list< Window*>::iterator it = maAdvanced.begin();
 497               it != maAdvanced.end(); it++ )
 498             if ( *it == w )
 499             {
 500                 lst.erase( it );
 501                 return *it;
 502             }
 503         return 0;
 504     }
 505
 506 public:
 507     AdvancedButtonImpl( Context *context, PeerHandle const& peer, Window *window )
 508         : PushButtonImpl( context, peer, window )
 509         , bAdvancedMode( false )
 510           // TODO: i18n
 511           // Button::GetStandardText( BUTTON_ADVANCED );
 512           // Button::GetStandardText( BUTTON_SIMPLE );
 513         , mAdvancedLabel( rtl::OUString::createFromAscii( "Advanced..." ) )
 514         , mSimpleLabel( rtl::OUString::createFromAscii( "Simple..." ) )
 515     {
 516     }
 517     void Click()
 518     {
 519         bAdvancedMode = !bAdvancedMode;
 520         if ( bAdvancedMode )
 521             advancedMode();
 522         else
 523             simpleMode();
 524     }
 525     void setAlign ()
 526     {
 527         ::PushButton *b = static_cast<PushButton*> (mpWindow)->GetPushButton ();
 528         b->SetSymbolAlign (SYMBOLALIGN_RIGHT);
 529         b->SetSmallSymbol ();
 530         //mpWindow->SetStyle (mpWindow->GetStyle() | WB_CENTER);
 531     }
 532     void advancedMode()
 533     {
 534         ::PushButton *b = static_cast<PushButton*> (mpWindow)->GetPushButton ();
 535         b->SetSymbol (SYMBOL_PAGEUP);
 536         setAlign ();
 537         if (mSimpleLabel.getLength ())
 538             b->SetText (mSimpleLabel);
 539         for ( std::list< Window*>::iterator it = maAdvanced.begin();
 540               it != maAdvanced.end(); it++ )
 541             ( *it )->Show();
 542         for ( std::list< Window*>::iterator it = maSimple.begin();
 543               it != maSimple.end(); it++ )
 544             ( *it )->Hide();
 545
 546         redraw ();
 547     }
 548     void simpleMode()
 549     {
 550         //mxButton->setLabel( mSimpleLabel );
 551         ::PushButton *b = static_cast<PushButton*> (mpWindow)->GetPushButton ();
 552         b->SetSymbol (SYMBOL_PAGEDOWN);
 553         if (mAdvancedLabel.getLength ())
 554             b->SetText (mAdvancedLabel);
 555         setAlign ();
 556         for ( std::list< Window*>::iterator it = maAdvanced.begin();
 557               it != maAdvanced.end(); it++ )
 558             ( *it )->Hide();
 559         for ( std::list< Window*>::iterator it = maSimple.begin();
 560               it != maSimple.end(); it++ )
 561             ( *it )->Show();
 562
 563         redraw (true);
 564     }
 565     void AddAdvanced( Window* w )
 566     {
 567         maAdvanced.push_back( w );
 568         if ( !bAdvancedMode )
 569             w->Hide();
 570     }
 571     void AddSimple( Window* w )
 572     {
 573         maSimple.push_back( w );
 574         if ( bAdvancedMode )
 575             w->Hide();
 576     }
 577     void RemoveAdvanced( Window* w )
 578     {
 579         Remove( maAdvanced, w );
 580     }
 581     void RemoveSimple( Window* w )
 582     {
 583         Remove( maSimple, w );
 584     }
 585 };
 586
 587 void AdvancedButton::AddAdvanced( Window* w )
 588 {
 589     getImpl().AddAdvanced( w );
 590 }
 591
 592 void AdvancedButton::AddSimple( Window* w )
 593 {
 594     getImpl().AddSimple( w );
 595 }
 596
 597 void AdvancedButton::RemoveAdvanced( Window* w )
 598 {
 599     getImpl().RemoveAdvanced( w );
 600 }
 601
 602 void AdvancedButton::RemoveSimple( Window* w )
 603 {
 604     getImpl().RemoveSimple( w );
 605 }
 606
 607 void AdvancedButton::SetAdvancedText (rtl::OUString const& text)
 608 {
 609     if (text.getLength ())
 610         getImpl ().mAdvancedLabel = text;
 611 }
 612
 613 void AdvancedButton::SetSimpleText (rtl::OUString const& text)
 614 {
 615     if (text.getLength ())
 616         getImpl ().mSimpleLabel = text;
 617 }
 618
 619 rtl::OUString AdvancedButton::GetAdvancedText () const
 620 {
 621     return getImpl ().mAdvancedLabel;
 622 }
 623
 624 rtl::OUString AdvancedButton::GetSimpleText () const
 625 {
 626     return getImpl ().mSimpleLabel;
 627 }
 628
 629 void AdvancedButton::SetDelta (int)
 630 {
 631 }
 632
 633 IMPL_CONSTRUCTORS_BODY( AdvancedButton, PushButton, "advancedbutton", getImpl().simpleMode () );
 634 IMPL_GET_IMPL( AdvancedButton );
 635
 636
 637 class MoreButtonImpl : public AdvancedButtonImpl
 638 {
 639 public:
 640     MoreButtonImpl( Context *context, PeerHandle const& peer, Window *window )
 641         : AdvancedButtonImpl( context, peer, window)
 642     {
 643         mSimpleLabel = Button::GetStandardText( BUTTON_MORE );
 644         mAdvancedLabel = Button::GetStandardText( BUTTON_LESS );
 645     }
 646     void AddWindow( Window* w ) { AddAdvanced( w ); }
 647     void RemoveWindow( Window* w ) { RemoveAdvanced( w ); }
 648 };
 649
 650 // TODO
 651 //BUTTON_IMPL( MoreButton, PushButton, 0 );
 652 IMPL_CONSTRUCTORS_BODY( MoreButton, AdvancedButton, "morebutton", getImpl().simpleMode () );
 653 IMPL_GET_IMPL( MoreButton );
 654
 655 void MoreButton::AddWindow( Window* w )
 656 {
 657     getImpl().AddWindow( w );
 658 }
 659
 660 void MoreButton::RemoveWindow( Window* w )
 661 {
 662     getImpl().RemoveWindow( w );
 663 }
 664
 665 void MoreButton::SetMoreText (rtl::OUString const& text)
 666 {
 667     SetAdvancedText (text);
 668 }
 669
 670 void MoreButton::SetLessText (rtl::OUString const& text)
 671 {
 672     SetSimpleText (text);
 673 }
 674
 675 rtl::OUString MoreButton::GetMoreText () const
 676 {
 677     return GetAdvancedText ();
 678 }
 679
 680 rtl::OUString MoreButton::GetLessText () const
 681 {
 682     return GetSimpleText ();
 683 }
 684
 685 } // namespace layout