home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / VCAFE.3.0A / Main.bin / EnvironmentGeneralOptions.java < prev    next >
Text File  |  1998-10-25  |  2KB  |  68 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 general options of the Visual Cafe environment.
  9.  * These options that appear in the "General" tab in the Environment Options dialog.
  10.  * <p>Use <code>EnvironmentOptionSet.getGeneralOptions()</code> to get an instance of this object.
  11.  *
  12.  * @see com.symantec.itools.vcafe.openapi.VisualCafe#getEnvironmentOptionSet
  13.  * @see EnvironmentOptionSet#getGeneralOptions
  14.  *
  15.  * @author Symantec Internet Tools Division
  16.  * @version 1.0
  17.  * @since VCafe 3.0
  18.  */
  19. public abstract class EnvironmentGeneralOptions
  20. {
  21.         /**
  22.          * Indicates Visual Cafe will create a new default project on startup.
  23.          * @see #getOnStartup
  24.          */
  25.         public static final int        ONSTARTUP_CREATE_A_NEW_PROJECT = 0;
  26.         /**
  27.          * Indicates Visual Cafe will open the project from the last session on startup.
  28.          * @see #getOnStartup
  29.          */
  30.         public static final int        ONSTARTUP_OPEN_THE_LAST_PROJECT = 1;
  31.         /**
  32.          * Indicates Visual Cafe will take no special action on startup.
  33.          * @see #getOnStartup
  34.          */
  35.         public static final int        ONSTARTUP_DO_NOTHING = 2;
  36.  
  37.     /**
  38.      * Gets Visual Cafe's current startup action
  39.      * @return One of:<ul type=circle>
  40.      * <li>ONSTARTUP_CREATE_A_NEW_PROJECT - create a new default project,
  41.      * <li>ONSTARTUP_OPEN_THE_LAST_PROJECT - open the project from the last session, or
  42.      * <li>ONSTARTUP_DO_NOTHING - take no special action.
  43.      * </ul>
  44.      */
  45.     public abstract int getOnStartup();
  46.  
  47.     /**
  48.      * Gets the path used to locate project source files when they are not in the project directory.
  49.      * @return the path.
  50.      */
  51.     public abstract String getLookForSourceFilesInPath();
  52.  
  53.     /**
  54.      * Gets a list of help files used by the environment.
  55.      * <p>The help filenames are seperated by spaces.
  56.      * @return the list of help files.
  57.      */
  58.     public abstract String getUseTheseHelpFiles();
  59.  
  60.     /**
  61.      * Determines whether Visual Cafe will use a Multi-Document Interface (MDI) or the original
  62.      * Single-Document Interface (SDI).
  63.      * The SDI environment was used exclusively before Visual Cafe 2.5.
  64.      * @return <code>true</code> if using MDI, <code>false</code> otherwise.
  65.      */
  66.     public abstract boolean isMDIDevelopmentEnvironment();
  67. }
  68.