slideshow/source/inc/vieweventhandler.hxx

   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_SOURCE_INC_VIEWEVENTHANDLER_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_INC_VIEWEVENTHANDLER_HXX
  22
  23 #include <memory>
  24
  25 #include "unoview.hxx"
  26 #include "disposable.hxx"
  27
  28
  29 /* Definition of ViewEventHandler interface */
  30
  31 namespace slideshow::internal
  32     {
  33
  34         /** Interface for handling view events.
  35
  36             Classes implementing this interface can be added to an
  37             EventMultiplexer object, and are called from there to
  38             handle view events.
  39          */
  40         class ViewEventHandler : public virtual SharedPtrAble
  41         {
  42         public:
  43             /** Notify new view.
  44
  45                 @param rView
  46                 The newly added view
  47              */
  48             virtual void viewAdded( const UnoViewSharedPtr& rView ) = 0;
  49
  50             /** Notify removed view.
  51
  52                 @param rView
  53                 The removed view
  54              */
  55             virtual void viewRemoved( const UnoViewSharedPtr& rView ) = 0;
  56
  57             /** Notify changed view.
  58
  59                 Reasons for a viewChanged notification can be
  60                 different view size, transformation, or other device
  61                 properties (color resolution or profile, etc.)
  62
  63                 @param rView
  64                 The changed view
  65              */
  66             virtual void viewChanged( const UnoViewSharedPtr& rView ) = 0;
  67
  68             /** Notify that all views changed.
  69
  70                 Reasons for a viewChanged notification can be
  71                 different view size, transformation, or other device
  72                 properties (color resolution or profile, etc.)
  73
  74                 Note that this method avoids hidden inefficiencies
  75                 (O(n^2) behaviour when viewChanged() needs to perform
  76                 linear searches)
  77              */
  78             virtual void viewsChanged() = 0;
  79         };
  80
  81         typedef ::std::weak_ptr< ViewEventHandler >   ViewEventHandlerWeakPtr;
  82
  83 }
  84
  85 #endif // INCLUDED_SLIDESHOW_SOURCE_INC_VIEWEVENTHANDLER_HXX
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */