INTEGRATION: CWS titles02 (1.1.2); FILE ADDED

2007/10/17 08:10:02 as 1.1.2.2: #116375# improve title generation; make autorecovery working (related to titles)
2007/10/12 12:58:42 as 1.1.2.1: #116375# new helper for updating title bar and building title values for different components

1 files changed, 257 insertions, 0 deletions

diff --git a/framework/inc/helper/titlebarupdate.hxx b/framework/inc/helper/titlebarupdate.hxx
new file mode 100644
index 000000000000..165633fdeb8f
--- /dev/null
+++ b/framework/inc/helper/titlebarupdate.hxx
@@ -0,0 +1,257 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: titlebarupdate.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2008-04-04 14:09:32 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 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
+ *
+ ************************************************************************/
+
+#ifndef __FRAMEWORK_HELPER_TITLEBARUPDATE_HXX_
+#define __FRAMEWORK_HELPER_TITLEBARUPDATE_HXX_
+
+//_________________________________________________________________________________________________________________
+//  my own includes
+//_________________________________________________________________________________________________________________
+
+#ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
+#include <threadhelp/threadhelpbase.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_DEBUG_HXX_
+#include <macros/debug.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_XINTERFACE_HXX_
+#include <macros/xinterface.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_XTYPEPROVIDER_HXX_
+#include <macros/xtypeprovider.hxx>
+#endif
+
+#ifndef __FRAMEWORK_GENERAL_H_
+#include <general.h>
+#endif
+
+//_________________________________________________________________________________________________________________
+//  interface includes
+//_________________________________________________________________________________________________________________
+
+#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
+#include <com/sun/star/lang/XMultiServiceFactory.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_LANG_XINITIALIZATION_HPP_
+#include <com/sun/star/lang/XInitialization.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XFRAME_HPP_
+#include <com/sun/star/frame/XFrame.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XTITLE_HPP_
+#include <com/sun/star/frame/XTitle.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XFRAMEACTIONLISTENER_HPP_
+#include <com/sun/star/frame/XFrameActionListener.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XTITLECHANGELISTENER_HPP_
+#include <com/sun/star/frame/XTitleChangeListener.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_LANG_XEVENTLISTENER_HPP_
+#include <com/sun/star/lang/XEventListener.hpp>
+#endif
+
+//_________________________________________________________________________________________________________________
+//  other includes
+//_________________________________________________________________________________________________________________
+
+#ifndef INCLUDED_SVTOOLS_MODULEOPTIONS_HXX
+#include <svtools/moduleoptions.hxx>
+#endif
+
+#ifndef _CPPUHELPER_WEAK_HXX_
+#include <cppuhelper/weak.hxx>
+#endif
+
+#ifndef _RTL_USTRBUF_HXX_
+#include <rtl/ustrbuf.hxx>
+#endif
+
+//_________________________________________________________________________________________________________________
+//  const
+//_________________________________________________________________________________________________________________
+
+//_________________________________________________________________________________________________________________
+//  namespace
+//_________________________________________________________________________________________________________________
+
+namespace framework{
+
+//_________________________________________________________________________________________________________________
+//  declarations
+//_________________________________________________________________________________________________________________
+
+/*-************************************************************************************************************//**
+    @short          helps our frame on setting title/icon on the titlebar (including updates)
+
+    @devstatus      draft
+    @threadsafe     yes
+*//*-*************************************************************************************************************/
+class TitleBarUpdate : // interfaces
+                       public css::lang::XTypeProvider
+                     , public css::lang::XInitialization
+                     , public css::frame::XTitleChangeListener // => XEventListener
+                     , public css::frame::XFrameActionListener // => XEventListener
+                       // baseclasses (order neccessary for right initialization!)
+                     , private ThreadHelpBase
+                     , public  ::cppu::OWeakObject
+{
+    //________________________________
+    // structs, types
+
+    private:
+
+        struct TModuleInfo
+        {
+            /// internal id of this module
+            ::rtl::OUString sID;
+            /// localized name for this module
+            ::rtl::OUString sUIName;
+            /// configured icon for this module
+            ::sal_Int32 nIcon;
+        };
+
+    //________________________________
+    // member
+
+    private:
+
+        /// may we need an uno service manager to create own services
+        css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
+
+        /// reference to the frame which was created by the office himself
+        css::uno::WeakReference< css::frame::XFrame > m_xFrame;
+
+    //________________________________
+    // interface
+
+    public:
+
+        //____________________________
+        // ctor/dtor
+                 TitleBarUpdate(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR);
+        virtual ~TitleBarUpdate(                                                                   );
+
+        //____________________________
+        // XInterface, XTypeProvider
+        FWK_DECLARE_XINTERFACE
+        FWK_DECLARE_XTYPEPROVIDER
+
+        //____________________________
+        // XInitialization
+        virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any >& lArguments)
+            throw(css::uno::Exception       ,
+                  css::uno::RuntimeException);
+
+        //____________________________
+        // XFrameActionListener
+        virtual void SAL_CALL frameAction(const css::frame::FrameActionEvent& aEvent)
+            throw(css::uno::RuntimeException);
+
+        //____________________________
+        // XTitleChangeListener
+        virtual void SAL_CALL titleChanged(const css::frame::TitleChangedEvent& aEvent)
+            throw (css::uno::RuntimeException);
+
+        //____________________________
+        // XEventListener
+        virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent)
+            throw(css::uno::RuntimeException);
+
+    //________________________________
+    // helper
+
+    private:
+
+        //____________________________
+        /** @short  identify the application module, which  is used behind the component
+                    of our frame.
+
+            @param  xFrame
+                    contains the component, wich must be identified.
+
+            @param  rInfo
+                    describe the module in its details.
+                    Is set only if return value is true.
+
+            @return [sal_Bool]
+                    TRUE in casee module could be identified and all needed values could be read.
+                    FALSE otherwise.
+         */
+        ::sal_Bool implst_getModuleInfo(const css::uno::Reference< css::frame::XFrame >& xFrame,
+                                              TModuleInfo&                               rInfo );
+
+        //____________________________
+        /** @short  set a new icon and title on the title bar of our connected frame window.
+
+            @descr  It does not check if an update is realy needed. That has to be done outside.
+                    It retrieves all needed informations and update the title bar - nothing less -
+                    nothing more.
+         */
+        void impl_forceUpdate();
+
+        //____________________________
+        /** @short  identify the current component (inside the connected frame)
+                    and set the right module icon on the title bar.
+
+            @param  xFrame
+                    the frame which contains the component and where the icon must be set
+                    on the window title bar.
+         */
+        void impl_updateIcon(const css::uno::Reference< css::frame::XFrame >& xFrame);
+
+        //____________________________
+        /** @short  gets the current title from the frame and set it on the window.
+
+            @param  xFrame
+                    the frame which contains the component and where the title must be set
+                    on the window title bar.
+         */
+        void impl_updateTitle(const css::uno::Reference< css::frame::XFrame >& xFrame);
+
+}; // class TitleBarUpdate
+
+} // namespace framework
+
+#endif // #ifndef __FRAMEWORK_HELPER_TITLEBARUPDATE_HXX_