/* -*- 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 . */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace framework; namespace { typedef comphelper::WeakComponentImplHelper< css::lang::XServiceInfo, css::lang::XSingleServiceFactory> TaskCreatorService_BASE; class TaskCreatorService : public TaskCreatorService_BASE { private: /** @short the global uno service manager. @descr Must be used to create own needed services. */ css::uno::Reference< css::uno::XComponentContext > m_xContext; public: explicit TaskCreatorService(css::uno::Reference< css::uno::XComponentContext > xContext); virtual OUString SAL_CALL getImplementationName() override { return "com.sun.star.comp.framework.TaskCreator"; } virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override { return cppu::supportsService(this, ServiceName); } virtual css::uno::Sequence SAL_CALL getSupportedServiceNames() override { return {"com.sun.star.frame.TaskCreator"}; } // XSingleServiceFactory virtual css::uno::Reference< css::uno::XInterface > SAL_CALL createInstance() override; virtual css::uno::Reference< css::uno::XInterface > SAL_CALL createInstanceWithArguments(const css::uno::Sequence< css::uno::Any >& lArguments) override; private: css::uno::Reference< css::awt::XWindow > implts_createContainerWindow( const css::uno::Reference< css::awt::XWindow >& xParentWindow , const css::awt::Rectangle& aPosSize , bool bTopWindow ); void implts_applyDocStyleToWindow(const css::uno::Reference< css::awt::XWindow >& xWindow) const; css::uno::Reference< css::frame::XFrame2 > implts_createFrame( const css::uno::Reference< css::frame::XFrame >& xParentFrame , const css::uno::Reference< css::awt::XWindow >& xContainerWindow , const OUString& sName ); void implts_establishWindowStateListener( const css::uno::Reference< css::frame::XFrame2 >& xFrame ); void implts_establishTitleBarUpdate( const css::uno::Reference< css::frame::XFrame2 >& xFrame ); void implts_establishDocModifyListener( const css::uno::Reference< css::frame::XFrame2 >& xFrame ); OUString impl_filterNames( const OUString& sName ); }; TaskCreatorService::TaskCreatorService(css::uno::Reference< css::uno::XComponentContext > xContext) : m_xContext (std::move(xContext )) { } css::uno::Reference< css::uno::XInterface > SAL_CALL TaskCreatorService::createInstance() { return createInstanceWithArguments(css::uno::Sequence< css::uno::Any >()); } css::uno::Reference< css::uno::XInterface > SAL_CALL TaskCreatorService::createInstanceWithArguments(const css::uno::Sequence< css::uno::Any >& lArguments) { ::comphelper::SequenceAsHashMap lArgs(lArguments); css::uno::Reference< css::frame::XFrame > xParentFrame = lArgs.getUnpackedValueOrDefault(ARGUMENT_PARENTFRAME , css::uno::Reference< css::frame::XFrame >()); OUString sFrameName = lArgs.getUnpackedValueOrDefault(ARGUMENT_FRAMENAME , OUString() ); bool bVisible = lArgs.getUnpackedValueOrDefault(ARGUMENT_MAKEVISIBLE , false ); bool bCreateTopWindow = lArgs.getUnpackedValueOrDefault(ARGUMENT_CREATETOPWINDOW , true ); // only possize=[0,0,0,0] triggers default handling of vcl ! css::awt::Rectangle aPosSize = lArgs.getUnpackedValueOrDefault(ARGUMENT_POSSIZE , css::awt::Rectangle(0, 0, 0, 0) ); css::uno::Reference< css::awt::XWindow > xContainerWindow = lArgs.getUnpackedValueOrDefault(ARGUMENT_CONTAINERWINDOW , css::uno::Reference< css::awt::XWindow >() ); bool bSupportPersistentWindowState = lArgs.getUnpackedValueOrDefault(ARGUMENT_SUPPORTPERSISTENTWINDOWSTATE , false ); bool bEnableTitleBarUpdate = lArgs.getUnpackedValueOrDefault(ARGUMENT_ENABLE_TITLEBARUPDATE , true ); // If the frame is explicitly requested to be hidden. bool bHidden = lArgs.getUnpackedValueOrDefault("HiddenForConversion", false); // We use FrameName property to set it as API name of the new created frame later. // But those frame names must be different from the set of special target names as e.g. _blank, _self etcpp ! OUString sRightName = impl_filterNames(sFrameName); // if no external frame window was given ... create a new one. if ( ! xContainerWindow.is()) { css::uno::Reference< css::awt::XWindow > xParentWindow; if (xParentFrame.is()) xParentWindow = xParentFrame->getContainerWindow(); // Parent has no own window ... // So we have to create a top level window always ! if ( ! xParentWindow.is()) bCreateTopWindow = true; xContainerWindow = implts_createContainerWindow(xParentWindow, aPosSize, bCreateTopWindow); } // #i53630# // Mark all document windows as "special ones", so VCL can bind // special features to it. Because VCL doesn't know anything about documents ... // Note: Doing so it's no longer supported, that e.g. our wizards can use findFrame(_blank) // to create it's previous frames. They must do it manually by using WindowDescriptor+Toolkit! css::uno::Reference< css::frame::XDesktop > xDesktop(xParentFrame, css::uno::UNO_QUERY); bool bTopLevelDocumentWindow = ( sRightName.isEmpty() && ( (! xParentFrame.is() ) || ( xDesktop.is() ) ) ); if (bTopLevelDocumentWindow) implts_applyDocStyleToWindow(xContainerWindow); //-------------------> // create the new frame VclPtr pContainerWindow = VCLUnoHelper::GetWindow(xContainerWindow); if (pContainerWindow && bHidden) { WindowExtendedStyle eStyle = pContainerWindow->GetExtendedStyle(); eStyle |= WindowExtendedStyle::DocHidden; pContainerWindow->SetExtendedStyle(eStyle); } css::uno::Reference< css::frame::XFrame2 > xFrame = implts_createFrame(xParentFrame, xContainerWindow, sRightName); // special freature: // A special listener will restore pos/size states in case // a component was loaded into the frame first time. if (bSupportPersistentWindowState) implts_establishWindowStateListener(xFrame); // special feature: On Mac we need tagging the window in case // the underlying model was modified. // VCL will ignore our calls in case different platform then Mac // is used ... if (bTopLevelDocumentWindow) implts_establishDocModifyListener (xFrame); // special freature: // A special listener will update title bar (text and icon) // if component of frame will be changed. if (bEnableTitleBarUpdate) implts_establishTitleBarUpdate(xFrame); // Make it visible directly here... // if it's required from outside. if (bVisible) xContainerWindow->setVisible(bVisible); return css::uno::Reference< css::uno::XInterface >(xFrame, css::uno::UNO_QUERY_THROW); } void TaskCreatorService::implts_applyDocStyleToWindow(const css::uno::Reference< css::awt::XWindow >& xWindow) const { // SYNCHRONIZED -> SolarMutexGuard aSolarGuard; VclPtr pVCLWindow = VCLUnoHelper::GetWindow(xWindow); if (pVCLWindow) pVCLWindow->SetExtendedStyle(WindowExtendedStyle::Document); // <- SYNCHRONIZED } css::uno::Reference< css::awt::XWindow > TaskCreatorService::implts_createContainerWindow( const css::uno::Reference< css::awt::XWindow >& xParentWindow , const css::awt::Rectangle& aPosSize , bool bTopWindow ) { // get toolkit to create task container window css::uno::Reference< css::awt::XToolkit2 > xToolkit = css::awt::Toolkit::create( m_xContext ); // Check if child frames can be created really. We need at least a valid window at the parent frame ... css::uno::Reference< css::awt::XWindowPeer > xParentWindowPeer; if ( ! bTopWindow) { if ( ! xParentWindow.is()) bTopWindow = false; else xParentWindowPeer.set(xParentWindow, css::uno::UNO_QUERY_THROW); } // describe window properties. css::awt::WindowDescriptor aDescriptor; if (bTopWindow) { aDescriptor.Type = css::awt::WindowClass_TOP; aDescriptor.WindowServiceName = "window"; aDescriptor.ParentIndex = -1; aDescriptor.Parent.clear(); aDescriptor.Bounds = aPosSize; aDescriptor.WindowAttributes = css::awt::WindowAttribute::BORDER | css::awt::WindowAttribute::MOVEABLE | css::awt::WindowAttribute::SIZEABLE | css::awt::WindowAttribute::CLOSEABLE | css::awt::VclWindowPeerAttribute::CLIPCHILDREN; } else { aDescriptor.Type = css::awt::WindowClass_TOP; aDescriptor.WindowServiceName = "dockingwindow"; aDescriptor.ParentIndex = 1; aDescriptor.Parent = xParentWindowPeer; aDescriptor.Bounds = aPosSize; aDescriptor.WindowAttributes = css::awt::VclWindowPeerAttribute::CLIPCHILDREN; } // create a new blank container window and get access to parent container to append new created task. css::uno::Reference< css::awt::XWindowPeer > xPeer = xToolkit->createWindow( aDescriptor ); css::uno::Reference< css::awt::XWindow > xWindow ( xPeer, css::uno::UNO_QUERY_THROW ); sal_Int32 nBackground = 0xffffffff; if (bTopWindow) { try { nBackground = sal_Int32(::svtools::ColorConfig().GetColorValue(::svtools::APPBACKGROUND).nColor); } catch (const css::uno::Exception &) { // Ignore } } xPeer->setBackground(nBackground); return xWindow; } css::uno::Reference< css::frame::XFrame2 > TaskCreatorService::implts_createFrame( const css::uno::Reference< css::frame::XFrame >& xParentFrame , const css::uno::Reference< css::awt::XWindow >& xContainerWindow, const OUString& sName ) { // create new frame. css::uno::Reference< css::frame::XFrame2 > xNewFrame = css::frame::Frame::create( m_xContext ); // Set window on frame. // Do it before calling any other interface methods ... // The new created frame must be initialized before you can do anything else there. xNewFrame->initialize( xContainerWindow ); // Put frame to the frame tree. // Note: The property creator/parent will be set on the new putted frame automatically ... by the parent container. if (xParentFrame.is()) { css::uno::Reference< css::frame::XFramesSupplier > xSupplier (xParentFrame, css::uno::UNO_QUERY_THROW); css::uno::Reference< css::frame::XFrames > xContainer = xSupplier->getFrames(); xContainer->append( css::uno::Reference(xNewFrame, css::uno::UNO_QUERY_THROW) ); } // Set it's API name (if there is one from outside) if (!sName.isEmpty()) xNewFrame->setName( sName ); return xNewFrame; } void TaskCreatorService::implts_establishWindowStateListener( const css::uno::Reference< css::frame::XFrame2 >& xFrame ) { // Special feature: It's allowed for frames using a top level window only! // We must create a special listener service and couple it with the new created task frame. // He will restore or save the window state of it ... // See used classes for further information too. rtl::Reference pPersistentStateHandler = new PersistentWindowState( m_xContext ); css::uno::Sequence< css::uno::Any > lInitData{ css::uno::Any(xFrame) }; pPersistentStateHandler->initialize(lInitData); } void TaskCreatorService::implts_establishDocModifyListener( const css::uno::Reference< css::frame::XFrame2 >& xFrame ) { // Special feature: It's allowed for frames using a top level window only! // We must create a special listener service and couple it with the new created task frame. // It will tag the window as modified if the underlying model was modified ... rtl::Reference pTag = new TagWindowAsModified(); css::uno::Sequence< css::uno::Any > lInitData{ css::uno::Any(xFrame) }; pTag->initialize(lInitData); } void TaskCreatorService::implts_establishTitleBarUpdate( const css::uno::Reference< css::frame::XFrame2 >& xFrame ) { rtl::Reference pHelper = new TitleBarUpdate (m_xContext); css::uno::Sequence< css::uno::Any > lInitData{ css::uno::Any(xFrame) }; pHelper->initialize(lInitData); } OUString TaskCreatorService::impl_filterNames( const OUString& sName ) { OUString sFiltered; if (TargetHelper::isValidNameForFrame(sName)) sFiltered = sName; return sFiltered; } } extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface * com_sun_star_comp_framework_TaskCreator_get_implementation( css::uno::XComponentContext *context, css::uno::Sequence const &) { return cppu::acquire(new TaskCreatorService(context)); } /* vim:set shiftwidth=4 softtabstop=4 expandtab: */