slideshow/source/inc/viewrepainthandler.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: viewrepainthandler.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SLIDESHOW_VIEWREPAINTHANDLER_HXX
  32 #define INCLUDED_SLIDESHOW_VIEWREPAINTHANDLER_HXX
  33
  34 #include <boost/shared_ptr.hpp>
  35 #include <boost/weak_ptr.hpp>
  36
  37 #include "unoview.hxx"
  38
  39
  40 /* Definition of ViewRepaintHandler interface */
  41
  42 namespace slideshow
  43 {
  44     namespace internal
  45     {
  46
  47         /** Interface for handling view repaint events.
  48
  49             Classes implementing this interface can be added to an
  50             EventMultiplexer object, and are called from there to
  51             handle view repaint events.
  52          */
  53         class ViewRepaintHandler
  54         {
  55         public:
  56             virtual ~ViewRepaintHandler() {}
  57
  58             /** Notify clobbered view.
  59
  60                 Reasons for a viewChanged notification can be
  61                 different view size, transformation, or other device
  62                 properties (color resolution or profile, etc.)
  63
  64                 @param rView
  65                 The changed view
  66              */
  67             virtual void viewClobbered( const UnoViewSharedPtr& rView ) = 0;
  68         };
  69
  70         typedef ::boost::shared_ptr< ViewRepaintHandler > ViewRepaintHandlerSharedPtr;
  71         typedef ::boost::weak_ptr< ViewRepaintHandler >   ViewRepaintHandlerWeakPtr;
  72
  73     }
  74 }
  75
  76 #endif /* INCLUDED_SLIDESHOW_VIEWREPAINTHANDLER_HXX */