mouse.hpp

Go to the documentation of this file.

/* BSD 3-Clause License
 *
 * Copyright © 2008-2025, Jice and the libtcod contributors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#pragma once
#ifndef TCOD_MOUSE_HPP_
#define TCOD_MOUSE_HPP_
 
#include "mouse.h"
#include "mouse_types.h"
 
class TCODLIB_API TCODMouse {
 public:
  TCOD_DEPRECATED(
      "Use SDL_ShowCursor to handle the mouse cursor."
      "\n\tSDL_ShowCursor(visible);")
  static void showCursor(bool visible);
 
  TCOD_DEPRECATED(
      "Use SDL_ShowCursor to handle the mouse cursor."
      "\n\tint is_visible = SDL_ShowCursor(SDL_QUERY);")
  static bool isCursorVisible();
 
  TCOD_DEPRECATED(
      "Use SDL_WarpMouseInWindow to handle the mouse cursor."
      "\n\tSDL_WarpMouseInWindow(NULL, x, y);")
  static void move(int x, int y);
 
  TCOD_DEPRECATED(
      "Use SDL_GetMouseState to check the mouse state."
      "\n\tint x;"
      "\n\tint y;"
      "\n\nint buttons = SDL_GetMouseState(&x, &y);")
  static TCOD_mouse_t getStatus();
};
#endif  // TCOD_MOUSE_HPP_