framework/source/helper/persistentwindowstate.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <helper/persistentwindowstate.hxx>
  21
  22 #include <com/sun/star/awt/XWindow.hpp>
  23 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  24 #include <com/sun/star/frame/ModuleManager.hpp>
  25
  26 #include <comphelper/lok.hxx>
  27 #include <comphelper/configurationhelper.hxx>
  28 #include <vcl/window.hxx>
  29 #include <vcl/syswin.hxx>
  30
  31 #include <toolkit/helper/vclunohelper.hxx>
  32 #include <vcl/svapp.hxx>
  33 #include <vcl/wrkwin.hxx>
  34
  35 namespace framework{
  36
  37 PersistentWindowState::PersistentWindowState(const css::uno::Reference< css::uno::XComponentContext >& xContext)
  38     : m_xContext              (xContext                     )
  39     , m_bWindowStateAlreadySet(false                    )
  40 {
  41 }
  42
  43 PersistentWindowState::~PersistentWindowState()
  44 {
  45 }
  46
  47 void SAL_CALL PersistentWindowState::initialize(const css::uno::Sequence< css::uno::Any >& lArguments)
  48 {
  49     // check arguments
  50     css::uno::Reference< css::frame::XFrame > xFrame;
  51     if (!lArguments.hasElements())
  52         throw css::lang::IllegalArgumentException(
  53                 "Empty argument list!",
  54                 static_cast< ::cppu::OWeakObject* >(this),
  55                 1);
  56
  57     lArguments[0] >>= xFrame;
  58     if (!xFrame.is())
  59         throw css::lang::IllegalArgumentException(
  60                 "No valid frame specified!",
  61                 static_cast< ::cppu::OWeakObject* >(this),
  62                 1);
  63
  64     {
  65         SolarMutexGuard g;
  66         m_xFrame = xFrame;
  67     }
  68
  69     // start listening
  70     xFrame->addFrameActionListener(this);
  71 }
  72
  73 void SAL_CALL PersistentWindowState::frameAction(const css::frame::FrameActionEvent& aEvent)
  74 {
  75     // We don't want to do this stuff when being used through LibreOfficeKit
  76     if( comphelper::LibreOfficeKit::isActive() )
  77         return;
  78
  79     css::uno::Reference< css::uno::XComponentContext >     xContext;
  80     css::uno::Reference< css::frame::XFrame >              xFrame;
  81     bool                                               bRestoreWindowState;
  82     {
  83         SolarMutexGuard g;
  84         xContext = m_xContext;
  85         xFrame.set(m_xFrame.get(), css::uno::UNO_QUERY);
  86         bRestoreWindowState = !m_bWindowStateAlreadySet;
  87     }
  88
  89     // frame already gone ? We hold it weak only ...
  90     if (!xFrame.is())
  91         return;
  92
  93     // no window -> no position and size available
  94     css::uno::Reference< css::awt::XWindow > xWindow = xFrame->getContainerWindow();
  95     if (!xWindow.is())
  96         return;
  97
  98     // unknown module -> no configuration available!
  99     OUString sModuleName = PersistentWindowState::implst_identifyModule(xContext, xFrame);
 100     if (sModuleName.isEmpty())
 101         return;
 102
 103     switch(aEvent.Action)
 104     {
 105         case css::frame::FrameAction_COMPONENT_ATTACHED :
 106             {
 107                 if (bRestoreWindowState)
 108                 {
 109                     OUString sWindowState = PersistentWindowState::implst_getWindowStateFromConfig(xContext, sModuleName);
 110                     PersistentWindowState::implst_setWindowStateOnWindow(xWindow,sWindowState);
 111                     SolarMutexGuard g;
 112                     m_bWindowStateAlreadySet = true;
 113                 }
 114             }
 115             break;
 116
 117         case css::frame::FrameAction_COMPONENT_REATTACHED :
 118             {
 119                 // nothing todo here, because it's not allowed to change position and size
 120                 // of an already existing frame!
 121             }
 122             break;
 123
 124         case css::frame::FrameAction_COMPONENT_DETACHING :
 125             {
 126                 OUString sWindowState = PersistentWindowState::implst_getWindowStateFromWindow(xWindow);
 127                 PersistentWindowState::implst_setWindowStateOnConfig(xContext, sModuleName, sWindowState);
 128             }
 129             break;
 130         default:
 131             break;
 132     }
 133 }
 134
 135 void SAL_CALL PersistentWindowState::disposing(const css::lang::EventObject&)
 136 {
 137     // nothing todo here - because we hold the frame as weak reference only
 138 }
 139
 140 OUString PersistentWindowState::implst_identifyModule(const css::uno::Reference< css::uno::XComponentContext >& rxContext,
 141                                                              const css::uno::Reference< css::frame::XFrame >&              xFrame)
 142 {
 143     OUString sModuleName;
 144
 145     css::uno::Reference< css::frame::XModuleManager2 > xModuleManager =
 146         css::frame::ModuleManager::create( rxContext );
 147
 148     try
 149     {
 150         sModuleName = xModuleManager->identify(xFrame);
 151     }
 152     catch(const css::uno::RuntimeException&)
 153         { throw; }
 154     catch(const css::uno::Exception&)
 155         { sModuleName.clear(); }
 156
 157     return sModuleName;
 158 }
 159
 160 OUString PersistentWindowState::implst_getWindowStateFromConfig(
 161         const css::uno::Reference< css::uno::XComponentContext >& rxContext,
 162         const OUString& sModuleName)
 163 {
 164     OUString sWindowState;
 165     try
 166     {
 167         ::comphelper::ConfigurationHelper::readDirectKey(rxContext,
 168             "org.openoffice.Setup/",
 169             "Office/Factories/*[\"" + sModuleName + "\"]",
 170             "ooSetupFactoryWindowAttributes",
 171             ::comphelper::EConfigurationModes::ReadOnly) >>= sWindowState;
 172     }
 173     catch(const css::uno::RuntimeException&)
 174         { throw; }
 175     catch(const css::uno::Exception&)
 176         { sWindowState.clear(); }
 177
 178     return sWindowState;
 179 }
 180
 181 void PersistentWindowState::implst_setWindowStateOnConfig(
 182         const css::uno::Reference< css::uno::XComponentContext >& rxContext,
 183         const OUString& sModuleName, const OUString& sWindowState)
 184 {
 185     try
 186     {
 187         ::comphelper::ConfigurationHelper::writeDirectKey(rxContext,
 188             "org.openoffice.Setup/",
 189             "Office/Factories/*[\"" + sModuleName + "\"]",
 190             "ooSetupFactoryWindowAttributes",
 191             css::uno::makeAny(sWindowState),
 192             ::comphelper::EConfigurationModes::Standard);
 193     }
 194     catch(const css::uno::RuntimeException&)
 195         { throw; }
 196     catch(const css::uno::Exception&)
 197         {}
 198 }
 199
 200 OUString PersistentWindowState::implst_getWindowStateFromWindow(const css::uno::Reference< css::awt::XWindow >& xWindow)
 201 {
 202     OUString sWindowState;
 203
 204     if (xWindow.is())
 205     {
 206         // SOLAR SAFE -> ------------------------
 207         SolarMutexGuard aSolarGuard;
 208
 209         VclPtr<vcl::Window> pWindow = VCLUnoHelper::GetWindow(xWindow);
 210         // check for system window is necessary to guarantee correct pointer cast!
 211         if ( pWindow && pWindow->IsSystemWindow() )
 212         {
 213             WindowStateMask const nMask = WindowStateMask::All & ~WindowStateMask::Minimized;
 214             sWindowState = OStringToOUString(
 215                             static_cast<SystemWindow*>(pWindow.get())->GetWindowState(nMask),
 216                             RTL_TEXTENCODING_UTF8);
 217         }
 218         // <- SOLAR SAFE ------------------------
 219     }
 220
 221     return sWindowState;
 222 }
 223
 224 void PersistentWindowState::implst_setWindowStateOnWindow(const css::uno::Reference< css::awt::XWindow >& xWindow     ,
 225                                                           const OUString&                          sWindowState)
 226 {
 227     if (
 228         (!xWindow.is()                ) ||
 229         ( sWindowState.isEmpty() )
 230        )
 231         return;
 232
 233     // SOLAR SAFE -> ------------------------
 234     SolarMutexGuard aSolarGuard;
 235
 236     VclPtr<vcl::Window> pWindow = VCLUnoHelper::GetWindow(xWindow);
 237     if (!pWindow)
 238         return;
 239
 240     // check for system and work window - it's necessary to guarantee correct pointer cast!
 241     bool bSystemWindow = pWindow->IsSystemWindow();
 242     bool bWorkWindow   = (pWindow->GetType() == WindowType::WORKWINDOW);
 243
 244     if (!bSystemWindow && !bWorkWindow)
 245         return;
 246
 247     SystemWindow* pSystemWindow = static_cast<SystemWindow*>(pWindow.get());
 248     WorkWindow*   pWorkWindow   = static_cast<WorkWindow*  >(pWindow.get());
 249
 250     // don't save this special state!
 251     if (pWorkWindow->IsMinimized())
 252         return;
 253
 254     OUString sOldWindowState = OStringToOUString( pSystemWindow->GetWindowState(), RTL_TEXTENCODING_ASCII_US );
 255     if ( sOldWindowState != sWindowState )
 256         pSystemWindow->SetWindowState(OUStringToOString(sWindowState,RTL_TEXTENCODING_UTF8));
 257     // <- SOLAR SAFE ------------------------
 258 }
 259
 260 } // namespace framework
 261
 262 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */