Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef INCLUDED_SLIDESHOW_VIEWEVENTHANDLER_HXX
      21             : #define INCLUDED_SLIDESHOW_VIEWEVENTHANDLER_HXX
      22             : 
      23             : #include <boost/shared_ptr.hpp>
      24             : #include <boost/weak_ptr.hpp>
      25             : 
      26             : #include "unoview.hxx"
      27             : 
      28             : 
      29             : /* Definition of ViewEventHandler interface */
      30             : 
      31             : namespace slideshow
      32             : {
      33             :     namespace internal
      34             :     {
      35             : 
      36             :         /** Interface for handling view events.
      37             : 
      38             :             Classes implementing this interface can be added to an
      39             :             EventMultiplexer object, and are called from there to
      40             :             handle view events.
      41             :          */
      42           0 :         class ViewEventHandler
      43             :         {
      44             :         public:
      45           0 :             virtual ~ViewEventHandler() {}
      46             : 
      47             :             /** Notify new view.
      48             : 
      49             :                 @param rView
      50             :                 The newly added view
      51             :              */
      52             :             virtual void viewAdded( const UnoViewSharedPtr& rView ) = 0;
      53             : 
      54             :             /** Notify removed view.
      55             : 
      56             :                 @param rView
      57             :                 The removed view
      58             :              */
      59             :             virtual void viewRemoved( const UnoViewSharedPtr& rView ) = 0;
      60             : 
      61             :             /** Notify changed view.
      62             : 
      63             :                 Reasons for a viewChanged notification can be
      64             :                 different view size, transformation, or other device
      65             :                 properties (color resolution or profile, etc.)
      66             : 
      67             :                 @param rView
      68             :                 The changed view
      69             :              */
      70             :             virtual void viewChanged( const UnoViewSharedPtr& rView ) = 0;
      71             : 
      72             :             /** Notify that all views changed.
      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             :                 Note that this method avoids hidden inefficiencies
      79             :                 (O(n^2) behaviour when viewChanged() needs to perform
      80             :                 linear searches)
      81             :              */
      82             :             virtual void viewsChanged() = 0;
      83             :         };
      84             : 
      85             :         typedef ::boost::shared_ptr< ViewEventHandler > ViewEventHandlerSharedPtr;
      86             :         typedef ::boost::weak_ptr< ViewEventHandler >   ViewEventHandlerWeakPtr;
      87             : 
      88             :     }
      89             : }
      90             : 
      91             : #endif /* INCLUDED_SLIDESHOW_VIEWEVENTHANDLER_HXX */
      92             : 
      93             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */