X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..a7ae8fea4773cd9a4c06ffb5b3df564b546b2bb4:/contrib/src/stc/scintilla/include/Accessor.h

diff --git a/contrib/src/stc/scintilla/include/Accessor.h b/contrib/src/stc/scintilla/include/Accessor.h
index b4b7e62ecf..17c9510672 100644
--- a/contrib/src/stc/scintilla/include/Accessor.h
+++ b/contrib/src/stc/scintilla/include/Accessor.h
@@ -1,6 +1,8 @@
-// SciTE - Scintilla based Text Editor
-// Accessor.h - rapid easy access to contents of a Scintilla
-// Copyright 1998-2000 by Neil Hodgson <neilh@scintilla.org>
+// Scintilla source code edit control
+/** @file Accessor.h
+ ** Rapid easy access to contents of a Scintilla.
+ **/
+// Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org>
 // The License.txt file describes the conditions under which this software may be distributed.
 
 enum { wsSpace = 1, wsTab = 2, wsSpaceTab = 4, wsInconsistent=8};
@@ -9,12 +11,16 @@ class Accessor;
 
 typedef bool (*PFNIsCommentLeader)(Accessor &styler, int pos, int len);
 
-// Interface to data in a Scintilla
+/**
+ * Interface to data in a Scintilla.
+ */
 class Accessor {
 protected:
 	enum {extremePosition=0x7FFFFFFF};
-	// bufferSize is a trade off between time taken to copy the characters and retrieval overhead
-	// slopSize positions the buffer before the desired position in case there is some backtracking
+	/** @a bufferSize is a trade off between time taken to copy the characters
+	 * and retrieval overhead.
+	 * @a slopSize positions the buffer before the desired position
+	 * in case there is some backtracking. */
 	enum {bufferSize=4000, slopSize=bufferSize/8};
 	char buf[bufferSize+1];
 	int startPos;
@@ -23,6 +29,7 @@ protected:
 
 	virtual bool InternalIsLeadByte(char ch)=0;
 	virtual void Fill(int position)=0;
+
 public:
 	Accessor() : startPos(extremePosition), endPos(0), codePage(0) {}
 	virtual ~Accessor() {}
@@ -32,8 +39,8 @@ public:
 		}
 		return buf[position - startPos];
 	}
+	/** Safe version of operator[], returning a defined value for invalid position. */
 	char SafeGetCharAt(int position, char chDefault=' ') {
-		// Safe version of operator[], returning a defined value for invalid position 
 		if (position < startPos || position >= endPos) {
 			Fill(position);
 			if (position < startPos || position >= endPos) {
@@ -57,6 +64,7 @@ public:
 	virtual int GetLineState(int line)=0;
 	virtual int SetLineState(int line, int state)=0;
 	virtual int GetPropertyInt(const char *key, int defaultValue=0)=0;
+	virtual char *GetProperties()=0;
 
 	// Style setting
 	virtual void StartAt(unsigned int start, char chMask=31)=0;
@@ -67,4 +75,3 @@ public:
 	virtual void SetLevel(int line, int level)=0;
 	virtual int IndentAmount(int line, int *flags, PFNIsCommentLeader pfnIsCommentLeader = 0)=0;
 };
-