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