UnoControls/source/inc/progressmonitor.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 #pragma once
  21
  22 #include <com/sun/star/awt/XProgressMonitor.hpp>
  23 #include <com/sun/star/awt/XButton.hpp>
  24 #include <com/sun/star/awt/XLayoutConstrains.hpp>
  25 #include <rtl/ref.hxx>
  26
  27 #include <vector>
  28
  29 #include <basecontainercontrol.hxx>
  30
  31 namespace com::sun::star::awt { class XFixedText; }
  32 namespace com::sun::star::awt { class XControlModel; }
  33
  34 namespace unocontrols {
  35
  36 class ProgressBar;
  37
  38 #define PROGRESSMONITOR_FREEBORDER                      10                                                      // border around and between the controls
  39 inline constexpr OUStringLiteral PROGRESSMONITOR_DEFAULT_TOPIC  = u"";
  40 inline constexpr OUStringLiteral PROGRESSMONITOR_DEFAULT_TEXT = u"";
  41 #define PROGRESSMONITOR_LINECOLOR_BRIGHT                sal_Int32(Color( 0xFF, 0xFF, 0xFF ))             // white
  42 #define PROGRESSMONITOR_LINECOLOR_SHADOW                sal_Int32(Color( 0x00, 0x00, 0x00 ))             // black
  43 #define PROGRESSMONITOR_DEFAULT_WIDTH                   350
  44 #define PROGRESSMONITOR_DEFAULT_HEIGHT                  100
  45
  46 /// Item of TextList
  47 struct IMPL_TextlistItem
  48 {
  49     OUString sTopic;          /// Left site of textline in dialog
  50     OUString sText;          /// Right site of textline in dialog
  51 };
  52
  53 class ProgressMonitor final : public css::awt::XLayoutConstrains
  54                         , public css::awt::XButton
  55                         , public css::awt::XProgressMonitor
  56                         , public BaseContainerControl
  57 {
  58 public:
  59     ProgressMonitor( const css::uno::Reference< css::uno::XComponentContext >& rxContext );
  60
  61     virtual ~ProgressMonitor() override;
  62
  63     //  XInterface
  64
  65     /**
  66         @short      give answer, if interface is supported
  67         @descr      The interfaces are searched by type.
  68
  69         @seealso    XInterface
  70
  71         @param      "rType" is the type of searched interface.
  72
  73         @return     Any     information about found interface
  74
  75         @onerror    A RuntimeException is thrown.
  76     */
  77
  78     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;
  79
  80     /**
  81         @short      increment refcount
  82         @seealso    XInterface
  83         @seealso    release()
  84         @onerror    A RuntimeException is thrown.
  85     */
  86
  87     virtual void SAL_CALL acquire() noexcept override;
  88
  89     /**
  90         @short      decrement refcount
  91         @seealso    XInterface
  92         @seealso    acquire()
  93         @onerror    A RuntimeException is thrown.
  94     */
  95
  96     virtual void SAL_CALL release() noexcept override;
  97
  98     //  XTypeProvider
  99
 100     /**
 101         @short      get information about supported interfaces
 102         @seealso    XTypeProvider
 103         @return     Sequence of types of all supported interfaces
 104
 105         @onerror    A RuntimeException is thrown.
 106     */
 107
 108     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
 109
 110     //  XProgressMonitor
 111
 112     /**
 113         @short      add topic to dialog
 114         @descr      Add a topic with a text in right textlist (used for FixedText-member).<BR>
 115                     ( "beforeProgress" fix the right list ). The dialog metric is recalculated.
 116
 117         @seealso    removeText(), updateText()
 118
 119         @param      sTopic              Name of topic<BR>
 120                                          [sTopic != "" && sTopic != NULL]
 121         @param      sText               Value of topic<BR>
 122                                          [sText != "" && sText != NULL]
 123         @param      bbeforeProgress     Position of topic<BR>
 124                                          [True => before progressbar / False => below progressbar]
 125         @onerror    DEBUG   = Assertion<BR>
 126                     RELEASE = nothing
 127     */
 128
 129     virtual void SAL_CALL addText(
 130         const OUString& sTopic ,
 131         const OUString& sText ,
 132         sal_Bool bbeforeProgress
 133     ) override;
 134
 135     virtual void SAL_CALL removeText(
 136         const OUString& sTopic ,
 137         sal_Bool bbeforeProgress
 138     ) override;
 139
 140     virtual void SAL_CALL updateText(
 141         const OUString&  sTopic ,
 142         const OUString&  sText ,
 143         sal_Bool bbeforeProgress
 144     ) override;
 145
 146     //  XProgressBar
 147
 148     virtual void SAL_CALL setForegroundColor( sal_Int32 nColor ) override;
 149
 150     virtual void SAL_CALL setBackgroundColor( sal_Int32 nColor ) override;
 151
 152     virtual void SAL_CALL setValue( sal_Int32 nValue ) override;
 153
 154     virtual void SAL_CALL setRange( sal_Int32   nMin    ,
 155                                     sal_Int32   nMax    ) override;
 156
 157     virtual sal_Int32 SAL_CALL getValue() override;
 158
 159     //  XButton
 160
 161     virtual void SAL_CALL addActionListener(
 162         const css::uno::Reference< css::awt::XActionListener >& xListener
 163     ) override;
 164
 165     virtual void SAL_CALL removeActionListener(
 166         const css::uno::Reference< css::awt::XActionListener >& xListener
 167     ) override;
 168
 169     virtual void SAL_CALL setLabel( const OUString& sLabel ) override;
 170
 171     virtual void SAL_CALL setActionCommand( const OUString& sCommand ) override;
 172
 173     //  XLayoutConstrains
 174
 175     virtual css::awt::Size SAL_CALL getMinimumSize() override;
 176
 177     virtual css::awt::Size SAL_CALL getPreferredSize() override;
 178
 179     virtual css::awt::Size SAL_CALL calcAdjustedSize( const css::awt::Size& aNewSize ) override;
 180
 181     //  XControl
 182
 183     virtual void SAL_CALL createPeer(
 184         const css::uno::Reference< css::awt::XToolkit     >& xToolkit ,
 185         const css::uno::Reference< css::awt::XWindowPeer  >& xParent
 186     ) override;
 187
 188     virtual sal_Bool SAL_CALL setModel( const css::uno::Reference< css::awt::XControlModel >& xModel ) override;
 189
 190     virtual css::uno::Reference< css::awt::XControlModel > SAL_CALL getModel() override;
 191
 192     //  XComponent
 193
 194     virtual void SAL_CALL dispose() override;
 195
 196     //  XWindow
 197
 198     virtual void SAL_CALL setPosSize(   sal_Int32   nX      ,
 199                                         sal_Int32   nY      ,
 200                                         sal_Int32   nWidth  ,
 201                                         sal_Int32   nHeight ,
 202                                         sal_Int16   nFlags  ) override;
 203
 204 private:
 205     virtual void impl_paint( sal_Int32 nX ,
 206                              sal_Int32 nY ,
 207                              const css::uno::Reference< css::awt::XGraphics >& xGraphics ) override;
 208
 209     using BaseControl::impl_recalcLayout;
 210
 211     void impl_recalcLayout();
 212
 213     void impl_rebuildFixedText();
 214
 215     void impl_cleanMemory();
 216
 217     IMPL_TextlistItem* impl_searchTopic( std::u16string_view sTopic , bool bbeforeProgress );
 218
 219 // debug methods
 220
 221     static bool impl_debug_checkParameter( std::u16string_view sTopic, std::u16string_view sText );    // addText, updateText
 222     static bool impl_debug_checkParameter( std::u16string_view rTopic );                           // removeText
 223
 224 // private variables
 225
 226 private:
 227     ::std::vector < IMPL_TextlistItem > maTextlist_Top;         // Elements before progress
 228     css::uno::Reference< css::awt::XFixedText >   m_xTopic_Top;   // (used, if parameter "beforeProgress"=true in "addText, updateText, removeText")
 229     css::uno::Reference< css::awt::XFixedText >   m_xText_Top;
 230
 231     ::std::vector < IMPL_TextlistItem > maTextlist_Bottom;      // Elements below of progress
 232     css::uno::Reference< css::awt::XFixedText >   m_xTopic_Bottom;   // (used, if parameter "beforeProgress"=false in "addText, updateText, removeText")
 233     css::uno::Reference< css::awt::XFixedText >   m_xText_Bottom;
 234
 235     rtl::Reference<ProgressBar>                   m_xProgressBar;
 236     css::uno::Reference< css::awt::XButton >      m_xButton;
 237     css::awt::Rectangle                           m_a3DLine;
 238 };
 239
 240 }
 241
 242
 243 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */