org.eclipse.cdt.managedbuilder.core
Interface IOptionApplicability

All Known Implementing Classes:
BooleanExpressionApplicabilityCalculator

public interface IOptionApplicability

This interface determines whether or not the option is currently displayed, enabled, and used in command-line generation.


Method Summary
 boolean isOptionEnabled(IBuildObject configuration, IHoldsOptions holder, IOption option)
          Whenever the value of an option changes in the GUI, this method is queried on all other visible options for the same category.
 boolean isOptionUsedInCommandLine(IBuildObject configuration, IHoldsOptions holder, IOption option)
          This method is queried whenever a makefile or makefile fragment is generated which uses this option, and in the C/C++ Build property pages when displaying the current command line.
 boolean isOptionVisible(IBuildObject configuration, IHoldsOptions holder, IOption option)
          This method is queried whenever a new option category is displayed.
 

Method Detail

isOptionUsedInCommandLine

boolean isOptionUsedInCommandLine(IBuildObject configuration,
                                  IHoldsOptions holder,
                                  IOption option)
This method is queried whenever a makefile or makefile fragment is generated which uses this option, and in the C/C++ Build property pages when displaying the current command line.

Parameters:
configuration - build configuration of option (may be IConfiguration or IResourceConfiguration)
holder - contains the holder of the option
option - the option itself
Returns:
true if this option is to be used in command line generation, false otherwise

isOptionVisible

boolean isOptionVisible(IBuildObject configuration,
                        IHoldsOptions holder,
                        IOption option)
This method is queried whenever a new option category is displayed.

Parameters:
configuration - build configuration of option (may be IConfiguration or IResourceConfiguration)
holder - contains the holder of the option
option - the option itself
Returns:
true if this option should be visible in the build options page, false otherwise

isOptionEnabled

boolean isOptionEnabled(IBuildObject configuration,
                        IHoldsOptions holder,
                        IOption option)
Whenever the value of an option changes in the GUI, this method is queried on all other visible options for the same category. Note that this occurs when the GUI changes - the user may opt to cancel these changes.

Parameters:
configuration - build configuration of option (may be IConfiguration or IResourceConfiguration)
holder - contains the holder of the option
option - the option itself
Returns:
true if this option should be enabled in the build options page, or false if it should be disabled (grayed out)