sd/source/ui/inc/MasterPageObserver.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 <rtl/ustring.hxx>
  23 #include <tools/link.hxx>
  24 #include "tools/SdGlobalResourceContainer.hxx"
  25 #include <memory>
  26 #include <set>
  27
  28 namespace osl
  29 {
  30 class Mutex;
  31 }
  32
  33 class SdDrawDocument;
  34
  35 namespace sd
  36 {
  37 class MasterPageObserverEvent;
  38
  39 /** This singleton observes all registered documents for changes in the used
  40     master pages and in turn informs its listeners about it.  One such
  41     listener is the master page selector control in the tool panel that
  42     shows the recently used master pages.
  43 */
  44 class MasterPageObserver final : public SdGlobalResource
  45 {
  46 public:
  47     typedef ::std::set<OUString> MasterPageNameSet;
  48
  49     /** Return the single instance of this class.
  50     */
  51     static MasterPageObserver& Instance();
  52
  53     /** The master page observer will listen to events of this document and
  54         detect changes of the use of master pages.
  55     */
  56     void RegisterDocument(SdDrawDocument& rDocument);
  57
  58     /** The master page observer will stop to listen to events of this
  59         document.
  60     */
  61     void UnregisterDocument(SdDrawDocument& rDocument);
  62
  63     /** Add a listener that is informed of master pages that are newly
  64         assigned to slides or become unassigned.
  65         @param rEventListener
  66             The event listener to call for future events.  Call
  67             RemoveEventListener() before the listener is destroyed.
  68     */
  69     void AddEventListener(const Link<MasterPageObserverEvent&, void>& rEventListener);
  70
  71     /** Remove the given listener from the list of listeners.
  72         @param rEventListener
  73             After this method returns the given listener is not called back
  74             from this object.  Passing a listener that has not
  75             been registered before is safe and is silently ignored.
  76     */
  77     void RemoveEventListener(const Link<MasterPageObserverEvent&, void>& rEventListener);
  78
  79 private:
  80     class Implementation;
  81     ::std::unique_ptr<Implementation> mpImpl;
  82
  83     MasterPageObserver();
  84     virtual ~MasterPageObserver() override;
  85
  86     MasterPageObserver(const MasterPageObserver&) = delete;
  87
  88     MasterPageObserver& operator=(const MasterPageObserver&) = delete;
  89 };
  90
  91 /** Objects of this class are sent to listeners of the MasterPageObserver
  92     singleton when the list of master pages of one document has changed.
  93 */
  94 class MasterPageObserverEvent
  95 {
  96 public:
  97     enum EventType
  98     {
  99         /// Master page already exists when document is registered.
 100         ET_MASTER_PAGE_EXISTS,
 101         /// Master page has been added to a document.
 102         ET_MASTER_PAGE_ADDED,
 103         /// Master page has been removed from to a document.
 104         ET_MASTER_PAGE_REMOVED
 105     };
 106
 107     EventType meType;
 108     const OUString& mrMasterPageName;
 109
 110     MasterPageObserverEvent(EventType eType, const OUString& rMasterPageName)
 111         : meType(eType)
 112         , mrMasterPageName(rMasterPageName)
 113     {
 114     }
 115 };
 116
 117 } // end of namespace sd
 118
 119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */