slideshow/source/inc/cursormanager.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: cursormanager.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_CURSORMANAGER_HXX
  32 #define INCLUDED_SLIDESHOW_CURSORMANAGER_HXX
  33
  34 #include <sal/types.h>
  35 #include <boost/shared_ptr.hpp>
  36
  37
  38 /* Definition of CursorManager interface */
  39
  40 namespace slideshow
  41 {
  42     namespace internal
  43     {
  44
  45         /** Interface for handling the view cursor.
  46
  47             Classes implementing this interface interact with the
  48             View, arbitrating access to the mouse cursor shape.
  49          */
  50         class CursorManager
  51         {
  52         public:
  53             virtual ~CursorManager() {}
  54
  55             /** Request different cursor shape.
  56
  57                 @param nCursorShape
  58                 Shape ID of the new mouse cursor
  59              */
  60             virtual bool requestCursor( sal_Int16 nCursorShape ) = 0;
  61
  62             /** Reset cursor to default one.
  63
  64                 This method resets the cursor to whatever default to
  65                 manager deems appropriate.
  66              */
  67             virtual void resetCursor() = 0;
  68         };
  69
  70         typedef ::boost::shared_ptr< CursorManager > CursorManagerSharedPtr;
  71
  72     }
  73 }
  74
  75 #endif /* INCLUDED_SLIDESHOW_CURSORMANAGER_HXX */