|
Eclipse CDT Pre-release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRegion
A C model region describes a hierarchical set of elements. Regions are often used to describe a set of elements to be considered when performing operations; for example, the set of elements to be considered during a search. A region may include elements from different projects.
When an element is included in a region, all of its children are considered to be included. Children of an included element cannot be selectively excluded.
This interface is not intended to be implemented by clients.
Instances can be created via the CoreModel.newRegion
.
CoreModel#newRegion()
Method Summary | |
---|---|
void |
add(ICElement element)
Adds the given element and all of its descendents to this region. |
boolean |
contains(ICElement element)
Returns whether the given element is contained in this region. |
ICElement[] |
getElements()
Returns the top level elements in this region. |
boolean |
remove(ICElement element)
Removes the specified element from the region and returns true if successful, false if the remove
fails. |
Method Detail |
---|
void add(ICElement element)
element
- the given elementboolean contains(ICElement element)
element
- the given element
ICElement[] getElements()
boolean remove(ICElement element)
true
if successful, false
if the remove
fails. If an ancestor of the given element is included, the
remove fails (in other words, it is not possible to selectively
exclude descendants of included ancestors).
element
- the given element
true
if successful, false
if the remove fails
|
Eclipse CDT Pre-release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |