dockingwindows: #i112595# First refactoring version of the layout manager including skeleton classes for new docking windows

1 files changed, 318 insertions, 0 deletions

diff --git a/framework/source/layoutmanager/toolbarlayoutmanager.hxx b/framework/source/layoutmanager/toolbarlayoutmanager.hxx
new file mode 100755
index 000000000000..95b27f69c9c9
--- /dev/null
+++ b/framework/source/layoutmanager/toolbarlayoutmanager.hxx
@@ -0,0 +1,318 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: layoutmanager.hxx,v $
+ * $Revision: 1.34 $
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org 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 version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __FRAMEWORK_LAYOUTMANAGER_TOOLBARLAYOUTMANAGER_HXX_
+#define __FRAMEWORK_LAYOUTMANAGER_TOOLBARLAYOUTMANAGER_HXX_
+
+/** Attention: stl headers must(!) be included at first. Otherwhise it can make trouble
+               with solaris headers ...
+*/
+#include <vector>
+
+//_________________________________________________________________________________________________________________
+//  my own includes
+//_________________________________________________________________________________________________________________
+#include <threadhelp/threadhelpbase.hxx>
+#include <threadhelp/resetableguard.hxx>
+#include <threadhelp/writeguard.hxx>
+#include <threadhelp/readguard.hxx>
+#include <macros/generic.hxx>
+#include <macros/xinterface.hxx>
+#include <macros/xtypeprovider.hxx>
+#include <macros/xserviceinfo.hxx>
+#include <stdtypes.h>
+#include <properties.h>
+#include <stdtypes.h>
+#include <uiconfiguration/globalsettings.hxx>
+#include <uiconfiguration/windowstateconfiguration.hxx>
+#include <classes/addonsoptions.hxx>
+#include <uielement/uielement.hxx>
+#include <uielement/menubarmanager.hxx>
+
+//_________________________________________________________________________________________________________________
+//  interface includes
+//_________________________________________________________________________________________________________________
+#include <com/sun/star/lang/XServiceInfo.hpp>
+#include <com/sun/star/lang/XTypeProvider.hpp>
+#include <com/sun/star/frame/XLayoutManager.hpp>
+#include <com/sun/star/ui/XUIConfigurationManager.hpp>
+#include <com/sun/star/ui/XUIConfiguration.hpp>
+#include <com/sun/star/frame/XModuleManager.hpp>
+#include <com/sun/star/frame/XFrameActionListener.hpp>
+#include <com/sun/star/awt/XWindowListener.hpp>
+#include <com/sun/star/util/XURLTransformer.hpp>
+#include <com/sun/star/ui/XUIElementFactory.hpp>
+#include <com/sun/star/frame/XInplaceLayout.hpp>
+#include <com/sun/star/ui/DockingArea.hpp>
+#include <com/sun/star/awt/XTopWindow2.hpp>
+#include <com/sun/star/awt/XWindow2.hpp>
+#include <com/sun/star/awt/XDockableWindow.hpp>
+#include <com/sun/star/awt/XDockableWindowListener.hpp>
+#include <com/sun/star/frame/XMenuBarMergingAcceptor.hpp>
+#include <com/sun/star/frame/XLayoutManagerEventBroadcaster.hpp>
+
+//_________________________________________________________________________________________________________________
+//  other includes
+//_________________________________________________________________________________________________________________
+
+#include <cppuhelper/implbase2.hxx>
+
+
+namespace framework
+{
+
+class ToolbarLayoutManager : public ::cppu::WeakImplHelper2< ::com::sun::star::awt::XDockableWindowListener,
+                                                             ::com::sun::star::ui::XUIConfigurationListener >,
+                             private ThreadHelpBase // Struct for right initalization of mutex member! Must be first of baseclasses.
+{
+    public:
+        enum { DOCKINGAREAS_COUNT = 4 };
+
+        ToolbarLayoutManager( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xSMGR,
+                              const ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIElementFactory >& xUIElementFactory );
+        virtual ~ToolbarLayoutManager();
+
+        void reset();
+        void attach( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& xFrame,
+                     const ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIConfigurationManager >& xModuleCfgMgr,
+                     const ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIConfigurationManager >& xDocCfgMgr,
+                     const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& xPersistentWindowState );
+
+        void setParentWindow( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindowPeer >& xParentWindow );
+        void setDockingAreaOffsets( const ::Rectangle aOffsets );
+
+        void resetDockingArea();
+
+        ::com::sun::star::awt::Rectangle getDockingArea();
+        void setDockingArea( const ::com::sun::star::awt::Rectangle& rDockingArea );
+
+        bool isLayoutDirty();
+        void doLayout(const ::Size& aContainerSize);
+
+        void createToolbars();
+        void destroyToolbars();
+
+        bool createToolbar( const ::rtl::OUString& rResourceURL );
+        bool destroyToolbar( const ::rtl::OUString& rResourceURL );
+        void implts_createNonContextSensitiveToolBars();
+
+        // docking API
+        void dockToolbar( const ::rtl::OUString& rResourceURL, ::com::sun::star::ui::DockingArea eDockingArea, const ::com::sun::star::awt::Point& aPos );
+
+        //---------------------------------------------------------------------------------------------------------
+        //  XInterface
+        //---------------------------------------------------------------------------------------------------------
+        virtual void SAL_CALL acquire() throw();
+        virtual void SAL_CALL release() throw();
+        virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType ) throw( ::com::sun::star::uno::RuntimeException );
+
+        //---------------------------------------------------------------------------------------------------------
+        //  XEventListener
+        //---------------------------------------------------------------------------------------------------------
+        virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException );
+
+        //---------------------------------------------------------------------------------------------------------
+        //  XDockableWindowListener
+        //---------------------------------------------------------------------------------------------------------
+        virtual void SAL_CALL startDocking( const ::com::sun::star::awt::DockingEvent& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual ::com::sun::star::awt::DockingData SAL_CALL docking( const ::com::sun::star::awt::DockingEvent& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL endDocking( const ::com::sun::star::awt::EndDockingEvent& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual sal_Bool SAL_CALL prepareToggleFloatingMode( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL toggleFloatingMode( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL closed( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL endPopupMode( const ::com::sun::star::awt::EndPopupModeEvent& e ) throw (::com::sun::star::uno::RuntimeException);
+
+        //---------------------------------------------------------------------------------------------------------
+        //  XUIConfigurationListener
+        //---------------------------------------------------------------------------------------------------------
+        virtual void SAL_CALL elementInserted( const ::com::sun::star::ui::ConfigurationEvent& Event ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL elementRemoved( const ::com::sun::star::ui::ConfigurationEvent& Event ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL elementReplaced( const ::com::sun::star::ui::ConfigurationEvent& Event ) throw (::com::sun::star::uno::RuntimeException);
+
+        //---------------------------------------------------------------------------------------------------------
+        // XLayoutManager forwards
+        //---------------------------------------------------------------------------------------------------------
+        void SAL_CALL createElement( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
+        void SAL_CALL destroyElement( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
+        ::sal_Bool SAL_CALL requestElement( const ::rtl::OUString& ResourceURL ) throw (::com::sun::star::uno::RuntimeException);
+        ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIElement > SAL_CALL getElement( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
+        ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIElement > > SAL_CALL getElements(  ) throw (::com::sun::star::uno::RuntimeException);
+        sal_Bool SAL_CALL showElement( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
+        sal_Bool SAL_CALL hideElement( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
+        sal_Bool SAL_CALL dockWindow( const ::rtl::OUString& aName, ::com::sun::star::ui::DockingArea DockingArea, const ::com::sun::star::awt::Point& Pos ) throw (::com::sun::star::uno::RuntimeException);
+        ::sal_Bool SAL_CALL dockAllWindows( ::sal_Int16 nElementType ) throw (::com::sun::star::uno::RuntimeException);
+        sal_Bool SAL_CALL floatWindow( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
+        ::sal_Bool SAL_CALL lockWindow( const ::rtl::OUString& ResourceURL ) throw (::com::sun::star::uno::RuntimeException);
+        ::sal_Bool SAL_CALL unlockWindow( const ::rtl::OUString& ResourceURL ) throw (::com::sun::star::uno::RuntimeException);
+        void SAL_CALL setElementSize( const ::rtl::OUString& aName, const ::com::sun::star::awt::Size& aSize ) throw (::com::sun::star::uno::RuntimeException);
+        void SAL_CALL setElementPos( const ::rtl::OUString& aName, const ::com::sun::star::awt::Point& aPos ) throw (::com::sun::star::uno::RuntimeException);
+        void SAL_CALL setElementPosSize( const ::rtl::OUString& aName, const ::com::sun::star::awt::Point& aPos, const ::com::sun::star::awt::Size& aSize ) throw (::com::sun::star::uno::RuntimeException);
+        sal_Bool SAL_CALL isElementVisible( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
+        sal_Bool SAL_CALL isElementFloating( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
+        sal_Bool SAL_CALL isElementDocked( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
+        ::sal_Bool SAL_CALL isElementLocked( const ::rtl::OUString& ResourceURL ) throw (::com::sun::star::uno::RuntimeException);
+        ::com::sun::star::awt::Size SAL_CALL getElementSize( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
+        ::com::sun::star::awt::Point SAL_CALL getElementPos( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
+
+    private:
+        enum DockingOperation
+        {
+            DOCKOP_BEFORE_COLROW,
+            DOCKOP_ON_COLROW,
+            DOCKOP_AFTER_COLROW
+        };
+
+        typedef std::vector< UIElement > UIElementVector;
+        struct SingleRowColumnWindowData
+        {
+            SingleRowColumnWindowData() : nVarSize( 0 ), nStaticSize( 0 ), nSpace( 0 ) {}
+
+            std::vector< rtl::OUString >                                                      aUIElementNames;
+            std::vector< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow > > aRowColumnWindows;
+            std::vector< ::com::sun::star::awt::Rectangle >                                   aRowColumnWindowSizes;
+            std::vector< sal_Int32 >                                                          aRowColumnSpace;
+            ::com::sun::star::awt::Rectangle                                                  aRowColumnRect;
+            sal_Int32                                                                         nVarSize;
+            sal_Int32                                                                         nStaticSize;
+            sal_Int32                                                                         nSpace;
+            sal_Int32                                                                         nRowColumn;
+        };
+
+        //---------------------------------------------------------------------------------------------------------
+        // internal helper methods
+        //---------------------------------------------------------------------------------------------------------
+        bool             implts_isParentWindowVisible() const;
+        ::Rectangle      implts_calcDockingArea();
+        void             implts_sortUIElements();
+        void             implts_reparentToolbars();
+        rtl::OUString    implts_generateGenericAddonToolbarTitle( sal_Int32 nNumber ) const;
+        void             implts_setElementData( UIElement& rUIElement, const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XDockableWindow >& rDockWindow );
+        void             implts_destroyDockingAreaWindows();
+
+        //---------------------------------------------------------------------------------------------------------
+        // layout methods
+        //---------------------------------------------------------------------------------------------------------
+        void             implts_setDockingAreaWindowSizes( const ::com::sun::star::awt::Rectangle& rBorderSpace );
+        ::Point          implts_findNextCascadeFloatingPos();
+        void             implts_renumberRowColumnData( ::com::sun::star::ui::DockingArea eDockingArea, DockingOperation eDockingOperation, const UIElement& rUIElement );
+        void             implts_calcWindowPosSizeOnSingleRowColumn( sal_Int32 nDockingArea,
+                                                                    sal_Int32 nOffset,
+                                                                    SingleRowColumnWindowData& rRowColumnWindowData,
+                                                                    const ::Size& rContainerSize );
+
+        //---------------------------------------------------------------------------------------------------------
+        // lookup/container methods
+        //---------------------------------------------------------------------------------------------------------
+        UIElement        implts_findElement( const rtl::OUString& aName );
+        UIElement        implts_findElement( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& xToolbar );
+        UIElement&       impl_findElement( const rtl::OUString& aName );
+        bool             implts_insertElement( const UIElement& rUIElement );
+        void             implts_setElement( const UIElement& rUIElement );
+        ::Size           implts_getTopBottomDockingAreaSizes();
+
+        //---------------------------------------------------------------------------------------------------------
+        // internal docking methods
+        //---------------------------------------------------------------------------------------------------------
+        ::Rectangle      implts_calcHotZoneRect( const ::Rectangle& rRect, sal_Int32 nHotZoneOffset );
+        void             implts_calcDockingPosSize( UIElement& aUIElement, DockingOperation& eDockOperation, ::Rectangle& rTrackingRect, const Point& rMousePos );
+        DockingOperation implts_determineDockingOperation( ::com::sun::star::ui::DockingArea DockingArea, const ::Rectangle& rRowColRect, const Point& rMousePos );
+        ::Rectangle      implts_getWindowRectFromRowColumn( ::com::sun::star::ui::DockingArea DockingArea, const SingleRowColumnWindowData& rRowColumnWindowData, const ::Point& rMousePos, const rtl::OUString& rExcludeElementName );
+        ::Rectangle      implts_determineFrontDockingRect( ::com::sun::star::ui::DockingArea eDockingArea,
+                                                           sal_Int32 nRowCol,
+                                                           const ::Rectangle& rDockedElementRect,
+                                                           const ::rtl::OUString& rMovedElementName,
+                                                           const ::Rectangle& rMovedElementRect );
+        ::Rectangle      implts_calcTrackingAndElementRect( ::com::sun::star::ui::DockingArea eDockingArea,
+                                                            sal_Int32 nRowCol,
+                                                            UIElement& rUIElement,
+                                                            const ::Rectangle& rTrackingRect,
+                                                            const ::Rectangle& rRowColumnRect,
+                                                            const ::Size& rContainerWinSize );
+
+        void             implts_getDockingAreaElementInfos( ::com::sun::star::ui::DockingArea DockingArea, std::vector< SingleRowColumnWindowData >& rRowColumnsWindowData );
+        void             implts_getDockingAreaElementInfoOnSingleRowCol( ::com::sun::star::ui::DockingArea, sal_Int32 nRowCol, SingleRowColumnWindowData& rRowColumnWindowData );
+        void             implts_findNextDockingPos( ::com::sun::star::ui::DockingArea DockingArea, const ::Size& aUIElementSize, ::Point& rVirtualPos, ::Point& rPixelPos );
+        void             implts_setTrackingRect( ::com::sun::star::ui::DockingArea eDockingArea, const ::Point& rMousePos, ::Rectangle& rTrackingRect );
+
+        //---------------------------------------------------------------------------------------------------------
+        // creation methods
+        //---------------------------------------------------------------------------------------------------------
+        void             implts_createAddonsToolBars();
+        void             implts_createCustomToolBars();
+//        void             implts_createNonContextSensitiveToolBars();
+        void             implts_createCustomToolBars( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > >& aCustomTbxSeq );
+        void             implts_createCustomToolBar( const rtl::OUString& aTbxResName, const rtl::OUString& aTitle );
+        void             implts_createElement( const ::rtl::OUString& aName, bool& bNotify, ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIElement >& rUIElement );
+        css::uno::Reference< css::ui::XUIElement > implts_createElement( const ::rtl::OUString& aName );
+
+        //---------------------------------------------------------------------------------------------------------
+        // persistence methods
+        //---------------------------------------------------------------------------------------------------------
+        sal_Bool         implts_readWindowStateData( const rtl::OUString& aName, UIElement& rElementData );
+        void             implts_writeWindowStateData( const rtl::OUString& aName, const UIElement& rElementData );
+
+        //---------------------------------------------------------------------------------------------------------
+        // members
+        //---------------------------------------------------------------------------------------------------------
+        css::uno::Reference< css::lang::XMultiServiceFactory >                      m_xSMGR;
+        css::uno::Reference< css::frame::XFrame >                                   m_xFrame;
+        css::uno::Reference< css::awt::XWindow2 >                                   m_xContainerWindow;
+        css::uno::Reference< css::awt::XWindow >                                    m_xDockAreaWindows[DOCKINGAREAS_COUNT];
+        css::uno::Reference< ::com::sun::star::ui::XUIElementFactory >              m_xUIElementFactoryManager;
+        css::uno::Reference< ::com::sun::star::ui::XUIConfigurationManager >        m_xModuleCfgMgr;
+        css::uno::Reference< ::com::sun::star::ui::XUIConfigurationManager >        m_xDocCfgMgr;
+        css::uno::Reference< ::com::sun::star::awt::XToolkit >                      m_xToolkit;
+        css::uno::Reference< ::com::sun::star::container::XNameAccess >             m_xPersistentWindowState;
+
+        UIElementVector                                                             m_aUIElements;
+        UIElement                                                                   m_aDockUIElement;
+        Point                                                                       m_aStartDockMousePos;
+        Rectangle                                                                   m_aDockingArea;
+        Rectangle                                                                   m_aDockingAreaOffsets;
+        DockingOperation                                                            m_eDockOperation;
+
+        AddonsOptions*                                                              m_pAddonOptions;
+        GlobalSettings*                                                             m_pGlobalSettings;
+
+        bool                                                                        m_bComponentAttached;
+        bool                                                                        m_bMustLayout;
+        bool                                                                        m_bLayoutDirty;
+        bool                                                                        m_bStoreWindowState;
+        bool                                                                        m_bGlobalSettings;
+        bool                                                                        m_bDockingInProgress;
+
+        ::rtl::OUString                                                             m_aFullAddonTbxPrefix;
+        ::rtl::OUString                                                             m_aCustomTbxPrefix;
+        ::rtl::OUString                                                             m_aCustomizeCmd;
+};
+
+} // namespace framework
+
+#endif // __FRAMEWORK_LAYOUTMANAGER_TOOLBARLAYOUTMANAGER_HXX_