slideshow/source/engine/slide/userpaintoverlay.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: userpaintoverlay.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_USERPAINTOVERLAY_HXX
  32 #define INCLUDED_SLIDESHOW_USERPAINTOVERLAY_HXX
  33
  34 #include <basegfx/polygon/b2dpolypolygon.hxx>
  35
  36 #include "unoview.hxx"
  37 #include "rgbcolor.hxx"
  38
  39 #include <boost/utility.hpp>
  40 #include <boost/shared_ptr.hpp>
  41
  42
  43 /* Definition of UserPaintOverlay class */
  44
  45 namespace slideshow
  46 {
  47     namespace internal
  48     {
  49         class EventMultiplexer;
  50         struct SlideShowContext;
  51
  52         class PaintOverlayHandler;
  53         typedef ::boost::shared_ptr< class UserPaintOverlay > UserPaintOverlaySharedPtr;
  54
  55         /** Slide overlay, which can be painted into by the user.
  56
  57             This class registers itself at the EventMultiplexer,
  58             listening for mouse clicks and moves. When the mouse is
  59             dragged, a hand sketching in the selected color is shown.
  60         */
  61         class UserPaintOverlay : private boost::noncopyable
  62         {
  63         public:
  64             /** Create a UserPaintOverlay
  65
  66                 @param rStrokeColor
  67                 Color to use for drawing
  68
  69                 @param nStrokeWidth
  70                 Width of the stroked path
  71              */
  72             static UserPaintOverlaySharedPtr create( const RGBColor&         rStrokeColor,
  73                                                      double                  nStrokeWidth,
  74                                                      const SlideShowContext& rContext );
  75             ~UserPaintOverlay();
  76
  77         private:
  78             UserPaintOverlay( const RGBColor&         rStrokeColor,
  79                               double                  nStrokeWidth,
  80                               const SlideShowContext& rContext );
  81
  82             ::boost::shared_ptr<PaintOverlayHandler>    mpHandler;
  83             EventMultiplexer&                                                   mrMultiplexer;
  84         };
  85     }
  86 }
  87
  88 #endif /* INCLUDED_SLIDESHOW_USERPAINTOVERLAY_HXX */