org.eclipse.cdt.managedbuilder.core
Interface IOptionCategory

All Superinterfaces:
IBuildObject
All Known Implementing Classes:
OptionCategory, Tool

public interface IOptionCategory
extends IBuildObject


Field Summary
static java.lang.String ALL
           
static int FILTER_ALL
           
static int FILTER_FILE
           
static int FILTER_PROJECT
           
static java.lang.String ICON
           
static java.lang.String OWNER
           
static java.lang.String PROJECT
           
 
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject
ID, NAME
 
Method Summary
 IOptionCategory[] getChildCategories()
          Returns the list of children of this node in the option category tree
 java.net.URL getIconPath()
          Get the path name of an alternative icon for the option group.
 IHoldsOptions getOptionHolder()
          Returns the holder (parent) of this category.
 java.lang.Object[][] getOptions(IConfiguration configuration)
          Deprecated. since 3.1 - use getOption with IHoldsOptions aregument instead
 java.lang.Object[][] getOptions(IConfiguration configuration, IHoldsOptions optHolder)
          Returns an array of ITool/IOption pairs for the options in this category for a given configuration.
 java.lang.Object[][] getOptions(IResourceConfiguration resConfig)
          Deprecated. since 3.1 - use getOption with IHoldsOptions aregument instead
 java.lang.Object[][] getOptions(IResourceInfo resInfo, IHoldsOptions optHolder)
          Returns an array of ITool/IOption pairs for the options in this category for a given resource configuration.
 IOptionCategory getOwner()
          Returns the category that owns this category, or null if this is the top category for a tool.
 ITool getTool()
          Deprecated. since 3.0 - use getOptionHolder() instead
 boolean isDirty()
          Returns true if this element has changes that need to be saved in the project file, else false.
 void setDirty(boolean isDirty)
          Sets the element's "dirty" (have I been modified?)
 
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion
 

Field Detail

OWNER

static final java.lang.String OWNER
See Also:
Constant Field Values

ICON

static final java.lang.String ICON
See Also:
Constant Field Values

FILTER_ALL

static final int FILTER_ALL
See Also:
Constant Field Values

ALL

static final java.lang.String ALL
See Also:
Constant Field Values

FILTER_FILE

static final int FILTER_FILE
See Also:
Constant Field Values

FILTER_PROJECT

static final int FILTER_PROJECT
See Also:
Constant Field Values

PROJECT

static final java.lang.String PROJECT
See Also:
Constant Field Values
Method Detail

getChildCategories

IOptionCategory[] getChildCategories()
Returns the list of children of this node in the option category tree

Returns:

getOptions

java.lang.Object[][] getOptions(IConfiguration configuration,
                                IHoldsOptions optHolder)
Returns an array of ITool/IOption pairs for the options in this category for a given configuration.

Parameters:
tool -
Returns:
Object[][]
Since:
3.1

getOptions

java.lang.Object[][] getOptions(IConfiguration configuration)
Deprecated. since 3.1 - use getOption with IHoldsOptions aregument instead


getOptions

java.lang.Object[][] getOptions(IResourceInfo resInfo,
                                IHoldsOptions optHolder)
Returns an array of ITool/IOption pairs for the options in this category for a given resource configuration.

Parameters:
tool -
Returns:
Object[][]
Since:
3.1

getOptions

java.lang.Object[][] getOptions(IResourceConfiguration resConfig)
Deprecated. since 3.1 - use getOption with IHoldsOptions aregument instead


getOwner

IOptionCategory getOwner()
Returns the category that owns this category, or null if this is the top category for a tool.

Returns:

getTool

ITool getTool()
Deprecated. since 3.0 - use getOptionHolder() instead

Returns the tool that ultimately owns this category. If owned by a toolChain return null.

Returns:

getOptionHolder

IHoldsOptions getOptionHolder()
Returns the holder (parent) of this category. This may be an object implementing ITool or IToolChain, which both extend IHoldsOptions. The call can return null, for example the top option category of a tool will return null. Note that the name getOptionHolder() has been choosen, because Tool implements both ITool and IOptionCategory and ITool.getParent() exists already.

Returns:
IHoldsOptions
Since:
3.0

getIconPath

java.net.URL getIconPath()
Get the path name of an alternative icon for the option group. Or null if no alternative icon was defined.

Returns:
URL
Since:
3.0

isDirty

boolean isDirty()
Returns true if this element has changes that need to be saved in the project file, else false.

Returns:
boolean

setDirty

void setDirty(boolean isDirty)
Sets the element's "dirty" (have I been modified?) flag.

Parameters:
isDirty -