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 css::awt::XControlModel
  47                     , public css::awt::XProgressBar
  48                     , public BaseControl
  49 {
  50
  51 public:
  52
  53     ProgressBar( const css::uno::Reference< css::uno::XComponentContext >& rxContext );
  54
  55     virtual ~ProgressBar() override;
  56
  57     //  XInterface
  58
  59     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;
  60
  61     /**_______________________________________________________________________________________________________
  62         @short      increment refcount
  63         @seealso    XInterface
  64         @seealso    release()
  65         @onerror    A RuntimeException is thrown.
  66     */
  67
  68     virtual void SAL_CALL acquire() throw() override;
  69
  70     /**_______________________________________________________________________________________________________
  71         @short      decrement refcount
  72         @seealso    XInterface
  73         @seealso    acquire()
  74         @onerror    A RuntimeException is thrown.
  75     */
  76
  77     virtual void SAL_CALL release() throw() override;
  78
  79     //  XTypeProvider
  80
  81     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
  82
  83     //  XAggregation
  84
  85     css::uno::Any SAL_CALL queryAggregation( const css::uno::Type& aType ) override;
  86
  87     //  XProgressBar
  88
  89     virtual void SAL_CALL setForegroundColor( sal_Int32 nColor ) override;
  90
  91     virtual void SAL_CALL setBackgroundColor( sal_Int32 nColor ) override;
  92
  93     virtual void SAL_CALL setValue( sal_Int32 nValue ) override;
  94
  95     virtual void SAL_CALL setRange(
  96         sal_Int32   nMin    ,
  97         sal_Int32   nMax
  98     ) override;
  99
 100     virtual sal_Int32 SAL_CALL getValue() override;
 101
 102     //  XWindow
 103
 104     virtual void SAL_CALL setPosSize(
 105         sal_Int32   nX      ,
 106         sal_Int32   nY      ,
 107         sal_Int32   nWidth  ,
 108         sal_Int32   nHeight ,
 109         sal_Int16   nFlags
 110     ) override;
 111
 112     //  XControl
 113
 114     virtual sal_Bool SAL_CALL setModel(
 115         const css::uno::Reference< css::awt::XControlModel >& xModel
 116     ) override;
 117
 118     virtual css::uno::Reference< css::awt::XControlModel > SAL_CALL getModel() override;
 119
 120     //  BaseControl
 121
 122     static const css::uno::Sequence< OUString > impl_getStaticSupportedServiceNames();
 123
 124     static const OUString impl_getStaticImplementationName();
 125
 126 protected:
 127
 128     virtual void impl_paint(
 129         sal_Int32 nX ,
 130         sal_Int32 nY ,
 131         const css::uno::Reference< css::awt::XGraphics >& xGraphics
 132     ) override;
 133
 134     void impl_recalcRange();
 135
 136 private:
 137
 138     bool            m_bHorizontal;   // orientation for steps            [true=horizontal/false=vertical]
 139     css::awt::Size  m_aBlockSize;   // width and height of a block      [>=0,0]
 140     sal_Int32       m_nForegroundColor;   //                                  (alpha,r,g,b)
 141     sal_Int32       m_nBackgroundColor;   //                                  (alpha,r,g,b)
 142     sal_Int32       m_nMinRange;   // lowest value  =   0%             [long, <_nMaxRange]
 143     sal_Int32       m_nMaxRange;   // highest value = 100%             [long, >_nMinRange]
 144     double          m_nBlockValue;   // value for one block              [long, >0]
 145     sal_Int32       m_nValue;   // value for progress               [long]
 146
 147 };  // class ProgressBar
 148
 149 }   // namespace unocontrols
 150
 151 #endif // INCLUDED_UNOCONTROLS_SOURCE_INC_PROGRESSBAR_HXX
 152
 153 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */