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 #ifndef INCLUDED_SD_SOURCE_UI_INC_EVENTMULTIPLEXER_HXX
  21 #define INCLUDED_SD_SOURCE_UI_INC_EVENTMULTIPLEXER_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <rtl/ref.hxx>
  26
  27 template <typename Arg, typename Ret> class Link;
  28
  29 namespace sd {
  30 class ViewShellBase;
  31 }
  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
 118 namespace sd { namespace tools {
 119
 120 class EventMultiplexerEvent
 121 {
 122 public:
 123     EventMultiplexerEventId const meEventId;
 124     const void* mpUserData;
 125
 126     EventMultiplexerEvent (
 127         EventMultiplexerEventId eEventId,
 128         const void* pUserData);
 129 };
 130
 131 /** This convenience class makes it easy to listen to various events that
 132     originally are broadcasted via different channels.
 133
 134     There is usually one EventMultiplexer instance per ViewShellBase().
 135     Call the laters GetEventMultiplexer() method to get access to that
 136     instance.
 137 */
 138 class EventMultiplexer
 139 {
 140 public:
 141     /** Create new EventMultiplexer for the given ViewShellBase object.
 142     */
 143     EventMultiplexer (ViewShellBase& rBase);
 144     ~EventMultiplexer();
 145
 146     /** Add an event listener that will be informed about the specified
 147         event types.
 148         @param rCallback
 149             The callback to call as soon as one of the event specified by
 150             aEventTypeSet is received by the EventMultiplexer.
 151     */
 152     void AddEventListener(const Link<EventMultiplexerEvent&,void>& rCallback);
 153
 154     /** Remove an event listener for the specified event types.
 155     */
 156     void RemoveEventListener(const Link<EventMultiplexerEvent&,void>& rCallback);
 157
 158     /** This method is used for out-of-line events.  An event of the
 159         specified type will be sent to all listeners that are registered for
 160         that type.
 161         @param eEventId
 162             The type of the event.
 163         @param pUserData
 164             Some data sent to the listeners along with the event.
 165     */
 166     void MultiplexEvent(
 167         EventMultiplexerEventId eEventId,
 168         void const * pUserData);
 169
 170 private:
 171     class Implementation;
 172     rtl::Reference<Implementation> mpImpl;
 173 };
 174
 175 } } // end of namespace ::sd::tools
 176
 177 #endif
 178
 179 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */