juce/source/src/application/juce_ApplicationCommandID.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCE_APPLICATIONCOMMANDID_JUCEHEADER__
  27 #define __JUCE_APPLICATIONCOMMANDID_JUCEHEADER__
  28
  29
  30 //==============================================================================
  31 /** A type used to hold the unique ID for an application command.
  32
  33     This is a numeric type, so it can be stored as an integer.
  34
  35     @see ApplicationCommandInfo, ApplicationCommandManager,
  36          ApplicationCommandTarget, KeyPressMappingSet
  37 */
  38 typedef int CommandID;
  39
  40
  41 //==============================================================================
  42 /** A set of general-purpose application command IDs.
  43
  44     Because these commands are likely to be used in most apps, they're defined
  45     here to help different apps to use the same numeric values for them.
  46
  47     Of course you don't have to use these, but some of them are used internally by
  48     Juce - e.g. the quit ID is recognised as a command by the JUCEApplication class.
  49
  50     @see ApplicationCommandInfo, ApplicationCommandManager,
  51          ApplicationCommandTarget, KeyPressMappingSet
  52 */
  53 namespace StandardApplicationCommandIDs
  54 {
  55     /** This command ID should be used to send a "Quit the App" command.
  56
  57         This command is recognised by the JUCEApplication class, so if it is invoked
  58         and no other ApplicationCommandTarget handles the event first, the JUCEApplication
  59         object will catch it and call JUCEApplication::systemRequestedQuit().
  60     */
  61     static const CommandID  quit           = 0x1001;
  62
  63     /** The command ID that should be used to send a "Delete" command. */
  64     static const CommandID  del            = 0x1002;
  65
  66     /** The command ID that should be used to send a "Cut" command. */
  67     static const CommandID  cut            = 0x1003;
  68
  69     /** The command ID that should be used to send a "Copy to clipboard" command. */
  70     static const CommandID  copy           = 0x1004;
  71
  72     /** The command ID that should be used to send a "Paste from clipboard" command. */
  73     static const CommandID  paste          = 0x1005;
  74
  75     /** The command ID that should be used to send a "Select all" command. */
  76     static const CommandID  selectAll      = 0x1006;
  77
  78     /** The command ID that should be used to send a "Deselect all" command. */
  79     static const CommandID  deselectAll    = 0x1007;
  80 }
  81
  82
  83 #endif   // __JUCE_APPLICATIONCOMMANDID_JUCEHEADER__