openshot-audio  0.1.7
Classes | Public Member Functions | Friends | List of all members
juce::CodeDocument Class Reference

#include <juce_gui_extra.h>

Classes

class  Iterator
 
class  Listener
 
class  Position
 

Public Member Functions

 CodeDocument ()
 
 ~CodeDocument ()
 
String getAllContent () const
 
String getTextBetween (const Position &start, const Position &end) const
 
String getLine (int lineIndex) const noexcept
 
int getNumCharacters () const noexcept
 
int getNumLines () const noexcept
 
int getMaximumLineLength () noexcept
 
void deleteSection (const Position &startPosition, const Position &endPosition)
 
void deleteSection (int startIndex, int endIndex)
 
void insertText (const Position &position, const String &text)
 
void insertText (int insertIndex, const String &text)
 
void replaceSection (int startIndex, int endIndex, const String &newText)
 
void replaceAllContent (const String &newContent)
 
void applyChanges (const String &newContent)
 
bool loadFromStream (InputStream &stream)
 
bool writeToStream (OutputStream &stream)
 
String getNewLineCharacters () const noexcept
 
void setNewLineCharacters (const String &newLine) noexcept
 
void newTransaction ()
 
void undo ()
 
void redo ()
 
void clearUndoHistory ()
 
UndoManagergetUndoManager () noexcept
 
void setSavePoint () noexcept
 
bool hasChangedSinceSavePoint () const noexcept
 
Position findWordBreakAfter (const Position &position) const noexcept
 
Position findWordBreakBefore (const Position &position) const noexcept
 
void findTokenContaining (const Position &pos, Position &start, Position &end) const noexcept
 
void findLineContaining (const Position &pos, Position &start, Position &end) const noexcept
 
void addListener (Listener *listener) noexcept
 
void removeListener (Listener *listener) noexcept
 

Friends

class CodeDocumentInsertAction
 
class CodeDocumentDeleteAction
 
class Iterator
 
class Position
 

Detailed Description

A class for storing and manipulating a source code file.

When using a CodeEditorComponent, it takes one of these as its source object.

The CodeDocument stores its content as an array of lines, which makes it quick to insert and delete.

See Also
CodeEditorComponent

Constructor & Destructor Documentation

CodeDocument::CodeDocument ( )

Creates a new, empty document.

CodeDocument::~CodeDocument ( )

Destructor.

Member Function Documentation

void CodeDocument::addListener ( Listener listener)
noexcept

Registers a listener object to receive callbacks when the document changes. If the listener is already registered, this method has no effect.

See Also
removeListener
void CodeDocument::applyChanges ( const String newContent)

Analyses the changes between the current content and some new text, and applies those changes.

void CodeDocument::clearUndoHistory ( )

Clears the undo history.

See Also
UndoManager::clearUndoHistory
void CodeDocument::deleteSection ( const Position startPosition,
const Position endPosition 
)

Deletes a section of the text. This operation is undoable.

void CodeDocument::deleteSection ( int  startIndex,
int  endIndex 
)

Deletes a section of the text. This operation is undoable.

void CodeDocument::findLineContaining ( const Position pos,
Position start,
Position end 
) const
noexcept

Finds the line that contains the given position.

void CodeDocument::findTokenContaining ( const Position pos,
Position start,
Position end 
) const
noexcept

Finds the token that contains the given position.

CodeDocument::Position CodeDocument::findWordBreakAfter ( const Position position) const
noexcept

Searches for a word-break.

CodeDocument::Position CodeDocument::findWordBreakBefore ( const Position position) const
noexcept

Searches for a word-break.

String CodeDocument::getAllContent ( ) const

Returns the full text of the document.

String CodeDocument::getLine ( int  lineIndex) const
noexcept

Returns a line from the document.

int CodeDocument::getMaximumLineLength ( )
noexcept

Returns the number of characters in the longest line of the document.

String juce::CodeDocument::getNewLineCharacters ( ) const
inlinenoexcept

Returns the preferred new-line characters for the document. This will be either "\n", "\r\n", or (rarely) "\r".

See Also
setNewLineCharacters
int CodeDocument::getNumCharacters ( ) const
noexcept

Returns the number of characters in the document.

int juce::CodeDocument::getNumLines ( ) const
inlinenoexcept

Returns the number of lines in the document.

String CodeDocument::getTextBetween ( const Position start,
const Position end 
) const

Returns a section of the document's text.

UndoManager& juce::CodeDocument::getUndoManager ( )
inlinenoexcept

Returns the document's UndoManager

bool CodeDocument::hasChangedSinceSavePoint ( ) const
noexcept

Returns true if the state of the document differs from the state it was in when setSavePoint() was last called.

See Also
setSavePoint
void CodeDocument::insertText ( const Position position,
const String text 
)

Inserts some text into the document at a given position. This operation is undoable.

void CodeDocument::insertText ( int  insertIndex,
const String text 
)

Inserts some text into the document at a given position. This operation is undoable.

bool CodeDocument::loadFromStream ( InputStream stream)

Replaces the editor's contents with the contents of a stream. This will also reset the undo history and save point marker.

void CodeDocument::newTransaction ( )

Begins a new undo transaction.

The document itself will not call this internally, so relies on whatever is using the document to periodically call this to break up the undo sequence into sensible chunks.

See Also
UndoManager::beginNewTransaction
void CodeDocument::redo ( )

Redo the last operation.

See Also
UndoManager::redo
void CodeDocument::removeListener ( Listener listener)
noexcept

Deregisters a listener.

See Also
addListener
void CodeDocument::replaceAllContent ( const String newContent)

Clears the document and replaces it with some new text.

This operation is undoable - if you're trying to completely reset the document, you might want to also call clearUndoHistory() and setSavePoint() after using this method.

void CodeDocument::replaceSection ( int  startIndex,
int  endIndex,
const String newText 
)

Replaces a section of the text with a new string. This operation is undoable.

void CodeDocument::setNewLineCharacters ( const String newLine)
noexcept

Sets the new-line characters that the document should use. The string must be either "\n", "\r\n", or (rarely) "\r".

See Also
getNewLineCharacters
void CodeDocument::setSavePoint ( )
noexcept

Makes a note that the document's current state matches the one that is saved.

After this has been called, hasChangedSinceSavePoint() will return false until the document has been altered, and then it'll start returning true. If the document is altered, but then undone until it gets back to this state, hasChangedSinceSavePoint() will again return false.

See Also
hasChangedSinceSavePoint
void CodeDocument::undo ( )

Undo the last operation.

See Also
UndoManager::undo
bool CodeDocument::writeToStream ( OutputStream stream)

Writes the editor's current contents to a stream.

Friends And Related Function Documentation

friend class CodeDocumentDeleteAction
friend
friend class CodeDocumentInsertAction
friend
friend class Iterator
friend
friend class Position
friend

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