include/sfx2/sidebar/ContextChangeBroadcaster.hxx

   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 #ifndef INCLUDED_SFX2_SIDEBAR_CONTEXTCHANGEBROADCASTER_HXX
  20 #define INCLUDED_SFX2_SIDEBAR_CONTEXTCHANGEBROADCASTER_HXX
  21
  22 #include <com/sun/star/frame/XFrame.hpp>
  23
  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     /** Enable or disable the broadcaster.
  44         @param bIsEnabled
  45             The new value of the "enabled" state.
  46         @return
  47             The old value of the "enabled" state is returned.
  48     */
  49     bool SetBroadcasterEnabled (const bool bIsEnabled);
  50
  51 private:
  52     rtl::OUString msContextName;
  53     bool mbIsBroadcasterEnabled;
  54
  55     void BroadcastContextChange (
  56         const cssu::Reference<css::frame::XFrame>& rxFrame,
  57         const ::rtl::OUString& rsModuleName,
  58         const ::rtl::OUString& rsContextName);
  59     ::rtl::OUString GetModuleName (
  60         const cssu::Reference<css::frame::XFrame>& rxFrame);
  61 };
  62
  63
  64 } } // end of namespace ::sd::sidebar
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */