| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef SD_VIEW_MASTER_PAGE_OBSERVER_HXX |
| #define SD_VIEW_MASTER_PAGE_OBSERVER_HXX |
| |
| #include "tools/SdGlobalResourceContainer.hxx" |
| #include <osl/mutex.hxx> |
| #include <tools/link.hxx> |
| #include <memory> |
| #include <set> |
| |
| class SdDrawDocument; |
| class String; |
| |
| namespace sd { |
| |
| /** This singleton observes all registered documents for changes in the used |
| master pages and in turn informs its listeners about it. One such |
| listener is the master page selector control in the tool panel that |
| shows the recently used master pages. |
| */ |
| class MasterPageObserver |
| : public SdGlobalResource |
| { |
| public: |
| typedef ::std::set<String> MasterPageNameSet; |
| |
| /** Return the single instance of this class. |
| */ |
| static MasterPageObserver& Instance (void); |
| |
| /** The master page observer will listen to events of this document and |
| detect changes of the use of master pages. |
| */ |
| void RegisterDocument (SdDrawDocument& rDocument); |
| |
| /** The master page observer will stop to listen to events of this |
| document. |
| */ |
| void UnregisterDocument (SdDrawDocument& rDocument); |
| |
| /** Add a listener that is informed of master pages that are newly |
| assigned to slides or become unassigned. |
| @param rEventListener |
| The event listener to call for future events. Call |
| RemoveEventListener() before the listener is destroyed. |
| */ |
| void AddEventListener (const Link& rEventListener); |
| |
| /** Remove the given listener from the list of listeners. |
| @param rEventListener |
| After this method returns the given listener is not called back |
| from this object. Passing a listener that has not |
| been registered before is safe and is silently ignored. |
| */ |
| void RemoveEventListener (const Link& rEventListener); |
| |
| private: |
| static ::osl::Mutex maMutex; |
| |
| class Implementation; |
| ::std::auto_ptr<Implementation> mpImpl; |
| |
| MasterPageObserver (void); |
| virtual ~MasterPageObserver (void); |
| |
| /// The copy constructor is not implemented. Do not use! |
| MasterPageObserver (const MasterPageObserver&); |
| |
| /// The assignment operator is not implemented. Do not use! |
| MasterPageObserver& operator= (const MasterPageObserver&); |
| }; |
| |
| |
| |
| |
| /** Objects of this class are sent to listeners of the MasterPageObserver |
| singleton when the list of master pages of one document has changed. |
| */ |
| class MasterPageObserverEvent |
| { |
| public: |
| enum EventType { |
| /// Master page already exists when document is registered. |
| ET_MASTER_PAGE_EXISTS, |
| /// Master page has been added to a document. |
| ET_MASTER_PAGE_ADDED, |
| /// Master page has been removed from to a document. |
| ET_MASTER_PAGE_REMOVED |
| }; |
| |
| EventType meType; |
| SdDrawDocument& mrDocument; |
| const String& mrMasterPageName; |
| |
| MasterPageObserverEvent ( |
| EventType eType, |
| SdDrawDocument& rDocument, |
| const String& rMasterPageName) |
| : meType(eType), |
| mrDocument(rDocument), |
| mrMasterPageName(rMasterPageName) |
| {} |
| |
| }; |
| |
| } // end of namespace sd |
| |
| #endif |