Remove docs and refactor style of TextView class.

* Make pointer style consistent, const char* name instead of const char *name.
* Lots of parameter renaming.
* in parameters don't get anything special, just font, or length instead of
  inFont, inLength.
* out parameters get a leading _ so *outWidth becomes *_width for example.
* We don't detail private function in the Haiku book and this class has a bunch
  so keep the documentation in the file but use regular comments instead.
* Normalize the parameter names between cpp file and header.
* Some minor whitespace fixes.

No functional change intended.
This commit is contained in:
John Scipione
2013-03-16 17:05:09 -04:00
parent ca9a59bbc5
commit ab21cedcce
2 changed files with 508 additions and 795 deletions
+56 -60
View File
@@ -87,21 +87,21 @@ public:
int32 form, const char* property); int32 form, const char* property);
virtual status_t GetSupportedSuites(BMessage* data); virtual status_t GetSupportedSuites(BMessage* data);
void SetText(const char* inText, void SetText(const char* text,
const text_run_array* inRuns = NULL); const text_run_array* runs = NULL);
void SetText(const char* inText, int32 inLength, void SetText(const char* text, int32 length,
const text_run_array* inRuns = NULL); const text_run_array* runs = NULL);
void SetText(BFile* inFile, void SetText(BFile* file, int32 offset,
int32 startOffset, int32 inLength, int32 length,
const text_run_array* inRuns = NULL); const text_run_array* runs = NULL);
void Insert(const char* inText, void Insert(const char* text,
const text_run_array* inRuns = NULL); const text_run_array* runs = NULL);
void Insert(const char* inText, int32 inLength, void Insert(const char* text, int32 length,
const text_run_array* inRuns = NULL); const text_run_array* runs = NULL);
void Insert(int32 startOffset, void Insert(int32 offset, const char* text,
const char* inText, int32 inLength, int32 length,
const text_run_array* inRuns = NULL); const text_run_array* runs = NULL);
void Delete(); void Delete();
void Delete(int32 startOffset, int32 endOffset); void Delete(int32 startOffset, int32 endOffset);
@@ -122,42 +122,40 @@ public:
void Clear(); void Clear();
virtual bool AcceptsPaste(BClipboard* clipboard); virtual bool AcceptsPaste(BClipboard* clipboard);
virtual bool AcceptsDrop(const BMessage* inMessage); virtual bool AcceptsDrop(const BMessage* message);
virtual void Select(int32 startOffset, int32 endOffset); virtual void Select(int32 startOffset, int32 endOffset);
void SelectAll(); void SelectAll();
void GetSelection(int32* outStart, void GetSelection(int32* _start, int32* _end) const;
int32* outEnd) const;
void SetFontAndColor(const BFont* inFont, void SetFontAndColor(const BFont* font,
uint32 inMode = B_FONT_ALL, uint32 mode = B_FONT_ALL,
const rgb_color* inColor = NULL); const rgb_color* color = NULL);
void SetFontAndColor(int32 startOffset, void SetFontAndColor(int32 startOffset,
int32 endOffset, const BFont* inFont, int32 endOffset, const BFont* font,
uint32 inMode = B_FONT_ALL, uint32 mode = B_FONT_ALL,
const rgb_color* inColor = NULL); const rgb_color* color = NULL);
void GetFontAndColor(int32 inOffset, BFont* outFont, void GetFontAndColor(int32 offset, BFont* _font,
rgb_color* outColor = NULL) const; rgb_color* _color = NULL) const;
void GetFontAndColor(BFont* outFont, void GetFontAndColor(BFont* _font, uint32* _mode,
uint32* sameProperties, rgb_color* _color = NULL,
rgb_color* outColor = NULL, bool* _sameColor = NULL) const;
bool* sameColor = NULL) const;
void SetRunArray(int32 startOffset, int32 endOffset, void SetRunArray(int32 startOffset, int32 endOffset,
const text_run_array* inRuns); const text_run_array* runs);
text_run_array* RunArray(int32 startOffset, int32 endOffset, text_run_array* RunArray(int32 startOffset, int32 endOffset,
int32* outSize = NULL) const; int32* _size = NULL) const;
int32 LineAt(int32 offset) const; int32 LineAt(int32 offset) const;
int32 LineAt(BPoint point) const; int32 LineAt(BPoint point) const;
BPoint PointAt(int32 inOffset, BPoint PointAt(int32 offset,
float* outHeight = NULL) const; float* _height = NULL) const;
int32 OffsetAt(BPoint point) const; int32 OffsetAt(BPoint point) const;
int32 OffsetAt(int32 line) const; int32 OffsetAt(int32 line) const;
virtual void FindWord(int32 inOffset, int32* outFromOffset, virtual void FindWord(int32 offset, int32* _fromOffset,
int32* outToOffset); int32* _toOffset);
virtual bool CanEndLine(int32 offset); virtual bool CanEndLine(int32 offset);
@@ -169,7 +167,7 @@ public:
void GetTextRegion(int32 startOffset, void GetTextRegion(int32 startOffset,
int32 endOffset, BRegion* outRegion) const; int32 endOffset, BRegion* outRegion) const;
virtual void ScrollToOffset(int32 inOffset); virtual void ScrollToOffset(int32 offset);
void ScrollToSelection(); void ScrollToSelection();
void Highlight(int32 startOffset, int32 endOffset); void Highlight(int32 startOffset, int32 endOffset);
@@ -193,9 +191,9 @@ public:
bool DoesWordWrap() const; bool DoesWordWrap() const;
void SetMaxBytes(int32 max); void SetMaxBytes(int32 max);
int32 MaxBytes() const; int32 MaxBytes() const;
void DisallowChar(uint32 aChar); void DisallowChar(uint32 character);
void AllowChar(uint32 aChar); void AllowChar(uint32 character);
void SetAlignment(alignment flag); void SetAlignment(alignment align);
alignment Alignment() const; alignment Alignment() const;
void SetAutoindent(bool state); void SetAutoindent(bool state);
bool DoesAutoindent() const; bool DoesAutoindent() const;
@@ -233,15 +231,14 @@ public:
static text_run_array* CopyRunArray(const text_run_array* orig, static text_run_array* CopyRunArray(const text_run_array* orig,
int32 countDelta = 0); int32 countDelta = 0);
static void FreeRunArray(text_run_array* array); static void FreeRunArray(text_run_array* array);
static void* FlattenRunArray(const text_run_array* inArray, static void* FlattenRunArray(const text_run_array* runArray,
int32* outSize = NULL); int32* _size = NULL);
static text_run_array* UnflattenRunArray(const void* data, static text_run_array* UnflattenRunArray(const void* data,
int32* outSize = NULL); int32* _size = NULL);
protected: protected:
virtual void InsertText(const char* inText, int32 inLength, virtual void InsertText(const char* text, int32 length,
int32 inOffset, int32 offset, const text_run_array* runs);
const text_run_array* inRuns);
virtual void DeleteText(int32 fromOffset, int32 toOffset); virtual void DeleteText(int32 fromOffset, int32 toOffset);
public: public:
@@ -294,10 +291,10 @@ private:
void _ResetTextRect(); void _ResetTextRect();
void _HandleBackspace(); void _HandleBackspace();
void _HandleArrowKey(uint32 inArrowKey, void _HandleArrowKey(uint32 arrowKey,
bool commandKeyDown = false); bool commandKeyDown = false);
void _HandleDelete(); void _HandleDelete();
void _HandlePageKey(uint32 inPageKey, void _HandlePageKey(uint32 pageKey,
bool commandKeyDown = false); bool commandKeyDown = false);
void _HandleAlphaKey(const char* bytes, void _HandleAlphaKey(const char* bytes,
int32 numBytes); int32 numBytes);
@@ -307,21 +304,20 @@ private:
void _RecalculateLineBreaks(int32* startLine, void _RecalculateLineBreaks(int32* startLine,
int32* endLine); int32* endLine);
int32 _FindLineBreak(int32 fromOffset, int32 _FindLineBreak(int32 fromOffset,
float* outAscent, float* outDescent, float* _ascent, float* _descent,
float* inOutWidth); float* inOutWidth);
float _StyledWidth(int32 fromOffset, int32 length, float _StyledWidth(int32 fromOffset, int32 length,
float* outAscent = NULL, float* _ascent = NULL,
float* outDescent = NULL) const; float* _descent = NULL) const;
float _TabExpandedStyledWidth(int32 offset, float _TabExpandedStyledWidth(int32 offset,
int32 length, float* outAscent = NULL, int32 length, float* _ascent = NULL,
float* outDescent = NULL) const; float* _descent = NULL) const;
float _ActualTabWidth(float location) const; float _ActualTabWidth(float location) const;
void _DoInsertText(const char* inText, void _DoInsertText(const char* text, int32 length,
int32 inLength, int32 inOffset, int32 offset, const text_run_array* runs);
const text_run_array* inRuns);
void _DoDeleteText(int32 fromOffset, void _DoDeleteText(int32 fromOffset,
int32 toOffset); int32 toOffset);
@@ -353,7 +349,7 @@ private:
void _TrackDrag(BPoint where); void _TrackDrag(BPoint where);
void _InitiateDrag(); void _InitiateDrag();
bool _MessageDropped(BMessage* inMessage, bool _MessageDropped(BMessage* message,
BPoint where, BPoint offset); BPoint where, BPoint offset);
void _PerformAutoScrolling(); void _PerformAutoScrolling();
@@ -373,13 +369,13 @@ private:
void _NormalizeFont(BFont* font); void _NormalizeFont(BFont* font);
void _SetRunArray(int32 startOffset, int32 endOffset, void _SetRunArray(int32 startOffset, int32 endOffset,
const text_run_array* inRuns); const text_run_array* runs);
void _ApplyStyleRange(int32 fromOffset, void _ApplyStyleRange(int32 fromOffset,
int32 toOffset, int32 toOffset,
uint32 inMode = B_FONT_ALL, uint32 mode = B_FONT_ALL,
const BFont *inFont = NULL, const BFont* font = NULL,
const rgb_color *inColor = NULL, const rgb_color* color = NULL,
bool syncNullStyle = true); bool syncNullStyle = true);
uint32 _CharClassification(int32 offset) const; uint32 _CharClassification(int32 offset) const;
File diff suppressed because it is too large Load Diff