office-gobmx/basctl/source/inc/doceventnotifier.hxx

105 lines
4 KiB
C++
Raw Normal View History

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: doceventnotifier.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: kz $ $Date: 2007-10-09 15:25:16 $
*
* 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 BASCTL_DOCEVENTNOTIFIER_HXX
#define BASCTL_DOCEVENTNOTIFIER_HXX
/** === begin UNO includes === **/
#include <com/sun/star/frame/XModel.hpp>
/** === end UNO includes === **/
#include <rtl/ref.hxx>
#include <boost/noncopyable.hpp>
//........................................................................
namespace basctl
{
//........................................................................
class ScriptDocument;
//====================================================================
//= DocumentEventListener
//====================================================================
class SAL_NO_VTABLE DocumentEventListener : ::boost::noncopyable
{
public:
virtual void onDocumentCreated( const ScriptDocument& _rDocument ) = 0;
virtual void onDocumentOpened( const ScriptDocument& _rDocument ) = 0;
virtual void onDocumentSave( const ScriptDocument& _rDocument ) = 0;
virtual void onDocumentSaveDone( const ScriptDocument& _rDocument ) = 0;
virtual void onDocumentSaveAs( const ScriptDocument& _rDocument ) = 0;
virtual void onDocumentSaveAsDone( const ScriptDocument& _rDocument ) = 0;
virtual void onDocumentClosed( const ScriptDocument& _rDocument ) = 0;
virtual void onDocumentTitleChanged( const ScriptDocument& _rDocument ) = 0;
virtual void onDocumentModeChanged( const ScriptDocument& _rDocument ) = 0;
virtual ~DocumentEventListener();
};
//====================================================================
//= DocumentEventNotifier
//====================================================================
class DocumentEventNotifier_Impl;
/** allows registering at the GlobalEventBroadcaster for global document events
*/
class DocumentEventNotifier
{
public:
/** create a notifier instance which notifies about events of all documents in the whole application
*/
DocumentEventNotifier( DocumentEventListener& _rListener );
/** creates a notifier instance which notifies about events at a single document
*/
DocumentEventNotifier( DocumentEventListener& _rListener,
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxDocument );
~DocumentEventNotifier();
public:
void dispose();
private:
::rtl::Reference< DocumentEventNotifier_Impl > m_pImpl;
};
//........................................................................
} // namespace basctl
//........................................................................
#endif // BASCTL_DOCEVENTNOTIFIER_HXX