UnoControls/source/inc/progressmonitor.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef _UNOCONTROLS_PROGRESSMONITOR_CTRL_HXX
  21 #define _UNOCONTROLS_PROGRESSMONITOR_CTRL_HXX
  22
  23 #include <com/sun/star/awt/XFileDialog.hpp>
  24 #include <com/sun/star/awt/XTextComponent.hpp>
  25 #include <com/sun/star/awt/XListBox.hpp>
  26 #include <com/sun/star/awt/XProgressMonitor.hpp>
  27 #include <com/sun/star/awt/TextAlign.hpp>
  28 #include <com/sun/star/awt/XScrollBar.hpp>
  29 #include <com/sun/star/awt/XVclContainerPeer.hpp>
  30 #include <com/sun/star/awt/XTabControllerModel.hpp>
  31 #include <com/sun/star/awt/XMessageBox.hpp>
  32 #include <com/sun/star/awt/XTextEditField.hpp>
  33 #include <com/sun/star/awt/Style.hpp>
  34 #include <com/sun/star/awt/XTimeField.hpp>
  35 #include <com/sun/star/awt/XVclWindowPeer.hpp>
  36 #include <com/sun/star/awt/XControlModel.hpp>
  37 #include <com/sun/star/awt/XSpinField.hpp>
  38 #include <com/sun/star/awt/XUnoControlContainer.hpp>
  39 #include <com/sun/star/awt/XTextLayoutConstrains.hpp>
  40 #include <com/sun/star/awt/XNumericField.hpp>
  41 #include <com/sun/star/awt/XButton.hpp>
  42 #include <com/sun/star/awt/XTextArea.hpp>
  43 #include <com/sun/star/awt/XImageButton.hpp>
  44 #include <com/sun/star/awt/XFixedText.hpp>
  45 #include <com/sun/star/awt/XControlContainer.hpp>
  46 #include <com/sun/star/awt/XDialog.hpp>
  47 #include <com/sun/star/awt/ScrollBarOrientation.hpp>
  48 #include <com/sun/star/awt/XRadioButton.hpp>
  49 #include <com/sun/star/awt/XCurrencyField.hpp>
  50 #include <com/sun/star/awt/XPatternField.hpp>
  51 #include <com/sun/star/awt/VclWindowPeerAttribute.hpp>
  52 #include <com/sun/star/awt/XTabController.hpp>
  53 #include <com/sun/star/awt/XVclContainer.hpp>
  54 #include <com/sun/star/awt/XDateField.hpp>
  55 #include <com/sun/star/awt/XComboBox.hpp>
  56 #include <com/sun/star/awt/XControl.hpp>
  57 #include <com/sun/star/awt/XCheckBox.hpp>
  58 #include <com/sun/star/awt/XLayoutConstrains.hpp>
  59 #include <com/sun/star/awt/XProgressBar.hpp>
  60
  61 #include <vector>
  62
  63 #include "basecontainercontrol.hxx"
  64
  65 namespace unocontrols{
  66
  67 #define SERVICENAME_PROGRESSMONITOR                     "com.sun.star.awt.XProgressMonitor"
  68 #define IMPLEMENTATIONNAME_PROGRESSMONITOR              "stardiv.UnoControls.ProgressMonitor"
  69 #define PROGRESSMONITOR_FREEBORDER                      10                                                      // border around and between the controls
  70 #define FIXEDTEXT_SERVICENAME                           "com.sun.star.awt.UnoControlFixedText"
  71 #define BUTTON_SERVICENAME                              "com.sun.star.awt.UnoControlButton"
  72 #define FIXEDTEXT_MODELNAME                             "com.sun.star.awt.UnoControlFixedTextModel"
  73 #define BUTTON_MODELNAME                                "com.sun.star.awt.UnoControlButtonModel"
  74 #define CONTROLNAME_TEXT                                "Text"                                                  // identifier the control in container
  75 #define CONTROLNAME_BUTTON                              "Button"                                                //              -||-
  76 #define CONTROLNAME_PROGRESSBAR                         "ProgressBar"                                           //              -||-
  77 #define DEFAULT_BUTTONLABEL                             "Abbrechen"
  78 #define PROGRESSMONITOR_DEFAULT_TOPIC                   "\0"
  79 #define PROGRESSMONITOR_DEFAULT_TEXT                    "\0"
  80 #define PROGRESSMONITOR_BACKGROUNDCOLOR                 TRGB_COLORDATA( 0x00, 0xC0, 0xC0, 0xC0 )                // lighgray
  81 #define PROGRESSMONITOR_LINECOLOR_BRIGHT                TRGB_COLORDATA( 0x00, 0xFF, 0xFF, 0xFF )                // white
  82 #define PROGRESSMONITOR_LINECOLOR_SHADOW                TRGB_COLORDATA( 0x00, 0x00, 0x00, 0x00 )                // black
  83 #define PROGRESSMONITOR_DEFAULT_WIDTH                   350
  84 #define PROGRESSMONITOR_DEFAULT_HEIGHT                  100
  85
  86 //____________________________________________________________________________________________________________
  87 //  structs, types
  88 //____________________________________________________________________________________________________________
  89
  90 /// Item of TextList
  91 struct IMPL_TextlistItem
  92 {
  93     OUString sTopic  ;          /// Left site of textline in dialog
  94     OUString sText   ;          /// Right site of textline in dialog
  95 };
  96
  97 //____________________________________________________________________________________________________________
  98 //  class declaration
  99 //____________________________________________________________________________________________________________
 100
 101 class ProgressMonitor   : public ::com::sun::star::awt::XLayoutConstrains
 102                         , public ::com::sun::star::awt::XButton
 103                         , public ::com::sun::star::awt::XProgressMonitor
 104                         , public BaseContainerControl
 105 {
 106
 107 //____________________________________________________________________________________________________________
 108 //  public methods
 109 //____________________________________________________________________________________________________________
 110
 111 public:
 112
 113     //________________________________________________________________________________________________________
 114     //  construct/destruct
 115     //________________________________________________________________________________________________________
 116
 117     /**_______________________________________________________________________________________________________
 118         @short
 119         @descr
 120
 121         @seealso
 122
 123         @param
 124
 125         @return
 126
 127         @onerror
 128     */
 129
 130     ProgressMonitor( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext );
 131
 132     /**_______________________________________________________________________________________________________
 133         @short
 134         @descr
 135
 136         @seealso
 137
 138         @param
 139
 140         @return
 141
 142         @onerror
 143     */
 144
 145     virtual ~ProgressMonitor();
 146
 147     //________________________________________________________________________________________________________
 148     //  XInterface
 149     //________________________________________________________________________________________________________
 150
 151     /**_______________________________________________________________________________________________________
 152         @short      give answer, if interface is supported
 153         @descr      The interfaces are searched by type.
 154
 155         @seealso    XInterface
 156
 157         @param      "rType" is the type of searched interface.
 158
 159         @return     Any     information about found interface
 160
 161         @onerror    A RuntimeException is thrown.
 162     */
 163
 164     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType )
 165         throw( ::com::sun::star::uno::RuntimeException );
 166
 167     /**_______________________________________________________________________________________________________
 168         @short      increment refcount
 169         @descr      -
 170
 171         @seealso    XInterface
 172         @seealso    release()
 173
 174         @param      -
 175
 176         @return     -
 177
 178         @onerror    A RuntimeException is thrown.
 179     */
 180
 181     virtual void SAL_CALL acquire() throw();
 182
 183     /**_______________________________________________________________________________________________________
 184         @short      decrement refcount
 185         @descr      -
 186
 187         @seealso    XInterface
 188         @seealso    acquire()
 189
 190         @param      -
 191
 192         @return     -
 193
 194         @onerror    A RuntimeException is thrown.
 195     */
 196
 197     virtual void SAL_CALL release() throw();
 198
 199     //________________________________________________________________________________________________________
 200     //  XTypeProvider
 201     //________________________________________________________________________________________________________
 202
 203     /**_______________________________________________________________________________________________________
 204         @short      get information about supported interfaces
 205         @descr      -
 206
 207         @seealso    XTypeProvider
 208
 209         @param      -
 210
 211         @return     Sequence of types of all supported interfaces
 212
 213         @onerror    A RuntimeException is thrown.
 214     */
 215
 216     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes() throw( ::com::sun::star::uno::RuntimeException );
 217
 218     //________________________________________________________________________________________________________
 219     //  XAggregation
 220     //________________________________________________________________________________________________________
 221
 222     /**_______________________________________________________________________________________________________
 223         @short      -
 224         @descr      -
 225
 226         @seealso    -
 227
 228         @param      -
 229
 230         @return     -
 231
 232         @onerror    -
 233     */
 234
 235     virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation( const ::com::sun::star::uno::Type& aType )
 236         throw( ::com::sun::star::uno::RuntimeException );
 237
 238     //________________________________________________________________________________________________________
 239     //  XProgressMonitor
 240     //________________________________________________________________________________________________________
 241
 242     /**_______________________________________________________________________________________________________
 243         @short      add topic to dialog
 244         @descr      Add a topic with a text in right textlist (used for FixedText-member).<BR>
 245                     ( "beforeProgress" fix the right list ). The dialog metric is recalculated.
 246
 247         @seealso    removeText(), updateText()
 248
 249         @param      sTopic              Name of topic<BR>
 250                                          [sTopic != "" && sTopic != NULL]
 251         @param      sText               Value of topic<BR>
 252                                          [sText != "" && sText != NULL]
 253         @param      bbeforeProgress     Position of topic<BR>
 254                                          [True => before progressbar / False => below progressbar]
 255
 256         @return     -
 257
 258         @onerror    DEBUG   = Assertion<BR>
 259                     RELEASE = nothing
 260     */
 261
 262     virtual void SAL_CALL addText(
 263         const OUString& sTopic ,
 264         const OUString& sText ,
 265         sal_Bool bbeforeProgress
 266     ) throw( ::com::sun::star::uno::RuntimeException );
 267
 268     /**_______________________________________________________________________________________________________
 269         @short      -
 270         @descr      -
 271
 272         @seealso    -
 273
 274         @param      -
 275
 276         @return     -
 277
 278         @onerror    -
 279     */
 280
 281     virtual void SAL_CALL removeText(
 282         const OUString& sTopic ,
 283         sal_Bool bbeforeProgress
 284     ) throw( ::com::sun::star::uno::RuntimeException );
 285
 286     /**_______________________________________________________________________________________________________
 287         @short      -
 288         @descr      -
 289
 290         @seealso    -
 291
 292         @param      -
 293
 294         @return     -
 295
 296         @onerror    -
 297     */
 298
 299     virtual void SAL_CALL updateText(
 300         const OUString&  sTopic ,
 301         const OUString&  sText ,
 302         sal_Bool bbeforeProgress
 303     ) throw( ::com::sun::star::uno::RuntimeException );
 304
 305     //________________________________________________________________________________________________________
 306     //  XProgressBar
 307     //________________________________________________________________________________________________________
 308
 309     /**_______________________________________________________________________________________________________
 310         @short      -
 311         @descr      -
 312
 313         @seealso    -
 314
 315         @param      -
 316
 317         @return     -
 318
 319         @onerror    -
 320     */
 321
 322     virtual void SAL_CALL setForegroundColor( sal_Int32 nColor ) throw( ::com::sun::star::uno::RuntimeException );
 323
 324     /**_______________________________________________________________________________________________________
 325         @short      -
 326         @descr      -
 327
 328         @seealso    -
 329
 330         @param      -
 331
 332         @return     -
 333
 334         @onerror    -
 335     */
 336
 337     virtual void SAL_CALL setBackgroundColor( sal_Int32 nColor ) throw( ::com::sun::star::uno::RuntimeException );
 338
 339     /**_______________________________________________________________________________________________________
 340         @short      -
 341         @descr      -
 342
 343         @seealso    -
 344
 345         @param      -
 346
 347         @return     -
 348
 349         @onerror    -
 350     */
 351
 352     virtual void SAL_CALL setValue( sal_Int32 nValue ) throw( ::com::sun::star::uno::RuntimeException );
 353
 354     /**_______________________________________________________________________________________________________
 355         @short      -
 356         @descr      -
 357
 358         @seealso    -
 359
 360         @param      -
 361
 362         @return     -
 363
 364         @onerror    -
 365     */
 366
 367     virtual void SAL_CALL setRange( sal_Int32   nMin    ,
 368                                     sal_Int32   nMax    ) throw( ::com::sun::star::uno::RuntimeException );
 369
 370     /**_______________________________________________________________________________________________________
 371         @short      -
 372         @descr      -
 373
 374         @seealso    -
 375
 376         @param      -
 377
 378         @return     -
 379
 380         @onerror    -
 381     */
 382
 383     virtual sal_Int32 SAL_CALL getValue() throw( ::com::sun::star::uno::RuntimeException );
 384
 385     //________________________________________________________________________________________________________
 386     //  XButton
 387     //________________________________________________________________________________________________________
 388
 389     /**_______________________________________________________________________________________________________
 390         @short      -
 391         @descr      -
 392
 393         @seealso    -
 394
 395         @param      -
 396
 397         @return     -
 398
 399         @onerror    -
 400     */
 401
 402     virtual void SAL_CALL addActionListener(
 403         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XActionListener >& xListener
 404     ) throw( ::com::sun::star::uno::RuntimeException );
 405
 406     /**_______________________________________________________________________________________________________
 407         @short      -
 408         @descr      -
 409
 410         @seealso    -
 411
 412         @param      -
 413
 414         @return     -
 415
 416         @onerror    -
 417     */
 418
 419     virtual void SAL_CALL removeActionListener(
 420         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XActionListener >& xListener
 421     ) throw( ::com::sun::star::uno::RuntimeException );
 422
 423     /**_______________________________________________________________________________________________________
 424         @short      -
 425         @descr      -
 426
 427         @seealso    -
 428
 429         @param      -
 430
 431         @return     -
 432
 433         @onerror    -
 434     */
 435
 436     virtual void SAL_CALL setLabel( const OUString& sLabel ) throw( ::com::sun::star::uno::RuntimeException );
 437
 438     /**_______________________________________________________________________________________________________
 439         @short      -
 440         @descr      -
 441
 442         @seealso    -
 443
 444         @param      -
 445
 446         @return     -
 447
 448         @onerror    -
 449     */
 450
 451     virtual void SAL_CALL setActionCommand( const OUString& sCommand )
 452         throw( ::com::sun::star::uno::RuntimeException );
 453
 454     //________________________________________________________________________________________________________
 455     //  XLayoutConstrains
 456     //________________________________________________________________________________________________________
 457
 458     /**_______________________________________________________________________________________________________
 459         @short      -
 460         @descr      -
 461
 462         @seealso    -
 463
 464         @param      -
 465
 466         @return     -
 467
 468         @onerror    -
 469     */
 470
 471     virtual ::com::sun::star::awt::Size SAL_CALL getMinimumSize() throw( ::com::sun::star::uno::RuntimeException );
 472
 473     /**_______________________________________________________________________________________________________
 474         @short      -
 475         @descr      -
 476
 477         @seealso    -
 478
 479         @param      -
 480
 481         @return     -
 482
 483         @onerror    -
 484     */
 485
 486     virtual ::com::sun::star::awt::Size SAL_CALL getPreferredSize() throw( ::com::sun::star::uno::RuntimeException );
 487
 488     /**_______________________________________________________________________________________________________
 489         @short      -
 490         @descr      -
 491
 492         @seealso    -
 493
 494         @param      -
 495
 496         @return     -
 497
 498         @onerror    -
 499     */
 500
 501     virtual ::com::sun::star::awt::Size SAL_CALL calcAdjustedSize( const ::com::sun::star::awt::Size& aNewSize )
 502         throw( ::com::sun::star::uno::RuntimeException );
 503
 504     //________________________________________________________________________________________________________
 505     //  XControl
 506     //________________________________________________________________________________________________________
 507
 508     /**_______________________________________________________________________________________________________
 509         @short      -
 510         @descr      -
 511
 512         @seealso    -
 513
 514         @param      -
 515
 516         @return     -
 517
 518         @onerror    -
 519     */
 520
 521     virtual void SAL_CALL createPeer(
 522         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XToolkit     >& xToolkit ,
 523         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindowPeer  >& xParent
 524     ) throw( ::com::sun::star::uno::RuntimeException );
 525
 526     /**_______________________________________________________________________________________________________
 527         @short      -
 528         @descr      -
 529
 530         @seealso    -
 531
 532         @param      -
 533
 534         @return     -
 535
 536         @onerror    -
 537     */
 538
 539     virtual sal_Bool SAL_CALL setModel( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >& xModel )
 540         throw( ::com::sun::star::uno::RuntimeException );
 541
 542     /**_______________________________________________________________________________________________________
 543         @short      -
 544         @descr      -
 545
 546         @seealso    -
 547
 548         @param      -
 549
 550         @return     -
 551
 552         @onerror    -
 553     */
 554
 555     virtual ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > SAL_CALL getModel()
 556         throw( ::com::sun::star::uno::RuntimeException );
 557
 558     //________________________________________________________________________________________________________
 559     //  XComponent
 560     //________________________________________________________________________________________________________
 561
 562     /**_______________________________________________________________________________________________________
 563         @short      -
 564         @descr      -
 565
 566         @seealso    -
 567
 568         @param      -
 569
 570         @return     -
 571
 572         @onerror    -
 573     */
 574
 575     virtual void SAL_CALL dispose() throw( ::com::sun::star::uno::RuntimeException );
 576
 577     //________________________________________________________________________________________________________
 578     //  XWindow
 579     //________________________________________________________________________________________________________
 580
 581     /**_______________________________________________________________________________________________________
 582         @short      -
 583         @descr      -
 584
 585         @seealso    -
 586
 587         @param      -
 588
 589         @return     -
 590
 591         @onerror    -
 592     */
 593
 594     virtual void SAL_CALL setPosSize(   sal_Int32   nX      ,
 595                                         sal_Int32   nY      ,
 596                                         sal_Int32   nWidth  ,
 597                                         sal_Int32   nHeight ,
 598                                         sal_Int16   nFlags  ) throw( ::com::sun::star::uno::RuntimeException );
 599
 600     //________________________________________________________________________________________________________
 601     //  BaseControl
 602     //________________________________________________________________________________________________________
 603
 604     /**_______________________________________________________________________________________________________
 605         @short      -
 606         @descr      -
 607
 608         @seealso    -
 609
 610         @param      -
 611
 612         @return     -
 613
 614         @onerror    -
 615     */
 616
 617     static const ::com::sun::star::uno::Sequence< OUString > impl_getStaticSupportedServiceNames();
 618
 619     /**_______________________________________________________________________________________________________
 620         @short      -
 621         @descr      -
 622
 623         @seealso    -
 624
 625         @param      -
 626
 627         @return     -
 628
 629         @onerror    -
 630     */
 631
 632     static const OUString impl_getStaticImplementationName();
 633
 634 //____________________________________________________________________________________________________________
 635 //  protected methods
 636 //____________________________________________________________________________________________________________
 637
 638 protected:
 639
 640     /**_______________________________________________________________________________________________________
 641         @short      -
 642         @descr      -
 643
 644         @seealso    -
 645
 646         @param      -
 647
 648         @return     -
 649
 650         @onerror    -
 651     */
 652
 653     virtual void impl_paint( sal_Int32 nX ,
 654                              sal_Int32 nY ,
 655                              const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XGraphics >& xGraphics );
 656
 657 //____________________________________________________________________________________________________________
 658 // private methods
 659 //____________________________________________________________________________________________________________
 660
 661 private:
 662     using BaseControl::impl_recalcLayout;
 663     /**_______________________________________________________________________________________________________
 664         @short      -
 665         @descr      -
 666
 667         @seealso    -
 668
 669         @param      -
 670
 671         @return     -
 672
 673         @onerror    -
 674     */
 675
 676     void impl_recalcLayout();
 677
 678     /**_______________________________________________________________________________________________________
 679         @short      -
 680         @descr      -
 681
 682         @seealso    -
 683
 684         @param      -
 685
 686         @return     -
 687
 688         @onerror    -
 689     */
 690
 691     void impl_rebuildFixedText();
 692
 693     /**_______________________________________________________________________________________________________
 694         @short      -
 695         @descr      -
 696
 697         @seealso    -
 698
 699         @param      -
 700
 701         @return     -
 702
 703         @onerror    -
 704     */
 705
 706     void impl_cleanMemory();
 707
 708     /**_______________________________________________________________________________________________________
 709         @short      -
 710         @descr      -
 711
 712         @seealso    -
 713
 714         @param      -
 715
 716         @return     -
 717
 718         @onerror    -
 719     */
 720
 721     IMPL_TextlistItem* impl_searchTopic( const OUString& sTopic , sal_Bool bbeforeProgress );
 722
 723 //____________________________________________________________________________________________________________
 724 // debug methods
 725 //____________________________________________________________________________________________________________
 726
 727 private:
 728
 729     /**_______________________________________________________________________________________________________
 730         @short      -
 731         @descr      -
 732
 733         @seealso    -
 734
 735         @param      -
 736
 737         @return     -
 738
 739         @onerror    -
 740     */
 741
 742     #ifdef DBG_UTIL
 743
 744     sal_Bool impl_debug_checkParameter( const OUString& sTopic, const OUString& sText, sal_Bool bbeforeProgress );    // addText, updateText
 745     sal_Bool impl_debug_checkParameter( const OUString& rTopic, sal_Bool bbeforeProgress );                              // removeText
 746
 747     #endif
 748 //____________________________________________________________________________________________________________
 749 // private variables
 750 //____________________________________________________________________________________________________________
 751
 752 private:
 753     ::std::vector < IMPL_TextlistItem* >        maTextlist_Top;         // Elements before progress
 754     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XFixedText >   m_xTopic_Top        ;   // (used, if parameter "beforeProgress"=sal_True in "addText, updateText, removeText")
 755     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XFixedText >   m_xText_Top         ;
 756
 757     ::std::vector < IMPL_TextlistItem* >        maTextlist_Bottom;      // Elements below of progress
 758     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XFixedText >   m_xTopic_Bottom     ;   // (used, if parameter "beforeProgress"=sal_False in "addText, updateText, removeText")
 759     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XFixedText >   m_xText_Bottom      ;
 760
 761     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XProgressBar > m_xProgressBar      ;
 762     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XButton >      m_xButton           ;
 763     ::com::sun::star::awt::Rectangle                          m_a3DLine           ;
 764
 765 };  // class ProgressMonitor
 766
 767 }   // namespace unocontrols
 768
 769 #endif  // #ifndef _UNOCONTROLS_PROGRESSMONITOR_CTRL_HXX
 770
 771 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */