include/sfx2/sidebar/ContextChangeBroadcaster.hxx

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 #ifndef SFX_SIDEBAR_CONTEXT_CHANGE_BROADCASTER_HXX
  19 #define SFX_SIDEBAR_CONTEXT_CHANGE_BROADCASTER_HXX
  20
  21 #include <com/sun/star/frame/XFrame.hpp>
  22
  23 namespace css = ::com::sun::star;
  24 namespace cssu = ::com::sun::star::uno;
  25
  26 namespace sfx2 { namespace sidebar {
  27
  28
  29 /** This class is a helper for broadcasting context changes that are
  30     tied to shells being activated or deactivated.
  31 */
  32 class ContextChangeBroadcaster
  33 {
  34 public:
  35     ContextChangeBroadcaster (void);
  36     ~ContextChangeBroadcaster (void);
  37
  38     void Initialize (const ::rtl::OUString& rsContextName);
  39
  40     void Activate (const cssu::Reference<css::frame::XFrame>& rxFrame);
  41     void Deactivate (const cssu::Reference<css::frame::XFrame>& rxFrame);
  42
  43 private:
  44     rtl::OUString msContextName;
  45     bool mbIsContextActive;
  46
  47     void BroadcastContextChange (
  48         const cssu::Reference<css::frame::XFrame>& rxFrame,
  49         const ::rtl::OUString& rsModuleName,
  50         const ::rtl::OUString& rsContextName);
  51     ::rtl::OUString GetModuleName (
  52         const cssu::Reference<css::frame::XFrame>& rxFrame);
  53 };
  54
  55
  56 } } // end of namespace ::sd::sidebar
  57
  58 #endif