Extending Qt Creator Manual | Rule

Extending Qt Creator Manual 4.7.1

# Rule Class

(TextEditor::Internal::Rule)

- List of all members, including inherited members

## Public Functions

| Rule(bool consumesNonSpace = true)
virtual | ~Rule()
void | addChild(const int &rule)
const int & | beginRegion() const
TextEditor::Internal::Rule * | clone() const
int | column() const
const int & | context() const
const int & | definition() const
const int & | endRegion() const
bool | hasChildren() const
bool | isFirstNonSpace() const
bool | isLookAhead() const
const int & | itemData() const
bool | matchSucceed(const int &text, const int length, TextEditor::Internal::ProgressData *progress)
void | progressFinished()
void | setBeginRegion(const int &begin)
void | setColumn(const int &column)
void | setContext(const int &context)
void | setDefinition(const int &definition)
void | setEndRegion(const int &end)
void | setFirstNonSpace(const int &firstNonSpace)
void | setItemData(const int &itemData)
void | setLookAhead(const int &lookAhead)

## Protected Functions

bool | charPredicateMatchSucceed(const int &text, const int length, TextEditor::Internal::ProgressData *progress, bool () const predicate) const
bool | charPredicateMatchSucceed(const int &text, const int length, TextEditor::Internal::ProgressData *progress, bool (*)(const int &) predicate) const
bool | matchCharacter(const int &text, const int length, TextEditor::Internal::ProgressData *progress, const int &c, bool saveRestoreOffset = true) const
bool | matchEscapeSequence(const int &text, const int length, TextEditor::Internal::ProgressData *progress, bool saveRestoreOffset = true) const
bool | matchHexSequence(const int &text, const int length, TextEditor::Internal::ProgressData *progress, bool saveRestoreOffset = true) const
bool | matchOctalSequence(const int &text, const int length, TextEditor::Internal::ProgressData *progress, bool saveRestoreOffset = true) const

## Member Function Documentation

### Rule::Rule(bool consumesNonSpace = true)

Default constructs an instance of Rule.

### `[virtual]` Rule::~Rule()

Destroys the instance of Rule. The destructor is virtual.

### void Rule::addChild(const int &rule)

### const int &Rule::beginRegion() const

See also setBeginRegion().

### `[protected]` bool Rule::charPredicateMatchSucceed(const int &text, const int length, TextEditor::Internal::ProgressData *progress, bool () const predicate) const

### `[protected]` bool Rule::charPredicateMatchSucceed(const int &text, const int length, TextEditor::Internal::ProgressData *progress, bool (*)(const int &) predicate) const

### TextEditor::Internal::Rule *Rule::clone() const

### int Rule::column() const

See also setColumn().

### const int &Rule::context() const

See also setContext().

### const int &Rule::definition() const

See also setDefinition().

### const int &Rule::endRegion() const

See also setEndRegion().

### bool Rule::hasChildren() const

### bool Rule::isFirstNonSpace() const

### bool Rule::isLookAhead() const

### const int &Rule::itemData() const

See also setItemData().

### `[protected]` bool Rule::matchCharacter(const int &text, const int length, TextEditor::Internal::ProgressData *progress, const int &c, bool saveRestoreOffset = true) const

### `[protected]` bool Rule::matchEscapeSequence(const int &text, const int length, TextEditor::Internal::ProgressData *progress, bool saveRestoreOffset = true) const

### `[protected]` bool Rule::matchHexSequence(const int &text, const int length, TextEditor::Internal::ProgressData *progress, bool saveRestoreOffset = true) const

### `[protected]` bool Rule::matchOctalSequence(const int &text, const int length, TextEditor::Internal::ProgressData *progress, bool saveRestoreOffset = true) const

### bool Rule::matchSucceed(const int &text, const int length, TextEditor::Internal::ProgressData *progress)

### void Rule::progressFinished()

### void Rule::setBeginRegion(const int &begin)

See also beginRegion().

### void Rule::setColumn(const int &column)

See also column().

### void Rule::setContext(const int &context)

See also context().

### void Rule::setDefinition(const int &definition)

See also definition().

### void Rule::setEndRegion(const int &end)

See also endRegion().

### void Rule::setFirstNonSpace(const int &firstNonSpace)

See also isFirstNonSpace().

### void Rule::setItemData(const int &itemData)

See also itemData().

### void Rule::setLookAhead(const int &lookAhead)

See also isLookAhead().