UnoControls/source/inc/statusindicator.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_STATUSINDICATOR_HXX
  21 #define INCLUDED_UNOCONTROLS_SOURCE_INC_STATUSINDICATOR_HXX
  22
  23 #include <com/sun/star/awt/XControlModel.hpp>
  24 #include <com/sun/star/awt/XFixedText.hpp>
  25 #include <com/sun/star/awt/XGraphics.hpp>
  26 #include <com/sun/star/awt/XLayoutConstrains.hpp>
  27 #include <com/sun/star/awt/XProgressBar.hpp>
  28 #include <com/sun/star/task/XStatusIndicator.hpp>
  29 #include <com/sun/star/awt/XToolkit.hpp>
  30 #include <com/sun/star/awt/XWindowPeer.hpp>
  31 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  32 #include <rtl/ref.hxx>
  33
  34 #include "basecontainercontrol.hxx"
  35
  36 namespace unocontrols{
  37
  38 class ProgressBar;
  39
  40 #define STATUSINDICATOR_FREEBORDER              5                                                       // border around and between the controls
  41 #define FIXEDTEXT_SERVICENAME                   "com.sun.star.awt.UnoControlFixedText"
  42 #define FIXEDTEXT_MODELNAME                     "com.sun.star.awt.UnoControlFixedTextModel"
  43 #define CONTROLNAME_TEXT                        "Text"                                                  // identifier the control in container
  44 #define CONTROLNAME_PROGRESSBAR                 "ProgressBar"                                           //              -||-
  45 #define STATUSINDICATOR_BACKGROUNDCOLOR         TRGB_COLORDATA( 0x00, 0xC0, 0xC0, 0xC0 )                // lighgray
  46 #define STATUSINDICATOR_LINECOLOR_BRIGHT        TRGB_COLORDATA( 0x00, 0xFF, 0xFF, 0xFF )                // white
  47 #define STATUSINDICATOR_LINECOLOR_SHADOW        TRGB_COLORDATA( 0x00, 0x00, 0x00, 0x00 )                // black
  48 #define STATUSINDICATOR_DEFAULT_WIDTH           300
  49 #define STATUSINDICATOR_DEFAULT_HEIGHT          25
  50
  51 //  structs, types
  52
  53 //  class declaration
  54
  55 class StatusIndicator   : public ::com::sun::star::awt::XLayoutConstrains
  56                         , public ::com::sun::star::task::XStatusIndicator
  57                         , public BaseContainerControl
  58 {
  59
  60     //  public methods
  61
  62     public:
  63
  64         //  construct/destruct
  65
  66         /**_______________________________________________________________________________________________________
  67             @short
  68             @descr
  69
  70             @seealso
  71
  72             @param
  73
  74             @return
  75
  76             @onerror
  77         */
  78
  79         StatusIndicator( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext );
  80
  81         /**_______________________________________________________________________________________________________
  82             @short
  83             @descr
  84
  85             @seealso
  86
  87             @param
  88
  89             @return
  90
  91             @onerror
  92         */
  93
  94         virtual ~StatusIndicator();
  95
  96         //  XInterface
  97
  98         /**_______________________________________________________________________________________________________
  99             @short      give answer, if interface is supported
 100             @descr      The interfaces are searched by type.
 101
 102             @seealso    XInterface
 103
 104             @param      "rType" is the type of searched interface.
 105
 106             @return     Any     information about found interface
 107
 108             @onerror    A RuntimeException is thrown.
 109         */
 110
 111         virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType )
 112             throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 113
 114         /**_______________________________________________________________________________________________________
 115             @short      increment refcount
 116             @seealso    XInterface
 117             @seealso    release()
 118             @onerror    A RuntimeException is thrown.
 119         */
 120
 121         virtual void SAL_CALL acquire() throw() SAL_OVERRIDE;
 122
 123         /**_______________________________________________________________________________________________________
 124             @short      decrement refcount
 125             @seealso    XInterface
 126             @seealso    acquire()
 127             @onerror    A RuntimeException is thrown.
 128         */
 129
 130         virtual void SAL_CALL release() throw() SAL_OVERRIDE;
 131
 132         //  XTypeProvider
 133
 134         /**_______________________________________________________________________________________________________
 135             @short      get information about supported interfaces
 136             @seealso    XTypeProvider
 137             @return     Sequence of types of all supported interfaces
 138
 139             @onerror    A RuntimeException is thrown.
 140         */
 141
 142         virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes()
 143             throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 144
 145         //  XAggregation
 146
 147         /**_______________________________________________________________________________________________________
 148         */
 149
 150         virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation( const ::com::sun::star::uno::Type& aType )
 151             throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 152
 153         //  XStatusIndicator
 154
 155         /*-****************************************************************************************************
 156         *//*-*****************************************************************************************************/
 157
 158         virtual void SAL_CALL start(
 159             const OUString&  sText   ,
 160             sal_Int32 nRange
 161         ) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 162
 163         /*-****************************************************************************************************
 164         *//*-*****************************************************************************************************/
 165
 166         virtual void SAL_CALL end() throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 167
 168         /*-****************************************************************************************************
 169         *//*-*****************************************************************************************************/
 170
 171         virtual void SAL_CALL reset() throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 172
 173         /*-****************************************************************************************************
 174         *//*-*****************************************************************************************************/
 175
 176         virtual void SAL_CALL setText( const OUString& sText ) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 177
 178         /*-****************************************************************************************************
 179         *//*-*****************************************************************************************************/
 180
 181         virtual void SAL_CALL setValue( sal_Int32 nValue ) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 182
 183         //  XLayoutConstrains
 184
 185         /**_______________________________________________________________________________________________________
 186         */
 187
 188         virtual ::com::sun::star::awt::Size SAL_CALL getMinimumSize() throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 189
 190         /**_______________________________________________________________________________________________________
 191         */
 192
 193         virtual ::com::sun::star::awt::Size SAL_CALL getPreferredSize() throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 194
 195         /**_______________________________________________________________________________________________________
 196         */
 197
 198         virtual ::com::sun::star::awt::Size SAL_CALL calcAdjustedSize( const ::com::sun::star::awt::Size& aNewSize )
 199             throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 200
 201         //  XControl
 202
 203         /**_______________________________________________________________________________________________________
 204         */
 205
 206         virtual void SAL_CALL createPeer(
 207             const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XToolkit >&    xToolkit    ,
 208             const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindowPeer >& xParent
 209         ) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 210
 211         /**_______________________________________________________________________________________________________
 212         */
 213
 214         virtual sal_Bool SAL_CALL setModel( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >& xModel )
 215             throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 216
 217         /**_______________________________________________________________________________________________________
 218         */
 219
 220         virtual ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > SAL_CALL getModel()
 221             throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 222
 223         //  XComponent
 224
 225         /**_______________________________________________________________________________________________________
 226         */
 227
 228         virtual void SAL_CALL dispose() throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 229
 230         //  XWindow
 231
 232         /**_______________________________________________________________________________________________________
 233         */
 234
 235         virtual void SAL_CALL setPosSize(   sal_Int32   nX      ,
 236                                             sal_Int32   nY      ,
 237                                             sal_Int32   nWidth  ,
 238                                             sal_Int32   nHeight ,
 239                                             sal_Int16   nFlags  ) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 240
 241         //  BaseControl
 242
 243         /**_______________________________________________________________________________________________________
 244         */
 245
 246         static const ::com::sun::star::uno::Sequence< OUString > impl_getStaticSupportedServiceNames();
 247
 248         /**_______________________________________________________________________________________________________
 249         */
 250
 251         static const OUString impl_getStaticImplementationName();
 252
 253 //  protected methods
 254
 255 protected:
 256
 257         /**_______________________________________________________________________________________________________
 258         */
 259
 260         virtual ::com::sun::star::awt::WindowDescriptor* impl_getWindowDescriptor(
 261             const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindowPeer >& xParentPeer
 262         ) SAL_OVERRIDE;
 263
 264         /**_______________________________________________________________________________________________________
 265         */
 266
 267         virtual void impl_paint (
 268             sal_Int32 nX,
 269             sal_Int32 nY,
 270             const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XGraphics > & rGraphics
 271         ) SAL_OVERRIDE;
 272
 273         /**_______________________________________________________________________________________________________
 274         */
 275
 276         virtual void impl_recalcLayout( const ::com::sun::star::awt::WindowEvent& aEvent ) SAL_OVERRIDE;
 277
 278 // debug methods
 279
 280 private:
 281
 282     /**_______________________________________________________________________________________________________
 283     */
 284
 285 // private variables
 286
 287 private:
 288
 289     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XFixedText >       m_xText;
 290     rtl::Reference<ProgressBar> m_xProgressBar;
 291
 292 };  // class StatusIndicator
 293
 294 }   // namespace unocontrols
 295
 296 #endif // INCLUDED_UNOCONTROLS_SOURCE_INC_STATUSINDICATOR_HXX
 297
 298 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */