148 lines
4.7 KiB
C++
148 lines
4.7 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: MasterPageObserver.hxx,v $
|
|
*
|
|
* $Revision: 1.4 $
|
|
*
|
|
* last change: $Author: rt $ $Date: 2005-09-09 05:08:05 $
|
|
*
|
|
* The Contents of this file are made available subject to
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
|
*
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2005 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
************************************************************************/
|
|
|
|
#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);
|
|
|
|
/** Return a set of the names of master pages for the given document.
|
|
This convenience method exists because this set is part of the
|
|
internal data structure and thus takes no time to create.
|
|
*/
|
|
MasterPageNameSet GetMasterPageNames (SdDrawDocument& rDocument);
|
|
|
|
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
|