1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef SD_VIEW_MASTER_PAGE_OBSERVER_HXX 29*cdf0e10cSrcweir #define SD_VIEW_MASTER_PAGE_OBSERVER_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include "tools/SdGlobalResourceContainer.hxx" 32*cdf0e10cSrcweir #include <osl/mutex.hxx> 33*cdf0e10cSrcweir #include <tools/link.hxx> 34*cdf0e10cSrcweir #include <memory> 35*cdf0e10cSrcweir #include <set> 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir class SdDrawDocument; 38*cdf0e10cSrcweir class String; 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir namespace sd { 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir /** This singleton observes all registered documents for changes in the used 43*cdf0e10cSrcweir master pages and in turn informs its listeners about it. One such 44*cdf0e10cSrcweir listener is the master page selector control in the tool panel that 45*cdf0e10cSrcweir shows the recently used master pages. 46*cdf0e10cSrcweir */ 47*cdf0e10cSrcweir class MasterPageObserver 48*cdf0e10cSrcweir : public SdGlobalResource 49*cdf0e10cSrcweir { 50*cdf0e10cSrcweir public: 51*cdf0e10cSrcweir typedef ::std::set<String> MasterPageNameSet; 52*cdf0e10cSrcweir 53*cdf0e10cSrcweir /** Return the single instance of this class. 54*cdf0e10cSrcweir */ 55*cdf0e10cSrcweir static MasterPageObserver& Instance (void); 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir /** The master page observer will listen to events of this document and 58*cdf0e10cSrcweir detect changes of the use of master pages. 59*cdf0e10cSrcweir */ 60*cdf0e10cSrcweir void RegisterDocument (SdDrawDocument& rDocument); 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir /** The master page observer will stop to listen to events of this 63*cdf0e10cSrcweir document. 64*cdf0e10cSrcweir */ 65*cdf0e10cSrcweir void UnregisterDocument (SdDrawDocument& rDocument); 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir /** Add a listener that is informed of master pages that are newly 68*cdf0e10cSrcweir assigned to slides or become unassigned. 69*cdf0e10cSrcweir @param rEventListener 70*cdf0e10cSrcweir The event listener to call for future events. Call 71*cdf0e10cSrcweir RemoveEventListener() before the listener is destroyed. 72*cdf0e10cSrcweir */ 73*cdf0e10cSrcweir void AddEventListener (const Link& rEventListener); 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir /** Remove the given listener from the list of listeners. 76*cdf0e10cSrcweir @param rEventListener 77*cdf0e10cSrcweir After this method returns the given listener is not called back 78*cdf0e10cSrcweir from this object. Passing a listener that has not 79*cdf0e10cSrcweir been registered before is safe and is silently ignored. 80*cdf0e10cSrcweir */ 81*cdf0e10cSrcweir void RemoveEventListener (const Link& rEventListener); 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir private: 84*cdf0e10cSrcweir static ::osl::Mutex maMutex; 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir class Implementation; 87*cdf0e10cSrcweir ::std::auto_ptr<Implementation> mpImpl; 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir MasterPageObserver (void); 90*cdf0e10cSrcweir virtual ~MasterPageObserver (void); 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir /// The copy constructor is not implemented. Do not use! 93*cdf0e10cSrcweir MasterPageObserver (const MasterPageObserver&); 94*cdf0e10cSrcweir 95*cdf0e10cSrcweir /// The assignment operator is not implemented. Do not use! 96*cdf0e10cSrcweir MasterPageObserver& operator= (const MasterPageObserver&); 97*cdf0e10cSrcweir }; 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir /** Objects of this class are sent to listeners of the MasterPageObserver 103*cdf0e10cSrcweir singleton when the list of master pages of one document has changed. 104*cdf0e10cSrcweir */ 105*cdf0e10cSrcweir class MasterPageObserverEvent 106*cdf0e10cSrcweir { 107*cdf0e10cSrcweir public: 108*cdf0e10cSrcweir enum EventType { 109*cdf0e10cSrcweir /// Master page already exists when document is registered. 110*cdf0e10cSrcweir ET_MASTER_PAGE_EXISTS, 111*cdf0e10cSrcweir /// Master page has been added to a document. 112*cdf0e10cSrcweir ET_MASTER_PAGE_ADDED, 113*cdf0e10cSrcweir /// Master page has been removed from to a document. 114*cdf0e10cSrcweir ET_MASTER_PAGE_REMOVED 115*cdf0e10cSrcweir }; 116*cdf0e10cSrcweir 117*cdf0e10cSrcweir EventType meType; 118*cdf0e10cSrcweir SdDrawDocument& mrDocument; 119*cdf0e10cSrcweir const String& mrMasterPageName; 120*cdf0e10cSrcweir 121*cdf0e10cSrcweir MasterPageObserverEvent ( 122*cdf0e10cSrcweir EventType eType, 123*cdf0e10cSrcweir SdDrawDocument& rDocument, 124*cdf0e10cSrcweir const String& rMasterPageName) 125*cdf0e10cSrcweir : meType(eType), 126*cdf0e10cSrcweir mrDocument(rDocument), 127*cdf0e10cSrcweir mrMasterPageName(rMasterPageName) 128*cdf0e10cSrcweir {} 129*cdf0e10cSrcweir 130*cdf0e10cSrcweir }; 131*cdf0e10cSrcweir 132*cdf0e10cSrcweir } // end of namespace sd 133*cdf0e10cSrcweir 134*cdf0e10cSrcweir #endif 135