aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/AutoComplete.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/AutoComplete.h')
-rw-r--r--src/AutoComplete.h25
1 files changed, 15 insertions, 10 deletions
diff --git a/src/AutoComplete.h b/src/AutoComplete.h
index df7006301..294b58bd6 100644
--- a/src/AutoComplete.h
+++ b/src/AutoComplete.h
@@ -1,56 +1,61 @@
// Scintilla source code edit control
-// AutoComplete.h - defines the auto completion list box
+/** @file AutoComplete.h
+ ** Defines the auto completion list box.
+ **/
// Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org>
// The License.txt file describes the conditions under which this software may be distributed.
#ifndef AUTOCOMPLETE_H
#define AUTOCOMPLETE_H
+/**
+ */
class AutoComplete {
bool active;
char stopChars[256];
char fillUpChars[256];
char separator;
+
public:
bool ignoreCase;
bool chooseSingle;
ListBox lb;
int posStart;
int startLen;
- // Should autocompletion be canceled if editor's currentPos <= startPos?
+ /// Should autocompletion be canceled if editor's currentPos <= startPos?
bool cancelAtStartPos;
AutoComplete();
~AutoComplete();
- // Is the auto completion list displayed?
+ /// Is the auto completion list displayed?
bool Active();
- // Display the auto completion list positioned to be near a character position
+ /// Display the auto completion list positioned to be near a character position
void Start(Window &parent, int ctrlID, int position, int startLen_);
- // The stop chars are characters which, when typed, cause the auto completion list to disappear
+ /// The stop chars are characters which, when typed, cause the auto completion list to disappear
void SetStopChars(const char *stopChars_);
bool IsStopChar(char ch);
- // The fillup chars are characters which, when typed, fill up the selected word
+ /// The fillup chars are characters which, when typed, fill up the selected word
void SetFillUpChars(const char *fillUpChars_);
bool IsFillUpChar(char ch);
- // The separator character is used when interpreting the list in SetList
+ /// The separator character is used when interpreting the list in SetList
void SetSeparator(char separator_);
char GetSeparator();
- // The list string contains a sequence of words separated by the separator character
+ /// The list string contains a sequence of words separated by the separator character
void SetList(const char *list);
void Show();
void Cancel();
- // Move the current list element by delta, scrolling appropriately
+ /// Move the current list element by delta, scrolling appropriately
void Move(int delta);
- // Select a list element that starts with word as the current element
+ /// Select a list element that starts with word as the current element
void Select(const char *word);
};