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