record TCompletionString
Unit
Neslib.Clang
Declaration
type TCompletionString = record
Description
A semantic string that describes a code-completion result.
A semantic string that describes the formatting of a code-completion result as a single "template" of text that should be inserted into the source buffer when a particular code-completion result is selected. Each semantic string is made up of some number of "chunks", each of which contains some text along with a description of what that text means, e.g., the name of the entity being referenced, whether the text chunk is part of the template, or whether it is a "placeholder" that the user should replace with actual code, of a specific kind. See TCompletionChunkKind for a description of the different kinds of chunks.
Overview
Methods
function IsNull: Boolean; inline; |
Properties
Description
Methods
function IsNull: Boolean; inline; |
|
Whether the string is assigned or not.
|
Properties
property ChunkCount: Integer read GetChunkCount; |
|
Number of chunks in the code-completion string.
|
property ChunkKind[constAIndex:Integer]: TCompletionChunkKind read GetChunkKind; |
|
The kind of a particular chunk within the completion string.
|
property ChunkText[constAIndex:Integer]: String read GetChunkText; |
|
The text associated with a particular chunk within the completion string.
|
property ChunkCompletionString[constAIndex:Integer]: TCompletionString read GetChunkCompletionString; |
|
The completion string associated with a particular chunk within the completion string.
|
property Priority: Integer read GetPriority; |
|
The priority of this code completion.
The priority of a code completion indicates how likely it is that this particular completion is the completion that the user will select. The priority is selected by various internal heuristics.
Smaller values indicate higher-priority (more likely) completions.
|
property Availability: TAvailabilityKind read GetAvailability; |
|
The availability of the entity that this code-completion string refers to.
|
property AnnotationCount: Integer read GetAnnotationCount; |
|
The number of annotations associated with the completion string.
|
property Annotations[constAIndex:Integer]: String read GetAnnotation; |
|
The annotations associated with the completion string.
|
property Parent: String read GetParent; |
|
The parent context of the completion string, e.g., "NSObject" if the completion string represents a method in the NSObject class.
The parent context of a completion string is the semantic parent of the declaration (if any) that the code completion represents. For example, a code completion for an Objective-C method would have the method's class or protocol as its context.
|
property BriefComment: String read GetBriefComment; |
|
The brief documentation comment attached to the declaration that corresponds to the completion string.
|
property Handle: TCXCompletionString read FHandle; |
|
Internal handle to C API
|
Generated by PasDocEx, based on PasDoc 0.14.0.
|