summaryrefslogtreecommitdiff
path: root/framework/inc/helper/statusindicator.hxx
diff options
context:
space:
mode:
authorAndreas Schlüns <as@openoffice.org>2001-08-10 10:55:14 +0000
committerAndreas Schlüns <as@openoffice.org>2001-08-10 10:55:14 +0000
commit9431f77bee37974cbfc5b473a6a4d38b814f5064 (patch)
tree71134448d0ff8148c8a408390abf8a46acdea26c /framework/inc/helper/statusindicator.hxx
parente0f6c58c96fd61948f50414066be4da714bf4a69 (diff)
#67297# rename OStatusIndicator/OStatusIndicatorFactory
Diffstat (limited to 'framework/inc/helper/statusindicator.hxx')
-rw-r--r--framework/inc/helper/statusindicator.hxx213
1 files changed, 213 insertions, 0 deletions
diff --git a/framework/inc/helper/statusindicator.hxx b/framework/inc/helper/statusindicator.hxx
new file mode 100644
index 0000000000..2ef78ac748
--- /dev/null
+++ b/framework/inc/helper/statusindicator.hxx
@@ -0,0 +1,213 @@
+/*************************************************************************
+ *
+ * $RCSfile: statusindicator.hxx,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: as $ $Date: 2001-08-10 11:54:03 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 by Sun Microsystems, Inc.
+ * 901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRUNTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRUNTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc..
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef __FRAMEWORK_HELPER_STATUSINDICATOR_HXX_
+#define __FRAMEWORK_HELPER_STATUSINDICATOR_HXX_
+
+//_________________________________________________________________________________________________________________
+// my own includes
+//_________________________________________________________________________________________________________________
+
+#ifndef __FRAMEWORK_HELPER_STATUSINDICATORFACTORY_HXX_
+#include <helper/statusindicatorfactory.hxx>
+#endif
+
+#ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
+#include <threadhelp/threadhelpbase.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_GENERIC_HXX_
+#include <macros/generic.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_XINTERFACE_HXX_
+#include <macros/xinterface.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_XTYPEPROVIDER_HXX_
+#include <macros/xtypeprovider.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_DEBUG_HXX_
+#include <macros/debug.hxx>
+#endif
+
+//_________________________________________________________________________________________________________________
+// interface includes
+//_________________________________________________________________________________________________________________
+
+#ifndef _COM_SUN_STAR_TASK_XSTATUSINDICATOR_HPP_
+#include <com/sun/star/task/XStatusIndicator.hpp>
+#endif
+
+//_________________________________________________________________________________________________________________
+// other includes
+//_________________________________________________________________________________________________________________
+
+#ifndef _CPPUHELPER_WEAK_HXX_
+#include <cppuhelper/weak.hxx>
+#endif
+
+#ifndef _CPPUHELPER_WEAKREF_HXX_
+#include <cppuhelper/weakref.hxx>
+#endif
+
+//_________________________________________________________________________________________________________________
+// namespace
+//_________________________________________________________________________________________________________________
+
+namespace framework{
+
+//_________________________________________________________________________________________________________________
+// exported const
+//_________________________________________________________________________________________________________________
+
+//_________________________________________________________________________________________________________________
+// exported definitions
+//_________________________________________________________________________________________________________________
+
+/*-************************************************************************************************************//**
+ @short implement a status indicator
+ @descr With this indicator you can show a message and a progress ...
+ but you share the output device sometimes with other indicators, if
+ this instances was created by the same factory!
+ Then the last created object has full access to device.
+
+ @implements XInterface
+ XTypeProvider
+ XStatusIndicator
+
+ @base ThreadhelpBase
+ TransactionBase
+ OWeakObject
+
+ @devstatus ready to use
+ @threadsafe yes
+*//*-*************************************************************************************************************/
+class StatusIndicator : public css::lang::XTypeProvider ,
+ public css::task::XStatusIndicator ,
+ private ThreadHelpBase , // Order of baseclasses is neccessary for right initializaton!
+ public ::cppu::OWeakObject // => XInterface
+{
+ //-------------------------------------------------------------------------------------------------------------
+ // public methods
+ //-------------------------------------------------------------------------------------------------------------
+ public:
+
+ //---------------------------------------------------------------------------------------------------------
+ // constructor / destructor
+ //---------------------------------------------------------------------------------------------------------
+ StatusIndicator( StatusIndicatorFactory* pFactory );
+ virtual ~StatusIndicator( );
+
+ //---------------------------------------------------------------------------------------------------------
+ // XInterface, XTypeProvider
+ //---------------------------------------------------------------------------------------------------------
+ DECLARE_XINTERFACE
+ DECLARE_XTYPEPROVIDER
+
+ //---------------------------------------------------------------------------------------------------------
+ // XStatusIndicator
+ //---------------------------------------------------------------------------------------------------------
+ virtual void SAL_CALL start ( const ::rtl::OUString& sText ,
+ sal_Int32 nRange ) throw( css::uno::RuntimeException );
+ virtual void SAL_CALL end ( ) throw( css::uno::RuntimeException );
+ virtual void SAL_CALL reset ( ) throw( css::uno::RuntimeException );
+ virtual void SAL_CALL setText ( const ::rtl::OUString& sText ) throw( css::uno::RuntimeException );
+ virtual void SAL_CALL setValue( sal_Int32 nValue ) throw( css::uno::RuntimeException );
+
+ //-------------------------------------------------------------------------------------------------------------
+ // protected methods
+ //-------------------------------------------------------------------------------------------------------------
+ protected:
+
+ //-------------------------------------------------------------------------------------------------------------
+ // private methods
+ //-------------------------------------------------------------------------------------------------------------
+ private:
+
+ //-------------------------------------------------------------------------------------------------------------
+ // debug methods
+ // (should be private everyway!)
+ //-------------------------------------------------------------------------------------------------------------
+ #ifdef ENABLE_ASSERTIONS
+ private:
+ static sal_Bool implcp_StatusIndicator( StatusIndicatorFactory* pFactory );
+ static sal_Bool implcp_start ( const ::rtl::OUString& sText ,
+ sal_Int32 nRange );
+ static sal_Bool implcp_setText ( const ::rtl::OUString& sText );
+ static sal_Bool implcp_setValue ( sal_Int32 nValue );
+ #endif // #ifdef ENABLE_ASSERTIONS
+
+ //-------------------------------------------------------------------------------------------------------------
+ // variables
+ // (should be private everyway!)
+ //-------------------------------------------------------------------------------------------------------------
+ private:
+
+ css::uno::WeakReference< css::task::XStatusIndicatorFactory > m_xFactoryWeak ; /// Weakreference to factory, which has created us
+ StatusIndicatorFactory* m_pFactory ; /// Pointer to factory ... We use it only, if weakreference is valid!
+
+}; // class StatusIndicator
+
+} // namespace framework
+
+#endif // #ifndef __FRAMEWORK_HELPER_STATUSINDICATOR_HXX_