A position in a code document. More...

#include "juce_CodeDocument.h"

Public Member Functions
	Position () noexcept
	Creates an uninitialised position.

	Position (const CodeDocument &ownerDocument, int line, int indexInLine) noexcept
	Creates a position based on a line and index in a document.

	Position (const CodeDocument &ownerDocument, int charactersFromStartOfDocument) noexcept
	Creates a position based on a character index in a document.

	Position (const Position &) noexcept
	Creates a copy of another position.

	~Position ()
	Destructor.

Position &	operator= (const Position &)

bool	operator== (const Position &) const noexcept

bool	operator!= (const Position &) const noexcept

void	setPosition (int charactersFromStartOfDocument)
	Points this object at a new position within the document.

int	getPosition () const noexcept
	Returns the position as the number of characters from the start of the document.

void	setLineAndIndex (int newLineNumber, int newIndexInLine)
	Moves the position to a new line and index within the line.

int	getLineNumber () const noexcept
	Returns the line number of this position.

int	getIndexInLine () const noexcept
	Returns the number of characters from the start of the line.

void	setPositionMaintained (bool isMaintained)
	Allows the position to be automatically updated when the document changes.

void	moveBy (int characterDelta)
	Moves the position forwards or backwards by the specified number of characters.

Position	movedBy (int characterDelta) const
	Returns a position which is the same as this one, moved by the specified number of characters.

Position	movedByLines (int deltaLines) const
	Returns a position which is the same as this one, moved up or down by the specified number of lines.

juce_wchar	getCharacter () const
	Returns the character in the document at this position.

String	getLineText () const
	Returns the line from the document that this position is within.

Friends
class	CodeDocument

Detailed Description

A position in a code document.

Using this class you can find a position in a code document and quickly get its character position, line, and index. By calling setPositionMaintained (true), the position is automatically updated when text is inserted or deleted in the document, so that it maintains its original place in the text.

Definition at line 62 of file juce_CodeDocument.h.

Constructor & Destructor Documentation

◆ Position() [1/4]

juce::CodeDocument::Position::Position ( )

noexcept

Creates an uninitialised position.

Don't attempt to call any methods on this until you've given it an owner document to refer to!

Definition at line 333 of file juce_CodeDocument.cpp.

◆ Position() [2/4]

juce::CodeDocument::Position::Position	(	const CodeDocument &	ownerDocument,
		int	line,
		int	indexInLine
	)

noexcept

Creates a position based on a line and index in a document.

Note that this index is NOT the column number, it's the number of characters from the start of the line. The "column" number isn't quite the same, because if the line contains any tab characters, the relationship of the index to its visual column depends on the number of spaces per tab being used!

Lines are numbered from zero, and if the line or index are beyond the bounds of the document, they will be adjusted to keep them within its limits.

Definition at line 337 of file juce_CodeDocument.cpp.

◆ Position() [3/4]

juce::CodeDocument::Position::Position	(	const CodeDocument &	ownerDocument,
		int	charactersFromStartOfDocument
	)

noexcept

Creates a position based on a character index in a document.

This position is placed at the specified number of characters from the start of the document. The line and column are auto-calculated.

If the position is beyond the range of the document, it'll be adjusted to keep it inside.

Definition at line 345 of file juce_CodeDocument.cpp.

◆ Position() [4/4]

juce::CodeDocument::Position::Position ( const Position & other )

noexcept

Creates a copy of another position.

This will copy the position, but the new object will not be set to maintain its position, even if the source object was set to do so.

Definition at line 351 of file juce_CodeDocument.cpp.

◆ ~Position()

juce::CodeDocument::Position::~Position ( )

Destructor.

Definition at line 358 of file juce_CodeDocument.cpp.

Member Function Documentation

◆ getCharacter()

juce_wchar juce::CodeDocument::Position::getCharacter ( ) const

Returns the character in the document at this position.

See also: getLineText

Definition at line 516 of file juce_CodeDocument.cpp.

◆ getIndexInLine()

int juce::CodeDocument::Position::getIndexInLine ( ) const

noexcept

Returns the number of characters from the start of the line.

Note that this value is NOT the column at which the position appears in an editor. If the line contains any tab characters, the relationship of the index to its visual position depends on the number of spaces per tab being used!

Definition at line 144 of file juce_CodeDocument.h.

◆ getLineNumber()

int juce::CodeDocument::Position::getLineNumber ( ) const

noexcept

Returns the line number of this position.

The first line in the document is numbered zero, not one!

Definition at line 136 of file juce_CodeDocument.h.

◆ getLineText()

String juce::CodeDocument::Position::getLineText ( ) const

Returns the line from the document that this position is within.

See also: getCharacter, getLineNumber

Definition at line 524 of file juce_CodeDocument.cpp.

◆ getPosition()

int juce::CodeDocument::Position::getPosition ( ) const

noexcept

Returns the position as the number of characters from the start of the document.

See also: setPosition, getLineNumber, getIndexInLine

Definition at line 120 of file juce_CodeDocument.h.

◆ moveBy()

void juce::CodeDocument::Position::moveBy ( int characterDelta )

Moves the position forwards or backwards by the specified number of characters.

See also: movedBy

Definition at line 480 of file juce_CodeDocument.cpp.

◆ movedBy()

CodeDocument::Position juce::CodeDocument::Position::movedBy ( int characterDelta ) const

Returns a position which is the same as this one, moved by the specified number of characters.

See also: moveBy

Definition at line 502 of file juce_CodeDocument.cpp.

◆ movedByLines()

CodeDocument::Position juce::CodeDocument::Position::movedByLines ( int deltaLines ) const

Returns a position which is the same as this one, moved up or down by the specified number of lines.

See also: movedBy

Definition at line 509 of file juce_CodeDocument.cpp.

◆ operator!=()

bool juce::CodeDocument::Position::operator!= ( const Position & other ) const

noexcept

Definition at line 394 of file juce_CodeDocument.cpp.

◆ operator=()

CodeDocument::Position & juce::CodeDocument::Position::operator= ( const Position & other )

Definition at line 363 of file juce_CodeDocument.cpp.

◆ operator==()

bool juce::CodeDocument::Position::operator== ( const Position & other ) const

noexcept

Definition at line 383 of file juce_CodeDocument.cpp.

◆ setLineAndIndex()

void juce::CodeDocument::Position::setLineAndIndex	(	int	newLineNumber,
		int	newIndexInLine
	)

Moves the position to a new line and index within the line.

Note that the index is NOT the column at which the position appears in an editor. If the line contains any tab characters, the relationship of the index to its visual position depends on the number of spaces per tab being used!

Lines are numbered from zero, and if the line or index are beyond the bounds of the document, they will be adjusted to keep them within its limits.

Definition at line 399 of file juce_CodeDocument.cpp.

◆ setPosition()

void juce::CodeDocument::Position::setPosition ( int charactersFromStartOfDocument )

Points this object at a new position within the document.

If the position is beyond the range of the document, it'll be adjusted to keep it inside.

See also: getPosition, setLineAndIndex

Definition at line 435 of file juce_CodeDocument.cpp.

◆ setPositionMaintained()

void juce::CodeDocument::Position::setPositionMaintained ( bool isMaintained )

Allows the position to be automatically updated when the document changes.

If this is set to true, the position will register with its document so that when the document has text inserted or deleted, this position will be automatically moved to keep it at the same position in the text.

Definition at line 532 of file juce_CodeDocument.cpp.

Friends And Related Symbol Documentation

◆ CodeDocument

friend class CodeDocument

friend

Definition at line 187 of file juce_CodeDocument.h.

The documentation for this class was generated from the following files:

juce_gui_extra/code_editor/juce_CodeDocument.h
juce_gui_extra/code_editor/juce_CodeDocument.cpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Position() [1/4]

◆ Position() [2/4]

◆ Position() [3/4]

◆ Position() [4/4]

◆ ~Position()

Member Function Documentation

◆ getCharacter()

◆ getIndexInLine()

◆ getLineNumber()

◆ getLineText()

◆ getPosition()

◆ moveBy()

◆ movedBy()

◆ movedByLines()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ setLineAndIndex()

◆ setPosition()

◆ setPositionMaintained()

Friends And Related Symbol Documentation

◆ CodeDocument