UnoControls/source/inc/progressbar.hxx

   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: progressbar.hxx,v $
  10  * $Revision: 1.5 $
  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 #ifndef _UNOCONTROLS_PROGRESSBAR_CTRL_HXX
  32 #define _UNOCONTROLS_PROGRESSBAR_CTRL_HXX
  33
  34 //____________________________________________________________________________________________________________
  35 //      includes of other projects
  36 //____________________________________________________________________________________________________________
  37
  38 #include <com/sun/star/lang/XServiceName.hpp>
  39 #include <com/sun/star/lang/XServiceInfo.hpp>
  40
  41 //____________________________________________________________________________________________________________
  42 //      includes of my own project
  43 //____________________________________________________________________________________________________________
  44 #include "basecontrol.hxx"
  45
  46 //____________________________________________________________________________________________________________
  47 //      namespaces
  48 //____________________________________________________________________________________________________________
  49
  50 namespace unocontrols{
  51
  52 #define UNO3_REFERENCE                                  ::com::sun::star::uno::Reference
  53 #define UNO3_XMULTISERVICEFACTORY               ::com::sun::star::lang::XMultiServiceFactory
  54 #define UNO3_RUNTIMEEXCEPTION                   ::com::sun::star::uno::RuntimeException
  55 #define UNO3_XCONTROLMODEL                              ::com::sun::star::awt::XControlModel
  56 #define UNO3_XPROGRESSBAR                               ::com::sun::star::awt::XProgressBar
  57 #define UNO3_ANY                                                ::com::sun::star::uno::Any
  58 #define UNO3_TYPE                                               ::com::sun::star::uno::Type
  59 #define UNO3_SEQUENCE                   ::com::sun::star::uno::Sequence
  60 #define UNO3_XGRAPHICS                                  ::com::sun::star::awt::XGraphics
  61 #define UNO3_OUSTRING                                   ::rtl::OUString
  62 #define UNO3_SIZE                                               ::com::sun::star::awt::Size
  63
  64 //____________________________________________________________________________________________________________
  65 //      defines
  66 //____________________________________________________________________________________________________________
  67
  68 #define SERVICENAME_PROGRESSBAR                         "com.sun.star.awt.XProgressBar"
  69 #define IMPLEMENTATIONNAME_PROGRESSBAR          "stardiv.UnoControls.ProgressBar"
  70 #define FREESPACE                           4
  71 #define DEFAULT_HORIZONTAL                                      sal_True
  72 #define DEFAULT_BLOCKDIMENSION                          Size(1,1)
  73 #define DEFAULT_BACKGROUNDCOLOR                         TRGB_COLORDATA( 0x00, 0xC0, 0xC0, 0xC0 )        // lightgray
  74 #define DEFAULT_FOREGROUNDCOLOR                         TRGB_COLORDATA( 0x00, 0x00, 0x00, 0x80 )        // blue
  75 #define DEFAULT_MINRANGE                    INT_MIN
  76 #define DEFAULT_MAXRANGE                                        INT_MAX
  77 #define DEFAULT_BLOCKVALUE                                      1
  78 #define DEFAULT_VALUE                                           DEFAULT_MINRANGE
  79 #define LINECOLOR_BRIGHT                                        TRGB_COLORDATA( 0x00, 0xFF, 0xFF, 0xFF )        // white
  80 #define LINECOLOR_SHADOW                                        TRGB_COLORDATA( 0x00, 0x00, 0x00, 0x00 )        // black
  81
  82 //____________________________________________________________________________________________________________
  83 //      classes
  84 //____________________________________________________________________________________________________________
  85
  86 class ProgressBar       : public UNO3_XCONTROLMODEL
  87                     , public UNO3_XPROGRESSBAR
  88                     , public BaseControl
  89 {
  90
  91 //____________________________________________________________________________________________________________
  92 //      public methods
  93 //____________________________________________________________________________________________________________
  94
  95 public:
  96
  97     //________________________________________________________________________________________________________
  98     //  construct/destruct
  99     //________________________________________________________________________________________________________
 100
 101     /**_________________________________________________________________________________________________________
 102         @short
 103         @descr
 104
 105         @seealso
 106
 107         @param
 108
 109         @return
 110
 111         @onerror
 112     */
 113
 114     ProgressBar( const UNO3_REFERENCE< UNO3_XMULTISERVICEFACTORY >& xFactory );
 115
 116     /**_________________________________________________________________________________________________________
 117         @short
 118         @descr
 119
 120         @seealso
 121
 122         @param
 123
 124         @return
 125
 126         @onerror
 127     */
 128
 129     virtual     ~ProgressBar();
 130
 131     //__________________________________________________________________________________________________________
 132     //  XInterface
 133     //__________________________________________________________________________________________________________
 134
 135     /**_________________________________________________________________________________________________________
 136         @short
 137         @descr
 138
 139         @seealso
 140
 141         @param
 142
 143         @return
 144
 145         @onerror
 146     */
 147
 148     virtual UNO3_ANY SAL_CALL queryInterface( const UNO3_TYPE& aType ) throw( UNO3_RUNTIMEEXCEPTION );
 149
 150     /**_______________________________________________________________________________________________________
 151         @short          increment refcount
 152         @descr          -
 153
 154         @seealso        XInterface
 155         @seealso        release()
 156
 157         @param          -
 158
 159         @return         -
 160
 161         @onerror        A RuntimeException is thrown.
 162     */
 163
 164     virtual void SAL_CALL acquire() throw();
 165
 166     /**_______________________________________________________________________________________________________
 167         @short          decrement refcount
 168         @descr          -
 169
 170         @seealso        XInterface
 171         @seealso        acquire()
 172
 173         @param          -
 174
 175         @return         -
 176
 177         @onerror        A RuntimeException is thrown.
 178     */
 179
 180     virtual void SAL_CALL release() throw();
 181
 182     //__________________________________________________________________________________________________________
 183     //  XTypeProvider
 184     //__________________________________________________________________________________________________________
 185
 186     /**_________________________________________________________________________________________________________
 187         @short
 188         @descr
 189
 190         @seealso
 191
 192         @param
 193
 194         @return
 195
 196         @onerror
 197     */
 198
 199     virtual UNO3_SEQUENCE< UNO3_TYPE > SAL_CALL getTypes() throw( UNO3_RUNTIMEEXCEPTION );
 200
 201     //__________________________________________________________________________________________________________
 202     //  XAggregation
 203     //__________________________________________________________________________________________________________
 204
 205     /**_________________________________________________________________________________________________________
 206         @short
 207         @descr
 208
 209         @seealso
 210
 211         @param
 212
 213         @return
 214
 215         @onerror
 216     */
 217
 218     UNO3_ANY SAL_CALL queryAggregation( const UNO3_TYPE& aType ) throw( UNO3_RUNTIMEEXCEPTION );
 219
 220     //________________________________________________________________________________________________________
 221     //  XProgressBar
 222     //________________________________________________________________________________________________________
 223
 224     /**_________________________________________________________________________________________________________
 225         @short
 226         @descr
 227
 228         @seealso
 229
 230         @param
 231
 232         @return
 233
 234         @onerror
 235     */
 236
 237     virtual void SAL_CALL setForegroundColor( sal_Int32 nColor ) throw( UNO3_RUNTIMEEXCEPTION );
 238
 239     /**_________________________________________________________________________________________________________
 240         @short
 241         @descr
 242
 243         @seealso
 244
 245         @param
 246
 247         @return
 248
 249         @onerror
 250     */
 251
 252     virtual void SAL_CALL setBackgroundColor( sal_Int32 nColor ) throw( UNO3_RUNTIMEEXCEPTION );
 253
 254     /**_________________________________________________________________________________________________________
 255         @short
 256         @descr
 257
 258         @seealso
 259
 260         @param
 261
 262         @return
 263
 264         @onerror
 265     */
 266
 267     virtual void SAL_CALL setValue( sal_Int32 nValue ) throw( UNO3_RUNTIMEEXCEPTION );
 268
 269     /**_________________________________________________________________________________________________________
 270         @short
 271         @descr
 272
 273         @seealso
 274
 275         @param
 276
 277         @return
 278
 279         @onerror
 280     */
 281
 282     virtual void SAL_CALL setRange(     sal_Int32       nMin    ,
 283                                     sal_Int32   nMax    ) throw( UNO3_RUNTIMEEXCEPTION );
 284
 285     /**_________________________________________________________________________________________________________
 286         @short
 287         @descr
 288
 289         @seealso
 290
 291         @param
 292
 293         @return
 294
 295         @onerror
 296     */
 297
 298     virtual sal_Int32 SAL_CALL getValue() throw( UNO3_RUNTIMEEXCEPTION );
 299
 300     //__________________________________________________________________________________________________________
 301     //  XWindow
 302     //__________________________________________________________________________________________________________
 303
 304     /**_________________________________________________________________________________________________________
 305         @short
 306         @descr
 307
 308         @seealso
 309
 310         @param
 311
 312         @return
 313
 314         @onerror
 315     */
 316
 317     virtual void SAL_CALL setPosSize(   sal_Int32       nX              ,
 318                                         sal_Int32       nY              ,
 319                                         sal_Int32       nWidth  ,
 320                                         sal_Int32       nHeight ,
 321                                         sal_Int16       nFlags  ) throw( UNO3_RUNTIMEEXCEPTION );
 322
 323     //__________________________________________________________________________________________________________
 324     //  XControl
 325     //__________________________________________________________________________________________________________
 326
 327     /**_________________________________________________________________________________________________________
 328         @short
 329         @descr
 330
 331         @seealso
 332
 333         @param
 334
 335         @return
 336
 337         @onerror
 338     */
 339
 340     virtual sal_Bool SAL_CALL setModel( const UNO3_REFERENCE< UNO3_XCONTROLMODEL >& xModel ) throw( UNO3_RUNTIMEEXCEPTION );
 341
 342     /**_________________________________________________________________________________________________________
 343         @short
 344         @descr
 345
 346         @seealso
 347
 348         @param
 349
 350         @return
 351
 352         @onerror
 353     */
 354
 355     virtual UNO3_REFERENCE< UNO3_XCONTROLMODEL > SAL_CALL getModel() throw( UNO3_RUNTIMEEXCEPTION );
 356
 357     //__________________________________________________________________________________________________________
 358     //  BaseControl
 359     //__________________________________________________________________________________________________________
 360
 361     /**_________________________________________________________________________________________________________
 362         @short
 363         @descr
 364
 365         @seealso
 366
 367         @param
 368
 369         @return
 370
 371         @onerror
 372     */
 373
 374     static const UNO3_SEQUENCE< UNO3_OUSTRING > impl_getStaticSupportedServiceNames();
 375
 376     /**_________________________________________________________________________________________________________
 377         @short
 378         @descr
 379
 380         @seealso
 381
 382         @param
 383
 384         @return
 385
 386         @onerror
 387     */
 388
 389     static const UNO3_OUSTRING impl_getStaticImplementationName();
 390
 391 //____________________________________________________________________________________________________________
 392 //      protected methods
 393 //____________________________________________________________________________________________________________
 394
 395 protected:
 396
 397     /**_________________________________________________________________________________________________________
 398         @short
 399         @descr
 400
 401         @seealso
 402
 403         @param
 404
 405         @return
 406
 407         @onerror
 408     */
 409
 410     virtual void impl_paint(            sal_Int32                                                       nX                      ,
 411                                     sal_Int32                                                   nY                      ,
 412                             const       UNO3_REFERENCE< UNO3_XGRAPHICS >&       xGraphics       );
 413
 414     /**_________________________________________________________________________________________________________
 415         @short
 416         @descr
 417
 418         @seealso
 419
 420         @param
 421
 422         @return
 423
 424         @onerror
 425     */
 426
 427     void impl_recalcRange();
 428
 429 //____________________________________________________________________________________________________________
 430 //      private variables
 431 //____________________________________________________________________________________________________________
 432
 433 private:
 434
 435     sal_Bool    m_bHorizontal           ;       // orientation for steps                        [true=horizontal/false=vertikal]
 436     UNO3_SIZE   m_aBlockSize            ;       // width and height of a block          [>=0,0]
 437     sal_Int32   m_nForegroundColor      ;       //                                                                      (alpha,r,g,b)
 438     sal_Int32   m_nBackgroundColor      ;       //                                                                      (alpha,r,g,b)
 439     sal_Int32   m_nMinRange                     ;       // lowest value  =   0%                         [long, <_nMaxRange]
 440     sal_Int32   m_nMaxRange                     ;       // highest value = 100%                         [long, >_nMinRange]
 441     double      m_nBlockValue       ;   // value for one block              [long, >0]
 442     sal_Int32   m_nValue                        ;       // value for progress                           [long]
 443
 444 };      // class ProgressBar
 445
 446 }       // namespace unocontrols
 447
 448 #endif  // #ifndef _UNOCONTROLS_PROGRESSBAR_CTRL_HXX