Eclipse CDT
Pre-release 3.0

org.eclipse.cdt.core.search
Interface ICSearchConstants

All Known Subinterfaces:
ICSearchPattern, IMatchLocator
All Known Implementing Classes:
org.eclipse.cdt.internal.core.search.matching.CSearchPattern, OrPattern, SearchEngine

public interface ICSearchConstants

This interface defines the constants used by the search engine.

This interface declares constants only; it is not intended to be implemented.

See Also:
SearchEngine

Nested Class Summary
static class ICSearchConstants.LimitTo
           
static class ICSearchConstants.SearchFor
           
 
Field Summary
static ICSearchConstants.LimitTo ALL_OCCURRENCES
          The search result is a declaration, a reference, or an implementer of an interface.
static int CANCEL_IF_NOT_READY_TO_SEARCH
          The search operation throws an org.eclipse.core.runtime.OperationCanceledException if the underlying indexer has not finished indexing the workspace.
static boolean CASE_INSENSITIVE
          The search pattern ignores cases in the search result.
static boolean CASE_SENSITIVE
          The search pattern matches the search result only if cases are the same.
static ICSearchConstants.SearchFor CLASS
          The searched element is a class.
static ICSearchConstants.SearchFor CLASS_STRUCT
           
static ICSearchConstants.LimitTo DECLARATIONS
          The search result is a declaration.
static ICSearchConstants.LimitTo DECLARATIONS_DEFINITIONS
          The search result is a declaration or a definitoin
static ICSearchConstants.LimitTo DEFINITIONS
          The search result is a type that implements an interface.
static ICSearchConstants.SearchFor DERIVED
           
static ICSearchConstants.SearchFor ENUM
          The searched element is a enum.
static ICSearchConstants.SearchFor ENUMTOR
           
static int EXACT_MATCH
          The search pattern matches exactly the search result, that is, the source of the search result equals the search pattern.
static String EXTERNAL_SEARCH_LINK_PREFIX
           
static ICSearchConstants.SearchFor FIELD
          The searched element is a field (member variable).
static int FORCE_IMMEDIATE_SEARCH
          The search operation starts immediately, even if the underlying indexer has not finished indexing the workspace.
static ICSearchConstants.SearchFor FRIEND
           
static ICSearchConstants.SearchFor FUNCTION
          The searched element is a function.
static ICSearchConstants.SearchFor INCLUDE
           
static ICSearchConstants.SearchFor MACRO
           
static ICSearchConstants.SearchFor METHOD
          The searched element is a method (member function).
static ICSearchConstants.SearchFor NAMESPACE
          The searched element is a namespace.
static int PATTERN_MATCH
          The search pattern contains one or more wild cards ('*') where a wild-card can replace 0 or more characters in the search result.
static int PREFIX_MATCH
          The search pattern is a prefix of the search result.
static ICSearchConstants.LimitTo REFERENCES
          The search result is a reference.
static ICSearchConstants.SearchFor STRUCT
          The searched element is a struct.
static ICSearchConstants.SearchFor TYPE
          The searched element is a type.
static ICSearchConstants.SearchFor TYPEDEF
           
static ICSearchConstants.SearchFor UNION
          The searched element is a union.
static ICSearchConstants.LimitTo UNKNOWN_LIMIT_TO
           
static ICSearchConstants.SearchFor UNKNOWN_SEARCH_FOR
          The nature of searched element or the nature of match in unknown.
static ICSearchConstants.SearchFor VAR
          The searched element is a variable.
static int WAIT_UNTIL_READY_TO_SEARCH
          The search operation waits for the underlying indexer to finish indexing the workspace before starting the search.
 

Field Detail

UNKNOWN_SEARCH_FOR

static final ICSearchConstants.SearchFor UNKNOWN_SEARCH_FOR
The nature of searched element or the nature of match in unknown.


UNKNOWN_LIMIT_TO

static final ICSearchConstants.LimitTo UNKNOWN_LIMIT_TO

TYPE

static final ICSearchConstants.SearchFor TYPE
The searched element is a type.


FUNCTION

static final ICSearchConstants.SearchFor FUNCTION
The searched element is a function.


NAMESPACE

static final ICSearchConstants.SearchFor NAMESPACE
The searched element is a namespace.


METHOD

static final ICSearchConstants.SearchFor METHOD
The searched element is a method (member function).


FIELD

static final ICSearchConstants.SearchFor FIELD
The searched element is a field (member variable).


VAR

static final ICSearchConstants.SearchFor VAR
The searched element is a variable. More selective than using TYPE


CLASS

static final ICSearchConstants.SearchFor CLASS
The searched element is a class. More selective than using TYPE


STRUCT

static final ICSearchConstants.SearchFor STRUCT
The searched element is a struct. More selective than using TYPE


ENUM

static final ICSearchConstants.SearchFor ENUM
The searched element is a enum. More selective than using TYPE


UNION

static final ICSearchConstants.SearchFor UNION
The searched element is a union. More selective than using TYPE


MACRO

static final ICSearchConstants.SearchFor MACRO

CLASS_STRUCT

static final ICSearchConstants.SearchFor CLASS_STRUCT

TYPEDEF

static final ICSearchConstants.SearchFor TYPEDEF

INCLUDE

static final ICSearchConstants.SearchFor INCLUDE

DERIVED

static final ICSearchConstants.SearchFor DERIVED

ENUMTOR

static final ICSearchConstants.SearchFor ENUMTOR

FRIEND

static final ICSearchConstants.SearchFor FRIEND

DECLARATIONS

static final ICSearchConstants.LimitTo DECLARATIONS
The search result is a declaration. Can be used in conjunction with any of the nature of searched elements so as to better narrow down the search.


DEFINITIONS

static final ICSearchConstants.LimitTo DEFINITIONS
The search result is a type that implements an interface. Used in conjunction with either TYPE or CLASS or INTERFACE, it will respectively search for any type implementing/extending an interface, or rather exclusively search for classes implementing an interface, or interfaces extending an interface.


REFERENCES

static final ICSearchConstants.LimitTo REFERENCES
The search result is a reference. Can be used in conjunction with any of the nature of searched elements so as to better narrow down the search. References can contain implementers since they are more generic kind of matches.


ALL_OCCURRENCES

static final ICSearchConstants.LimitTo ALL_OCCURRENCES
The search result is a declaration, a reference, or an implementer of an interface. Can be used in conjunction with any of the nature of searched elements so as to better narrow down the search.


DECLARATIONS_DEFINITIONS

static final ICSearchConstants.LimitTo DECLARATIONS_DEFINITIONS
The search result is a declaration or a definitoin


EXACT_MATCH

static final int EXACT_MATCH
The search pattern matches exactly the search result, that is, the source of the search result equals the search pattern.

See Also:
Constant Field Values

PREFIX_MATCH

static final int PREFIX_MATCH
The search pattern is a prefix of the search result.

See Also:
Constant Field Values

PATTERN_MATCH

static final int PATTERN_MATCH
The search pattern contains one or more wild cards ('*') where a wild-card can replace 0 or more characters in the search result.

See Also:
Constant Field Values

CASE_SENSITIVE

static final boolean CASE_SENSITIVE
The search pattern matches the search result only if cases are the same.

See Also:
Constant Field Values

CASE_INSENSITIVE

static final boolean CASE_INSENSITIVE
The search pattern ignores cases in the search result.

See Also:
Constant Field Values

FORCE_IMMEDIATE_SEARCH

static final int FORCE_IMMEDIATE_SEARCH
The search operation starts immediately, even if the underlying indexer has not finished indexing the workspace. Results will more likely not contain all the matches.

See Also:
Constant Field Values

CANCEL_IF_NOT_READY_TO_SEARCH

static final int CANCEL_IF_NOT_READY_TO_SEARCH
The search operation throws an org.eclipse.core.runtime.OperationCanceledException if the underlying indexer has not finished indexing the workspace.

See Also:
Constant Field Values

WAIT_UNTIL_READY_TO_SEARCH

static final int WAIT_UNTIL_READY_TO_SEARCH
The search operation waits for the underlying indexer to finish indexing the workspace before starting the search.

See Also:
Constant Field Values

EXTERNAL_SEARCH_LINK_PREFIX

static final String EXTERNAL_SEARCH_LINK_PREFIX
See Also:
Constant Field Values

Eclipse CDT
Pre-release 3.0

Copyright (c) IBM Corp. and others 2004. All Rights Reserved.