WSF
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
wizard::SyntaxTips Class Reference

A popup window displaying the syntax for commands as the user types. More...

#include <SyntaxTips.hpp>

Inherits QWidget.

Collaboration diagram for wizard::SyntaxTips:
Collaboration graph
[legend]

Public Member Functions

 SyntaxTips (WsfEditor *aEditControlPtr)
 ~SyntaxTips () override
void ParseUpdate (bool aParseUpdate)
void ClearLabels ()
void HoverShow (size_t aCharOffset)
void EndHoverShow ()
void UserModification ()
void CursorMove ()
void Hide ()
QRect GetGeometry ()

Protected Member Functions

Project * getProject ()
void UpdateScriptTips ()
void CheckSizeChange ()
void paintEvent (QPaintEvent *) override
bool UpdateSuggestions (size_t aCharacterOffset)
void HoverCheck ()
void UpdateWindow (size_t aCursorOffset)
void UpdateScenario ()
 Updates the ParseUpdated callback if the scenario has changed.
void resizeEvent (QResizeEvent *) override

Protected Attributes

WsfEditor * mEditControlPtr
int mEditShow
bool mHoverShow
size_t mHoverCharacterOffset
UtCallbackHolder mCallbacks
QLabel * mLabel
QSize mPreviousSize
UtTextRange mCommandExtent
QTimer mHoverMaintainTimer
QRect mPreviousRect
std::unique_ptr< UtCallback > mParseUpdateCallbackPtr {nullptr}
WsfScriptLookup * mScriptLookupPtr
bool mNeedScriptUpdateOnCursorMove
QTimer mCursorMoveUpdateTimer

Detailed Description

A popup window displaying the syntax for commands as the user types.

Constructor & Destructor Documentation

◆ SyntaxTips()

wizard::SyntaxTips::SyntaxTips ( WsfEditor * aEditControlPtr)
explicit

References wizard::EditorPrefObject::EditorColor(), HoverCheck(), mCursorMoveUpdateTimer, mEditControlPtr, mEditShow, mHoverMaintainTimer, mHoverShow, mLabel, mNeedScriptUpdateOnCursorMove, mScriptLookupPtr, UpdateScenario(), and UpdateScriptTips().

◆ ~SyntaxTips()

wizard::SyntaxTips::~SyntaxTips ( )
override

References ClearLabels(), and mScriptLookupPtr.

Member Function Documentation

◆ CheckSizeChange()

void wizard::SyntaxTips::CheckSizeChange ( )
protected

References mEditControlPtr, and mPreviousRect.

Referenced by paintEvent().

◆ ClearLabels()

void wizard::SyntaxTips::ClearLabels ( )

References mLabel.

Referenced by UpdateSuggestions(), and ~SyntaxTips().

◆ CursorMove()

void wizard::SyntaxTips::CursorMove ( )

References mCommandExtent, mCursorMoveUpdateTimer, mEditControlPtr, mEditShow, mNeedScriptUpdateOnCursorMove, and pos.

◆ EndHoverShow()

void wizard::SyntaxTips::EndHoverShow ( )

References mEditShow, mHoverMaintainTimer, and mHoverShow.

Referenced by Hide(), HoverCheck(), HoverShow(), ParseUpdate(), and UserModification().

◆ GetGeometry()

QRect wizard::SyntaxTips::GetGeometry ( )

References mPreviousRect.

◆ getProject()

wizard::Project * wizard::SyntaxTips::getProject ( )
protected

References mEditControlPtr.

Referenced by HoverShow(), and UserModification().

◆ Hide()

void wizard::SyntaxTips::Hide ( )

References EndHoverShow(), mEditShow, and mNeedScriptUpdateOnCursorMove.

◆ HoverCheck()

void wizard::SyntaxTips::HoverCheck ( )
protected

References contains(), EndHoverShow(), mCommandExtent, mEditControlPtr, and pos.

Referenced by SyntaxTips().

◆ HoverShow()

void wizard::SyntaxTips::HoverShow ( size_t aCharOffset)

References EndHoverShow(), getProject(), mEditShow, mHoverCharacterOffset, mHoverMaintainTimer, mHoverShow, UpdateScenario(), and UpdateSuggestions().

◆ paintEvent()

void wizard::SyntaxTips::paintEvent ( QPaintEvent * e)
overrideprotected

References CheckSizeChange(), mLabel, and mPreviousSize.

◆ ParseUpdate()

void wizard::SyntaxTips::ParseUpdate ( bool aParseUpdate)

References EndHoverShow(), mEditControlPtr, mEditShow, mHoverCharacterOffset, mHoverMaintainTimer, mHoverShow, and UpdateSuggestions().

Referenced by UpdateScenario(), UpdateScriptTips(), and UserModification().

◆ resizeEvent()

void wizard::SyntaxTips::resizeEvent ( QResizeEvent * e)
overrideprotected

References mEditControlPtr, and pos.

◆ UpdateScenario()

void wizard::SyntaxTips::UpdateScenario ( )
protected

Updates the ParseUpdated callback if the scenario has changed.

References mEditControlPtr, mParseUpdateCallbackPtr, and ParseUpdate().

Referenced by HoverShow(), SyntaxTips(), and UserModification().

◆ UpdateScriptTips()

void wizard::SyntaxTips::UpdateScriptTips ( )
protected

References mCursorMoveUpdateTimer, mNeedScriptUpdateOnCursorMove, and ParseUpdate().

Referenced by SyntaxTips().

◆ UpdateSuggestions()

bool wizard::SyntaxTips::UpdateSuggestions ( size_t aCharacterOffset)
protected

References ClearLabels(), wizard::WsfScriptLookup::cNO_SCRIPT, wizard::InputContext::ContextFromCursor(), wizard::WsfScriptLookup::cSTOP_AT_END_OF_STATEMENT, wizard::WsfScriptLookup::cSUCCESS, UsFunction::cVARARGS, wizard::TextSource::GetSource(), wizard::AutoComplete::GetSyntax(), WsfParseUtil::IsWhitespace(), UsFunction::mArgs, wizard::InputContext::Context::mBlockNodePtr, mCommandExtent, wizard::AutoComplete::SyntaxResults::mConcreteWordCount, mEditControlPtr, UsFunction::mFlags, mHoverShow, mLabel, mNeedScriptUpdateOnCursorMove, wizard::InputContext::Context::mQueryTextRange, UsFunction::mReturnType, mScriptLookupPtr, wizard::AutoComplete::SyntaxResults::mSequences, wizard::AutoComplete::SyntaxResults::mWordIndex, wizard::Project::ParseIsUpToDate(), pos, DynamicArray< T, ARRAY_SIZE, GROW_SIZE >::size(), and UpdateWindow().

Referenced by HoverShow(), and ParseUpdate().

◆ UpdateWindow()

void wizard::SyntaxTips::UpdateWindow ( size_t aCursorOffset)
protected

References mEditControlPtr, and mEditShow.

Referenced by UpdateSuggestions().

◆ UserModification()

void wizard::SyntaxTips::UserModification ( )

References EndHoverShow(), getProject(), mEditShow, ParseUpdate(), and UpdateScenario().

Member Data Documentation

◆ mCallbacks

UtCallbackHolder wizard::SyntaxTips::mCallbacks
protected

◆ mCommandExtent

UtTextRange wizard::SyntaxTips::mCommandExtent
protected

Referenced by CursorMove(), HoverCheck(), and UpdateSuggestions().

◆ mCursorMoveUpdateTimer

QTimer wizard::SyntaxTips::mCursorMoveUpdateTimer
protected

Referenced by CursorMove(), SyntaxTips(), and UpdateScriptTips().

◆ mEditControlPtr

WsfEditor* wizard::SyntaxTips::mEditControlPtr
protected

Referenced by CheckSizeChange(), CursorMove(), getProject(), HoverCheck(), ParseUpdate(), resizeEvent(), SyntaxTips(), UpdateScenario(), UpdateSuggestions(), and UpdateWindow().

◆ mEditShow

int wizard::SyntaxTips::mEditShow
protected

Referenced by CursorMove(), EndHoverShow(), Hide(), HoverShow(), ParseUpdate(), SyntaxTips(), UpdateWindow(), and UserModification().

◆ mHoverCharacterOffset

size_t wizard::SyntaxTips::mHoverCharacterOffset
protected

Referenced by HoverShow(), and ParseUpdate().

◆ mHoverMaintainTimer

QTimer wizard::SyntaxTips::mHoverMaintainTimer
protected

Referenced by EndHoverShow(), HoverShow(), ParseUpdate(), and SyntaxTips().

◆ mHoverShow

bool wizard::SyntaxTips::mHoverShow
protected

Referenced by EndHoverShow(), HoverShow(), ParseUpdate(), SyntaxTips(), and UpdateSuggestions().

◆ mLabel

QLabel* wizard::SyntaxTips::mLabel
protected

Referenced by ClearLabels(), paintEvent(), SyntaxTips(), and UpdateSuggestions().

◆ mNeedScriptUpdateOnCursorMove

bool wizard::SyntaxTips::mNeedScriptUpdateOnCursorMove
protected

Referenced by CursorMove(), Hide(), SyntaxTips(), UpdateScriptTips(), and UpdateSuggestions().

◆ mParseUpdateCallbackPtr

std::unique_ptr<UtCallback> wizard::SyntaxTips::mParseUpdateCallbackPtr {nullptr}
protected

Referenced by UpdateScenario().

◆ mPreviousRect

QRect wizard::SyntaxTips::mPreviousRect
protected

Referenced by CheckSizeChange(), and GetGeometry().

◆ mPreviousSize

QSize wizard::SyntaxTips::mPreviousSize
protected

Referenced by paintEvent().

◆ mScriptLookupPtr

WsfScriptLookup* wizard::SyntaxTips::mScriptLookupPtr
protected

Referenced by SyntaxTips(), UpdateSuggestions(), and ~SyntaxTips().

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved