UnoControls/source/inc/statusindicator.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_STATUSINDICATOR_CTRL_HXX
  21 #define _UNOCONTROLS_STATUSINDICATOR_CTRL_HXX
  22
  23 #include <com/sun/star/awt/XControlModel.hpp>
  24 #include <com/sun/star/awt/XFixedText.hpp>
  25 #include <com/sun/star/awt/XGraphics.hpp>
  26 #include <com/sun/star/awt/XLayoutConstrains.hpp>
  27 #include <com/sun/star/awt/XProgressBar.hpp>
  28 #include <com/sun/star/task/XStatusIndicator.hpp>
  29 #include <com/sun/star/awt/XToolkit.hpp>
  30 #include <com/sun/star/awt/XWindowPeer.hpp>
  31 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  32
  33 #include "basecontainercontrol.hxx"
  34
  35 namespace unocontrols{
  36
  37 #define SERVICENAME_STATUSINDICATOR             "com.sun.star.task.XStatusIndicator"
  38 #define IMPLEMENTATIONNAME_STATUSINDICATOR      "stardiv.UnoControls.StatusIndicator"
  39 #define STATUSINDICATOR_FREEBORDER              5                                                       // border around and between the controls
  40 #define FIXEDTEXT_SERVICENAME                   "com.sun.star.awt.UnoControlFixedText"
  41 #define FIXEDTEXT_MODELNAME                     "com.sun.star.awt.UnoControlFixedTextModel"
  42 #define CONTROLNAME_TEXT                        "Text"                                                  // identifier the control in container
  43 #define CONTROLNAME_PROGRESSBAR                 "ProgressBar"                                           //              -||-
  44 #define STATUSINDICATOR_DEFAULT_TEXT            "\0"
  45 #define STATUSINDICATOR_BACKGROUNDCOLOR         TRGB_COLORDATA( 0x00, 0xC0, 0xC0, 0xC0 )                // lighgray
  46 #define STATUSINDICATOR_LINECOLOR_BRIGHT        TRGB_COLORDATA( 0x00, 0xFF, 0xFF, 0xFF )                // white
  47 #define STATUSINDICATOR_LINECOLOR_SHADOW        TRGB_COLORDATA( 0x00, 0x00, 0x00, 0x00 )                // black
  48 #define STATUSINDICATOR_DEFAULT_WIDTH           300
  49 #define STATUSINDICATOR_DEFAULT_HEIGHT          25
  50
  51 //____________________________________________________________________________________________________________
  52 //  structs, types
  53 //____________________________________________________________________________________________________________
  54
  55 //____________________________________________________________________________________________________________
  56 //  class declaration
  57 //____________________________________________________________________________________________________________
  58
  59 class StatusIndicator   : public ::com::sun::star::awt::XLayoutConstrains
  60                         , public ::com::sun::star::task::XStatusIndicator
  61                         , public BaseContainerControl
  62 {
  63
  64     //-------------------------------------------------------------------------------------------------------------
  65     //  public methods
  66     //-------------------------------------------------------------------------------------------------------------
  67
  68     public:
  69
  70         //---------------------------------------------------------------------------------------------------------
  71         //  construct/destruct
  72         //---------------------------------------------------------------------------------------------------------
  73
  74         /**_______________________________________________________________________________________________________
  75             @short
  76             @descr
  77
  78             @seealso
  79
  80             @param
  81
  82             @return
  83
  84             @onerror
  85         */
  86
  87         StatusIndicator( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext );
  88
  89         /**_______________________________________________________________________________________________________
  90             @short
  91             @descr
  92
  93             @seealso
  94
  95             @param
  96
  97             @return
  98
  99             @onerror
 100         */
 101
 102         virtual ~StatusIndicator();
 103
 104         //---------------------------------------------------------------------------------------------------------
 105         //  XInterface
 106         //---------------------------------------------------------------------------------------------------------
 107
 108         /**_______________________________________________________________________________________________________
 109             @short      give answer, if interface is supported
 110             @descr      The interfaces are searched by type.
 111
 112             @seealso    XInterface
 113
 114             @param      "rType" is the type of searched interface.
 115
 116             @return     Any     information about found interface
 117
 118             @onerror    A RuntimeException is thrown.
 119         */
 120
 121         virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType )
 122             throw( ::com::sun::star::uno::RuntimeException );
 123
 124         /**_______________________________________________________________________________________________________
 125             @short      increment refcount
 126             @descr      -
 127
 128             @seealso    XInterface
 129             @seealso    release()
 130
 131             @param      -
 132
 133             @return     -
 134
 135             @onerror    A RuntimeException is thrown.
 136         */
 137
 138         virtual void SAL_CALL acquire() throw();
 139
 140         /**_______________________________________________________________________________________________________
 141             @short      decrement refcount
 142             @descr      -
 143
 144             @seealso    XInterface
 145             @seealso    acquire()
 146
 147             @param      -
 148
 149             @return     -
 150
 151             @onerror    A RuntimeException is thrown.
 152         */
 153
 154         virtual void SAL_CALL release() throw();
 155
 156         //---------------------------------------------------------------------------------------------------------
 157         //  XTypeProvider
 158         //---------------------------------------------------------------------------------------------------------
 159
 160         /**_______________________________________________________________________________________________________
 161             @short      get information about supported interfaces
 162             @descr      -
 163
 164             @seealso    XTypeProvider
 165
 166             @param      -
 167
 168             @return     Sequence of types of all supported interfaces
 169
 170             @onerror    A RuntimeException is thrown.
 171         */
 172
 173         virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes()
 174             throw( ::com::sun::star::uno::RuntimeException );
 175
 176         //---------------------------------------------------------------------------------------------------------
 177         //  XAggregation
 178         //---------------------------------------------------------------------------------------------------------
 179
 180         /**_______________________________________________________________________________________________________
 181             @short      -
 182             @descr      -
 183
 184             @seealso    -
 185
 186             @param      -
 187
 188             @return     -
 189
 190             @onerror    -
 191         */
 192
 193         virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation( const ::com::sun::star::uno::Type& aType )
 194             throw( ::com::sun::star::uno::RuntimeException );
 195
 196         //---------------------------------------------------------------------------------------------------------
 197         //  XStatusIndicator
 198         //---------------------------------------------------------------------------------------------------------
 199
 200         /*-****************************************************************************************************//**
 201             @short      -
 202             @descr      -
 203
 204             @seealso    -
 205
 206             @param      -
 207
 208             @return     -
 209
 210             @onerror    -
 211         *//*-*****************************************************************************************************/
 212
 213         virtual void SAL_CALL start(
 214             const OUString&  sText   ,
 215             sal_Int32 nRange
 216         ) throw( ::com::sun::star::uno::RuntimeException );
 217
 218         /*-****************************************************************************************************//**
 219             @short      -
 220             @descr      -
 221
 222             @seealso    -
 223
 224             @param      -
 225
 226             @return     -
 227
 228             @onerror    -
 229         *//*-*****************************************************************************************************/
 230
 231         virtual void SAL_CALL end() throw( ::com::sun::star::uno::RuntimeException );
 232
 233         /*-****************************************************************************************************//**
 234             @short      -
 235             @descr      -
 236
 237             @seealso    -
 238
 239             @param      -
 240
 241             @return     -
 242
 243             @onerror    -
 244         *//*-*****************************************************************************************************/
 245
 246         virtual void SAL_CALL reset() throw( ::com::sun::star::uno::RuntimeException );
 247
 248         /*-****************************************************************************************************//**
 249             @short      -
 250             @descr      -
 251
 252             @seealso    -
 253
 254             @param      -
 255
 256             @return     -
 257
 258             @onerror    -
 259         *//*-*****************************************************************************************************/
 260
 261         virtual void SAL_CALL setText( const OUString& sText ) throw( ::com::sun::star::uno::RuntimeException );
 262
 263         /*-****************************************************************************************************//**
 264             @short      -
 265             @descr      -
 266
 267             @seealso    -
 268
 269             @param      -
 270
 271             @return     -
 272
 273             @onerror    -
 274         *//*-*****************************************************************************************************/
 275
 276         virtual void SAL_CALL setValue( sal_Int32 nValue ) throw( ::com::sun::star::uno::RuntimeException );
 277
 278         //---------------------------------------------------------------------------------------------------------
 279         //  XLayoutConstrains
 280         //---------------------------------------------------------------------------------------------------------
 281
 282         /**_______________________________________________________________________________________________________
 283             @short      -
 284             @descr      -
 285
 286             @seealso    -
 287
 288             @param      -
 289
 290             @return     -
 291
 292             @onerror    -
 293         */
 294
 295         virtual ::com::sun::star::awt::Size SAL_CALL getMinimumSize() throw( ::com::sun::star::uno::RuntimeException );
 296
 297         /**_______________________________________________________________________________________________________
 298             @short      -
 299             @descr      -
 300
 301             @seealso    -
 302
 303             @param      -
 304
 305             @return     -
 306
 307             @onerror    -
 308         */
 309
 310         virtual ::com::sun::star::awt::Size SAL_CALL getPreferredSize() throw( ::com::sun::star::uno::RuntimeException );
 311
 312         /**_______________________________________________________________________________________________________
 313             @short      -
 314             @descr      -
 315
 316             @seealso    -
 317
 318             @param      -
 319
 320             @return     -
 321
 322             @onerror    -
 323         */
 324
 325         virtual ::com::sun::star::awt::Size SAL_CALL calcAdjustedSize( const ::com::sun::star::awt::Size& aNewSize )
 326             throw( ::com::sun::star::uno::RuntimeException );
 327
 328         //---------------------------------------------------------------------------------------------------------
 329         //  XControl
 330         //---------------------------------------------------------------------------------------------------------
 331
 332         /**_______________________________________________________________________________________________________
 333             @short      -
 334             @descr      -
 335
 336             @seealso    -
 337
 338             @param      -
 339
 340             @return     -
 341
 342             @onerror    -
 343         */
 344
 345         virtual void SAL_CALL createPeer(
 346             const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XToolkit >&    xToolkit    ,
 347             const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindowPeer >& xParent
 348         ) throw( ::com::sun::star::uno::RuntimeException );
 349
 350         /**_______________________________________________________________________________________________________
 351             @short      -
 352             @descr      -
 353
 354             @seealso    -
 355
 356             @param      -
 357
 358             @return     -
 359
 360             @onerror    -
 361         */
 362
 363         virtual sal_Bool SAL_CALL setModel( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >& xModel )
 364             throw( ::com::sun::star::uno::RuntimeException );
 365
 366         /**_______________________________________________________________________________________________________
 367             @short      -
 368             @descr      -
 369
 370             @seealso    -
 371
 372             @param      -
 373
 374             @return     -
 375
 376             @onerror    -
 377         */
 378
 379         virtual ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > SAL_CALL getModel()
 380             throw( ::com::sun::star::uno::RuntimeException );
 381
 382         //---------------------------------------------------------------------------------------------------------
 383         //  XComponent
 384         //---------------------------------------------------------------------------------------------------------
 385
 386         /**_______________________________________________________________________________________________________
 387             @short      -
 388             @descr      -
 389
 390             @seealso    -
 391
 392             @param      -
 393
 394             @return     -
 395
 396             @onerror    -
 397         */
 398
 399         virtual void SAL_CALL dispose() throw( ::com::sun::star::uno::RuntimeException );
 400
 401         //---------------------------------------------------------------------------------------------------------
 402         //  XWindow
 403         //---------------------------------------------------------------------------------------------------------
 404
 405         /**_______________________________________________________________________________________________________
 406             @short      -
 407             @descr      -
 408
 409             @seealso    -
 410
 411             @param      -
 412
 413             @return     -
 414
 415             @onerror    -
 416         */
 417
 418         virtual void SAL_CALL setPosSize(   sal_Int32   nX      ,
 419                                             sal_Int32   nY      ,
 420                                             sal_Int32   nWidth  ,
 421                                             sal_Int32   nHeight ,
 422                                             sal_Int16   nFlags  ) throw( ::com::sun::star::uno::RuntimeException );
 423
 424         //---------------------------------------------------------------------------------------------------------
 425         //  BaseControl
 426         //---------------------------------------------------------------------------------------------------------
 427
 428         /**_______________________________________________________________________________________________________
 429             @short      -
 430             @descr      -
 431
 432             @seealso    -
 433
 434             @param      -
 435
 436             @return     -
 437
 438             @onerror    -
 439         */
 440
 441         static const ::com::sun::star::uno::Sequence< OUString > impl_getStaticSupportedServiceNames();
 442
 443         /**_______________________________________________________________________________________________________
 444             @short      -
 445             @descr      -
 446
 447             @seealso    -
 448
 449             @param      -
 450
 451             @return     -
 452
 453             @onerror    -
 454         */
 455
 456         static const OUString impl_getStaticImplementationName();
 457
 458 //____________________________________________________________________________________________________________
 459 //  protected methods
 460 //____________________________________________________________________________________________________________
 461
 462 protected:
 463
 464         /**_______________________________________________________________________________________________________
 465             @short      -
 466             @descr      -
 467
 468             @seealso    -
 469
 470             @param      -
 471
 472             @return     -
 473
 474             @onerror    -
 475         */
 476
 477         virtual ::com::sun::star::awt::WindowDescriptor* impl_getWindowDescriptor(
 478             const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindowPeer >& xParentPeer
 479         );
 480
 481         /**_______________________________________________________________________________________________________
 482             @short      -
 483             @descr      -
 484
 485             @seealso    -
 486
 487             @param      -
 488
 489             @return     -
 490
 491             @onerror    -
 492         */
 493
 494         virtual void impl_paint (
 495             sal_Int32 nX,
 496             sal_Int32 nY,
 497             const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XGraphics > & rGraphics
 498         );
 499
 500         /**_______________________________________________________________________________________________________
 501             @short      -
 502             @descr      -
 503
 504             @seealso    -
 505
 506             @param      -
 507
 508             @return     -
 509
 510             @onerror    -
 511         */
 512
 513         virtual void impl_recalcLayout( const ::com::sun::star::awt::WindowEvent& aEvent );
 514
 515 //____________________________________________________________________________________________________________
 516 // debug methods
 517 //____________________________________________________________________________________________________________
 518
 519 private:
 520
 521     /**_______________________________________________________________________________________________________
 522         @short      -
 523         @descr      -
 524
 525         @seealso    -
 526
 527         @param      -
 528
 529         @return     -
 530
 531         @onerror    -
 532     */
 533
 534 //____________________________________________________________________________________________________________
 535 // private variables
 536 //____________________________________________________________________________________________________________
 537
 538 private:
 539
 540     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XFixedText >       m_xText         ;
 541     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XProgressBar >     m_xProgressBar  ;
 542
 543 };  // class StatusIndicator
 544
 545 }   // namespace unocontrols
 546
 547 #endif  // #ifndef _UNOCONTROLS_STATUSINDICATOR_CTRL_HXX
 548
 549 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */