Client Class | Extending Qt Creator Manual

Extending Qt Creator Manual | Client

Extending Qt Creator Manual 4.4.1

# Client Class

(CPlusPlus::Client)

The Client class implements a notification interface for the C++ preprocessor. More...

Header: | #include <Client>

- List of all members, including inherited members

## Public Types

enum | IncludeType { IncludeLocal, IncludeGlobal, IncludeNext }

## Public Functions

| Client()
virtual | ~Client() = 0
virtual void | failedMacroDefinitionCheck(unsigned bytesOffset, unsigned utf16charsOffset, const ByteArrayRef &name) = 0
virtual void | macroAdded(const Macro &macro) = 0
virtual void | markAsIncludeGuard(const QByteArray &macroName) = 0
virtual void | notifyMacroReference(unsigned bytesOffset, unsigned utf16charsOffset, unsigned line, const Macro &macro) = 0
virtual void | passedMacroDefinitionCheck(unsigned bytesOffset, unsigned utf16charsOffset, unsigned line, const Macro &macro) = 0
virtual void | sourceNeeded(unsigned line, const QString &fileName, IncludeType mode, const QStringList &initialIncludes = QStringList()) = 0
virtual void | startExpandingMacro(unsigned bytesOffset, unsigned utf16charsOffset, unsigned line, const Macro &macro, const QVector<MacroArgumentReference> &actuals = QVector<MacroArgumentReference> ()) = 0
virtual void | startSkippingBlocks(unsigned utf16charsOffset) = 0
virtual void | stopExpandingMacro(unsigned bytesOffset, const Macro &macro) = 0
virtual void | stopSkippingBlocks(unsigned utf16charsOffset) = 0

## Static Public Members

bool | isInjectedFile(const QString &fileName)

## Detailed Description

The Client class implements a notification interface for the C++ preprocessor.

## Member Type Documentation

### enum Client::IncludeType

## Member Function Documentation

### Client::Client()

Default constructs an instance of Client.

### `[pure virtual]` Client::~Client()

Destroys the instance of Client.

### `[pure virtual]` void Client::failedMacroDefinitionCheck(unsigned bytesOffset, unsigned utf16charsOffset, const ByteArrayRef &name)

### `[static]` bool Client::isInjectedFile(const QString &fileName)

### `[pure virtual]` void Client::macroAdded(const Macro &macro)

Called whenever a new macro is defined.

### `[pure virtual]` void Client::markAsIncludeGuard(const QByteArray &macroName)

### `[pure virtual]` void Client::notifyMacroReference(unsigned bytesOffset, unsigned utf16charsOffset, unsigned line, const Macro &macro)

### `[pure virtual]` void Client::passedMacroDefinitionCheck(unsigned bytesOffset, unsigned utf16charsOffset, unsigned line, const Macro &macro)

### `[pure virtual]` void Client::sourceNeeded(unsigned line, const QString &fileName, IncludeType mode, const QStringList &initialIncludes = QStringList())

### `[pure virtual]` void Client::startExpandingMacro(unsigned bytesOffset, unsigned utf16charsOffset, unsigned line, const Macro &macro, const QVector<MacroArgumentReference> &actuals = QVector<MacroArgumentReference> ())

### `[pure virtual]` void Client::startSkippingBlocks(unsigned utf16charsOffset)

### `[pure virtual]` void Client::stopExpandingMacro(unsigned bytesOffset, const Macro &macro)

### `[pure virtual]` void Client::stopSkippingBlocks(unsigned utf16charsOffset)