home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / VCAFE.3.0A / Main.bin / EnvironmentDebuggingOptions.java < prev    next >
Text File  |  1998-10-25  |  3KB  |  80 lines
  1. /*
  2.  * Copyright 1998 Symantec Corporation, All Rights Reserved.
  3.  */
  4.  
  5. package com.symantec.itools.vcafe.openapi.options;
  6.  
  7. /**
  8.  * The API used to represent and access the debugging-related options of the Visual Cafe environment.
  9.  * These options that appear in the "Debugging" tab in the Environment Options dialog.
  10.  * <p>Use <code>EnvironmentOptionSet.getDebuggingOptions()</code> to get an instance of this object.
  11.  *
  12.  * @see com.symantec.itools.vcafe.openapi.VisualCafe#getEnvironmentOptionSet
  13.  * @see EnvironmentOptionSet#getDebuggingOptions
  14.  *
  15.  * @author Symantec Internet Tools Division
  16.  * @version 1.0
  17.  * @since VCafe 3.0
  18.  */
  19. public abstract class EnvironmentDebuggingOptions
  20. {
  21.         /**
  22.          * Indicates incremental debugging is always performed.
  23.          * <p>When source files are changed during a debug session, they will be immediately
  24.          * recompiled and included in the current debug session.
  25.          * @see #getRunTimeEditing
  26.          */
  27.         public static final int        RUNTIMEEDITING_ALWAYS_COMPILE_CHANGES = 0;
  28.         /**
  29.          * Indicates the user will be queried before incrementally debugging.
  30.          * <p>When source files are changed during a debug session, the user will be prompted as to
  31.          * whether they should be recompiled and included in the current debug session.
  32.          * @see #getRunTimeEditing
  33.          */
  34.         public static final int        RUNTIMEEDITING_PROMPT_BEFORE_COMPILING_CHANGES = 1;
  35.         /**
  36.          * Indicates incremental debugging is never performed.
  37.          * <p>When source files are changed during a debug session, they are not recompiled for
  38.          * inclusion in the current debug session.
  39.          * @see #getRunTimeEditing
  40.          */
  41.         public static final int        RUNTIMEEDITING_ALWAYS_IGNORE_CHANGES = 2;
  42.  
  43.     /**
  44.      * Gets the current incremental debugging mode.
  45.      * @return One of:<ul type=circle>
  46.      * <li>RUNTIMEEDITING_ALWAYS_COMPILE_CHANGES - always debug incrementally,
  47.      * <li>RUNTIMEEDITING_PROMPT_BEFORE_COMPILING_CHANGES - ask user before debugging incrementally, or
  48.      * <li>RUNTIMEEDITING_ALWAYS_IGNORE_CHANGES - never debug incrementally.
  49.      * </ul>
  50.      */
  51.     public abstract int getRunTimeEditing();
  52.  
  53.     /**
  54.      * Determines whether the debugger will display "value tips".
  55.      * <p>Value tips automatically indicate, after a certain delay, the value of the object that the
  56.      * mouse is currently over.
  57.      * @return <code>true</code> if value tips are enabled, <code>false</code> otherwise.
  58.      * @see #getValueTipsDelay
  59.      */
  60.     public abstract boolean isEnableValueTips();
  61.  
  62.     /**
  63.      * Gets the delay, in tenths of a second, before the debugger will display a "value tip".
  64.      * <p>Value tips automatically indicate, after a certain delay, the value of the object that the
  65.      * mouse is currently over.
  66.      * <p>Note: Value tips must be enabled before they display.
  67.      * @return delay before value tips are shown.
  68.      * @see #isEnableValueTips
  69.      */
  70.     public abstract int getValueTipsDelay();
  71.  
  72.  
  73.     /**
  74.      * Determines whether the Visual Cafe environment will automatically switch to the "Debug" workspace
  75.      * when starting a debug session.
  76.      * @return delay before value tips are shown.
  77.      */
  78.     public abstract boolean isSwitchToDebugWorkspaceOnRun();
  79. }
  80.