sd/source/ui/inc/EventMultiplexer.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
  20 #pragma once
  21
  22 #include <sal/config.h>
  23
  24 #include <rtl/ref.hxx>
  25 #include <com/sun/star/uno/XInterface.hpp>
  26
  27 template <typename Arg, typename Ret> class Link;
  28
  29 namespace sd
  30 {
  31 class ViewShellBase;
  32 }
  33
  34 enum class EventMultiplexerEventId
  35 {
  36     /** The EventMultiplexer itself is being disposed.  Called for a live
  37         EventMultiplexer.  Removing a listener as response is not necessary,
  38         though.
  39     */
  40     Disposing,
  41
  42     /** The selection in the center pane has changed.
  43     */
  44     EditViewSelection,
  45
  46     /** The selection in the slide sorter has changed, regardless of whether
  47         the slide sorter is displayed in the left pane or the center pane.
  48     */
  49     SlideSortedSelection,
  50
  51     /** The current page has changed.
  52     */
  53     CurrentPageChanged,
  54
  55     /** The current MainViewShell (the ViewShell displayed in the center
  56         pane) has been removed.
  57     */
  58     MainViewRemoved,
  59
  60     /** A new ViewShell has been made the MainViewShell.
  61     */
  62     MainViewAdded,
  63
  64     /** A new ViewShell is being displayed in one of the panes.  Note that
  65         for the ViewShell in the center pane both this event type and
  66         EventId::MainViewAdded is broadcasted.
  67     */
  68     ViewAdded,
  69
  70     /** Edit mode was (or is being) switched to normal mode.  Find
  71         EventId::EditModeMaster below.
  72     */
  73     EditModeNormal,
  74
  75     /** One or more pages have been inserted into or deleted from the model.
  76     */
  77     PageOrder,
  78
  79     /** Text editing in one of the shapes in the MainViewShell has started.
  80     */
  81     BeginTextEdit,
  82
  83     /** Text editing in one of the shapes in the MainViewShell has ended.
  84     */
  85     EndTextEdit,
  86
  87     /** A UNO controller has been attached to the UNO frame.
  88     */
  89     ControllerAttached,
  90
  91     /** A UNO controller has been detached to the UNO frame.
  92     */
  93     ControllerDetached,
  94
  95     /** The state of a shape has changed.  The page is available in the user data.
  96     */
  97     ShapeChanged,
  98
  99     /** A shape has been inserted to a page.  The page is available in the
 100         user data.
 101     */
 102     ShapeInserted,
 103
 104     /** A shape has been removed from a page.  The page is available in the
 105         user data.
 106     */
 107     ShapeRemoved,
 108
 109     /** A configuration update has been completed.
 110     */
 111     ConfigurationUpdated,
 112
 113     /** Edit mode was (or is being) switched to master mode.
 114     */
 115     EditModeMaster,
 116
 117     /** Focus shifted between views.
 118      */
 119     FocusShifted,
 120 };
 121
 122 namespace sd::tools
 123 {
 124 class EventMultiplexerEvent
 125 {
 126 public:
 127     EventMultiplexerEventId meEventId;
 128     const void* mpUserData;
 129     css::uno::Reference<css::uno::XInterface> mxUserData;
 130
 131     EventMultiplexerEvent(EventMultiplexerEventId eEventId, const void* pUserData,
 132                           const css::uno::Reference<css::uno::XInterface>& xUserData = {});
 133 };
 134
 135 /** This convenience class makes it easy to listen to various events that
 136     originally are broadcasted via different channels.
 137
 138     There is usually one EventMultiplexer instance per ViewShellBase().
 139     Call the laters GetEventMultiplexer() method to get access to that
 140     instance.
 141 */
 142 class EventMultiplexer
 143 {
 144 public:
 145     /** Create new EventMultiplexer for the given ViewShellBase object.
 146     */
 147     EventMultiplexer(ViewShellBase& rBase);
 148     ~EventMultiplexer();
 149
 150     /** Add an event listener that will be informed about the specified
 151         event types.
 152         @param rCallback
 153             The callback to call as soon as one of the event specified by
 154             aEventTypeSet is received by the EventMultiplexer.
 155     */
 156     void AddEventListener(const Link<EventMultiplexerEvent&, void>& rCallback);
 157
 158     /** Remove an event listener for the specified event types.
 159     */
 160     void RemoveEventListener(const Link<EventMultiplexerEvent&, void>& rCallback);
 161
 162     /** This method is used for out-of-line events.  An event of the
 163         specified type will be sent to all listeners that are registered for
 164         that type.
 165         @param eEventId
 166             The type of the event.
 167         @param pUserData
 168             Some data sent to the listeners along with the event.
 169     */
 170     void MultiplexEvent(EventMultiplexerEventId eEventId, void const* pUserData,
 171                         const css::uno::Reference<css::uno::XInterface>& xUserData = {});
 172
 173 private:
 174     class Implementation;
 175     rtl::Reference<Implementation> mpImpl;
 176 };
 177
 178 } // end of namespace ::sd::tools
 179
 180 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */