/**
 * PANDA 3D SOFTWARE
 * Copyright (c) Carnegie Mellon University.  All rights reserved.
 *
 * All use of this software is subject to the terms of the revised BSD
 * license.  You should have received a copy of this license along
 * with this source code in a file named "LICENSE."
 *
 * @file mouseButton.h
 * @author drose
 * @date 2000-03-01
 */

#ifndef MOUSEBUTTON_H
#define MOUSEBUTTON_H

#include "pandabase.h"

#include "buttonHandle.h"

/**
 * This class is just used as a convenient namespace for grouping all of these
 * handy functions that return buttons which map to standard mouse buttons.
 */
class EXPCL_PANDA_PUTIL MouseButton {
PUBLISHED:
  static ButtonHandle button(int button_number);
  static ButtonHandle one();
  static ButtonHandle two();
  static ButtonHandle three();
  static ButtonHandle four();
  static ButtonHandle five();
  static ButtonHandle wheel_up();
  static ButtonHandle wheel_down();
  static ButtonHandle wheel_left();
  static ButtonHandle wheel_right();

  static bool is_mouse_button(ButtonHandle button);

public:
  static void init_mouse_buttons();

  enum { num_mouse_buttons = 5 };
  static ButtonHandle _buttons[num_mouse_buttons];
  static ButtonHandle _wheel_up;
  static ButtonHandle _wheel_down;
  static ButtonHandle _wheel_left;
  static ButtonHandle _wheel_right;
};

#endif