de.lessvoid.nifty.slick2d.input.ForwardingInputSystem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nifty-slick2d-renderer Show documentation

Nifty Renderer for Slick2D

There is a newer version: 1.4.3

Show newest version

package de.lessvoid.nifty.slick2d.input;

/**
 * This interface is used in Input Systems that are able to forward events not handled by Nifty-GUI to other input
 * listeners.
 *
 * @author Martin Karing <[email protected]>
 */
public interface ForwardingInputSystem {
  /**
   * Request exclusive mouse access. This causes that mouse events are not send to the Nifty-GUI but to the underlying
   * game directly.
   * 
   * Important: Be sure to disable this mode again as it renders the Nifty-GUI non-functional. While enabled its
   * impossible to interact with the GUI elements by mouse.
   */
  void requestExclusiveMouse();

  /**
   * Request exclusive keyboard access. This causes that keyboard events are not send to the Nifty-GUI but to the
   * underlying game directly.
   * 

   * Important: Be sure to disable this mode again as it renders the Nifty-GUI non-functional. While enabled its
   * impossible to interact with the GUI elements by keyboard.
   */
  void requestExclusiveKeyboard();

  /**
   * Request exclusive input access. This causes that mouse and keyboard events are not send to the Nifty-GUI but to
   * the
   * underlying game directly.
   * 
   * Important: Be sure to disable this mode again as it renders the Nifty-GUI non-functional. While enabled its
   * impossible to interact with the GUI elements at all.
   */
  void requestExclusiveInput();

  /**
   * This command releases the exclusive access on the mouse events. After this command is called, the input events are
   * send to the Nifty-GUI again.
   */
  void releaseExclusiveMouse();

  /**
   * This command releases the exclusive access on the keyboard events. After this command is called, the input events
   * are send to the Nifty-GUI again.
   */
  void releaseExclusiveKeyboard();

  /**
   * Release all exclusive access requests. This resets in input system to its normal operation mode. All input events
   * are first send to the Nifty-GUI and second to an additional listener if any.
   */
  void releaseExclusiveInput();
}