slideshow/source/inc/vieweventhandler.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: vieweventhandler.hxx,v $
  10  * $Revision: 1.4 $
  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_VIEWEVENTHANDLER_HXX
  32 #define INCLUDED_SLIDESHOW_VIEWEVENTHANDLER_HXX
  33
  34 #include <boost/shared_ptr.hpp>
  35 #include <boost/weak_ptr.hpp>
  36
  37 #include "unoview.hxx"
  38
  39
  40 /* Definition of ViewEventHandler interface */
  41
  42 namespace slideshow
  43 {
  44     namespace internal
  45     {
  46
  47         /** Interface for handling view events.
  48
  49             Classes implementing this interface can be added to an
  50             EventMultiplexer object, and are called from there to
  51             handle view events.
  52          */
  53         class ViewEventHandler
  54         {
  55         public:
  56             virtual ~ViewEventHandler() {}
  57
  58             /** Notify new view.
  59
  60                 @param rView
  61                 The newly added view
  62              */
  63             virtual void viewAdded( const UnoViewSharedPtr& rView ) = 0;
  64
  65             /** Notify removed view.
  66
  67                 @param rView
  68                 The removed view
  69              */
  70             virtual void viewRemoved( const UnoViewSharedPtr& rView ) = 0;
  71
  72             /** Notify changed view.
  73
  74                 Reasons for a viewChanged notification can be
  75                 different view size, transformation, or other device
  76                 properties (color resolution or profile, etc.)
  77
  78                 @param rView
  79                 The changed view
  80              */
  81             virtual void viewChanged( const UnoViewSharedPtr& rView ) = 0;
  82
  83             /** Notify that all views changed.
  84
  85                 Reasons for a viewChanged notification can be
  86                 different view size, transformation, or other device
  87                 properties (color resolution or profile, etc.)
  88
  89                 Note that this method avoids hidden inefficiencies
  90                 (O(n^2) behaviour when viewChanged() needs to perform
  91                 linear searches)
  92              */
  93             virtual void viewsChanged() = 0;
  94         };
  95
  96         typedef ::boost::shared_ptr< ViewEventHandler > ViewEventHandlerSharedPtr;
  97         typedef ::boost::weak_ptr< ViewEventHandler >   ViewEventHandlerWeakPtr;
  98
  99     }
 100 }
 101
 102 #endif /* INCLUDED_SLIDESHOW_VIEWEVENTHANDLER_HXX */