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