sfx2/inc/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_INC_SIDEBAR_CONTEXTCHANGEBROADCASTER_HXX
  20 #define INCLUDED_SFX2_INC_SIDEBAR_CONTEXTCHANGEBROADCASTER_HXX
  21
  22 #include <com/sun/star/frame/XFrame.hpp>
  23
  24
  25 namespace sfx2::sidebar {
  26
  27
  28 /** This class is a helper for broadcasting context changes that are
  29     tied to shells being activated or deactivated.
  30 */
  31 class ContextChangeBroadcaster
  32 {
  33 public:
  34     ContextChangeBroadcaster();
  35     ~ContextChangeBroadcaster();
  36
  37     void Initialize (const OUString& rsContextName);
  38
  39     void Activate (const css::uno::Reference<css::frame::XFrame>& rxFrame);
  40     void Deactivate (const css::uno::Reference<css::frame::XFrame>& rxFrame);
  41
  42     /** Enable or disable the broadcaster.
  43         @param bIsEnabled
  44             The new value of the "enabled" state.
  45         @return
  46             The old value of the "enabled" state is returned.
  47     */
  48     bool SetBroadcasterEnabled (const bool bIsEnabled);
  49
  50 private:
  51     OUString msContextName;
  52     bool mbIsBroadcasterEnabled;
  53
  54     void BroadcastContextChange (
  55         const css::uno::Reference<css::frame::XFrame>& rxFrame,
  56         const OUString& rsModuleName,
  57         const OUString& rsContextName);
  58     static OUString GetModuleName (
  59         const css::uno::Reference<css::frame::XFrame>& rxFrame);
  60 };
  61
  62
  63 } // end of namespace ::sd::sidebar
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */