office-gobmx/UnoControls/source/inc/progressbar.hxx
Thomas Arnhold 8bb2ce61c0 fixincludeguards.sh: some smaller dirs
Change-Id: Ic25bd678dc299627299b22145efd7bebcf2b39d0
2014-04-19 11:10:13 +02:00

386 lines
9.9 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_UNOCONTROLS_SOURCE_INC_PROGRESSBAR_HXX
#define INCLUDED_UNOCONTROLS_SOURCE_INC_PROGRESSBAR_HXX
#include <com/sun/star/lang/XServiceName.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include "basecontrol.hxx"
// namespaces
namespace unocontrols{
#define PROGRESSBAR_FREESPACE 4
#define PROGRESSBAR_DEFAULT_HORIZONTAL true
#define PROGRESSBAR_DEFAULT_BLOCKDIMENSION Size(1,1)
#define PROGRESSBAR_DEFAULT_BACKGROUNDCOLOR TRGB_COLORDATA( 0x00, 0xC0, 0xC0, 0xC0 ) // lightgray
#define PROGRESSBAR_DEFAULT_FOREGROUNDCOLOR TRGB_COLORDATA( 0x00, 0x00, 0x00, 0x80 ) // blue
#define PROGRESSBAR_DEFAULT_MINRANGE INT_MIN
#define PROGRESSBAR_DEFAULT_MAXRANGE INT_MAX
#define PROGRESSBAR_DEFAULT_BLOCKVALUE 1
#define PROGRESSBAR_DEFAULT_VALUE PROGRESSBAR_DEFAULT_MINRANGE
#define PROGRESSBAR_LINECOLOR_BRIGHT TRGB_COLORDATA( 0x00, 0xFF, 0xFF, 0xFF ) // white
#define PROGRESSBAR_LINECOLOR_SHADOW TRGB_COLORDATA( 0x00, 0x00, 0x00, 0x00 ) // black
class ProgressBar : public ::com::sun::star::awt::XControlModel
, public ::com::sun::star::awt::XProgressBar
, public BaseControl
{
// public methods
public:
// construct/destruct
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
ProgressBar( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext );
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual ~ProgressBar();
// XInterface
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType )
throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
/**_______________________________________________________________________________________________________
@short increment refcount
@seealso XInterface
@seealso release()
@onerror A RuntimeException is thrown.
*/
virtual void SAL_CALL acquire() throw() SAL_OVERRIDE;
/**_______________________________________________________________________________________________________
@short decrement refcount
@seealso XInterface
@seealso acquire()
@onerror A RuntimeException is thrown.
*/
virtual void SAL_CALL release() throw() SAL_OVERRIDE;
// XTypeProvider
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes()
throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// XAggregation
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
::com::sun::star::uno::Any SAL_CALL queryAggregation( const ::com::sun::star::uno::Type& aType )
throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// XProgressBar
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual void SAL_CALL setForegroundColor( sal_Int32 nColor )
throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual void SAL_CALL setBackgroundColor( sal_Int32 nColor )
throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual void SAL_CALL setValue( sal_Int32 nValue ) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual void SAL_CALL setRange(
sal_Int32 nMin ,
sal_Int32 nMax
) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual sal_Int32 SAL_CALL getValue() throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// XWindow
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual void SAL_CALL setPosSize(
sal_Int32 nX ,
sal_Int32 nY ,
sal_Int32 nWidth ,
sal_Int32 nHeight ,
sal_Int16 nFlags
) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// XControl
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual sal_Bool SAL_CALL setModel(
const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >& xModel
) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > SAL_CALL getModel()
throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// BaseControl
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
static const ::com::sun::star::uno::Sequence< OUString > impl_getStaticSupportedServiceNames();
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
static const OUString impl_getStaticImplementationName();
// protected methods
protected:
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
virtual void impl_paint(
sal_Int32 nX ,
sal_Int32 nY ,
const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XGraphics >& xGraphics
) SAL_OVERRIDE;
/**_________________________________________________________________________________________________________
@short
@descr
@seealso
@param
@return
@onerror
*/
void impl_recalcRange();
// private variables
private:
bool m_bHorizontal; // orientation for steps [true=horizontal/false=vertikal]
::com::sun::star::awt::Size m_aBlockSize; // width and height of a block [>=0,0]
sal_Int32 m_nForegroundColor; // (alpha,r,g,b)
sal_Int32 m_nBackgroundColor; // (alpha,r,g,b)
sal_Int32 m_nMinRange; // lowest value = 0% [long, <_nMaxRange]
sal_Int32 m_nMaxRange; // highest value = 100% [long, >_nMinRange]
double m_nBlockValue; // value for one block [long, >0]
sal_Int32 m_nValue; // value for progress [long]
}; // class ProgressBar
} // namespace unocontrols
#endif // INCLUDED_UNOCONTROLS_SOURCE_INC_PROGRESSBAR_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */