modules/cldc-compact/src/main/java/cc/squirreljme/jvm/mle/constants/UIKeyModifier.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.jvm.mle.constants;
  11
  12 import cc.squirreljme.runtime.cldc.annotation.Exported;
  13
  14 /**
  15  * Modifier keys for when key and mouse events occur.
  16  *
  17  * @since 2020/08/02
  18  */
  19 @Exported
  20 public interface UIKeyModifier
  21 {
  22         /** Alt key modifier. */
  23         @Exported
  24         int MODIFIER_ALT =
  25                 0x10000;
  26
  27         /** Shift key modifier. */
  28         @Exported
  29         int MODIFIER_SHIFT =
  30                 0x20000;
  31
  32         /** Control (Ctrl) key modifier. */
  33         @Exported
  34         int MODIFIER_CTRL =
  35                 0x40000;
  36
  37         /** Left Command Button. (SquirrelJME). */
  38         @Exported
  39         int MODIFIER_LEFT_COMMAND =
  40                 0x80000;
  41
  42         /** Right Command button. (SquirrelJME). */
  43         @Exported
  44         int MODIFIER_RIGHT_COMMAND =
  45                 0x100000;
  46
  47         /** Command key modifier. */
  48         @Exported
  49         int MODIFIER_COMMAND =
  50                 0x400000;
  51
  52         /** The Function key. */
  53         @Exported
  54         int MODIFIER_FUNCTION =
  55                 0x800000;
  56
  57         /** Left and right commands, used for middle command. */
  58         @Exported
  59         int MODIFIER_LEFT_RIGHT_COMMANDS =
  60                 UIKeyModifier.MODIFIER_LEFT_COMMAND |
  61                 UIKeyModifier.MODIFIER_RIGHT_COMMAND;
  62
  63         /** Mask specifically for the limits of J2ME. */
  64         @Exported
  65         int J2ME_MASK =
  66                 UIKeyModifier.MODIFIER_ALT |
  67                 UIKeyModifier.MODIFIER_FUNCTION | UIKeyModifier.MODIFIER_COMMAND |
  68                 UIKeyModifier.MODIFIER_CTRL | UIKeyModifier.MODIFIER_SHIFT;
  69
  70         /** Mask for all the modifier keys. */
  71         @Exported
  72         int MASK =
  73                 UIKeyModifier.J2ME_MASK |
  74                 UIKeyModifier.MODIFIER_LEFT_RIGHT_COMMANDS;
  75
  76 }