LibreOffice Module sw (master)  1
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
QuickHelpData Struct Reference

Assists with auto-completion of AutoComplete words and AutoText names. More...

Public Member Functions

 QuickHelpData ()
 
void Move (QuickHelpData &rCpy)
 
void ClearContent ()
 
void Start (SwWrtShell &rSh, bool bRestart)
 
void Stop (SwWrtShell &rSh)
 
bool HasContent () const
 
const OUString & CurStr () const
 
sal_uInt16 CurLen () const
 
void Next (bool bEndLess)
 Next help string. More...
 
void Previous (bool bEndLess)
 Previous help string. More...
 
void FillStrArr (SwWrtShell const &rSh, const OUString &rWord)
 
void SortAndFilter (const OUString &rOrigWord)
 

Public Attributes

std::vector< std::pair< OUString, sal_uInt16 > > m_aHelpStrings
 Strings that at least partially match an input word, and match length. More...
 
sal_uInt16 nCurArrPos
 Index of the current help string. More...
 
bool m_bIsAutoText
 Help data stores AutoText names rather than AutoComplete words. More...
 
bool m_bIsTip
 Display help string as a tip rather than inline. More...
 
voidnTipId
 Tip ID when a help string is displayed as a tip. More...
 
bool m_bAppendSpace
 Append a space character to the displayed help string (if appropriate). More...
 
bool m_bIsDisplayed
 Help string is currently displayed. More...
 

Static Public Attributes

static constexpr sal_uInt16 nNoPos = std::numeric_limits<sal_uInt16>::max()
 

Detailed Description

Assists with auto-completion of AutoComplete words and AutoText names.

Definition at line 265 of file edtwin.cxx.

Constructor & Destructor Documentation

QuickHelpData::QuickHelpData ( )
inline

Definition at line 285 of file edtwin.cxx.

Member Function Documentation

void QuickHelpData::ClearContent ( )
sal_uInt16 QuickHelpData::CurLen ( ) const
inline

Definition at line 294 of file edtwin.cxx.

Referenced by SwEditWin::KeyInput(), and Start().

const OUString& QuickHelpData::CurStr ( ) const
inline

Definition at line 293 of file edtwin.cxx.

Referenced by SwEditWin::KeyInput(), and Start().

void QuickHelpData::FillStrArr ( SwWrtShell const &  rSh,
const OUString &  rWord 
)
bool QuickHelpData::HasContent ( ) const
inline

Definition at line 292 of file edtwin.cxx.

Referenced by SwEditWin::KeyInput().

void QuickHelpData::Move ( QuickHelpData rCpy)

Definition at line 5862 of file edtwin.cxx.

References m_aHelpStrings, m_bAppendSpace, m_bIsAutoText, m_bIsDisplayed, m_bIsTip, and nCurArrPos.

Referenced by SwEditWin::KeyInput().

void QuickHelpData::Next ( bool  bEndLess)
inline

Next help string.

Definition at line 297 of file edtwin.cxx.

Referenced by SwEditWin::KeyInput().

void QuickHelpData::Previous ( bool  bEndLess)
inline

Previous help string.

Definition at line 303 of file edtwin.cxx.

Referenced by SwEditWin::KeyInput().

void QuickHelpData::SortAndFilter ( const OUString &  rOrigWord)

Definition at line 6103 of file edtwin.cxx.

References m_aHelpStrings, and nCurArrPos.

Referenced by SwEditWin::ShowAutoCorrectQuickHelp().

void QuickHelpData::Start ( SwWrtShell rSh,
bool  bRestart 
)
void QuickHelpData::Stop ( SwWrtShell rSh)

Member Data Documentation

std::vector<std::pair<OUString, sal_uInt16> > QuickHelpData::m_aHelpStrings

Strings that at least partially match an input word, and match length.

Definition at line 268 of file edtwin.cxx.

Referenced by ClearContent(), FillStrArr(), Move(), SwEditWin::ShowAutoCorrectQuickHelp(), SwEditWin::ShowAutoText(), and SortAndFilter().

bool QuickHelpData::m_bAppendSpace

Append a space character to the displayed help string (if appropriate).

Definition at line 280 of file edtwin.cxx.

Referenced by ClearContent(), and Move().

bool QuickHelpData::m_bIsAutoText

Help data stores AutoText names rather than AutoComplete words.

Definition at line 274 of file edtwin.cxx.

Referenced by ClearContent(), SwEditWin::KeyInput(), Move(), and SwEditWin::ShowAutoCorrectQuickHelp().

bool QuickHelpData::m_bIsDisplayed

Help string is currently displayed.

Definition at line 283 of file edtwin.cxx.

Referenced by ClearContent(), SwEditWin::Command(), SwEditWin::dispose(), SwEditWin::LoseFocus(), Move(), Start(), and SwEditWin::StopQuickHelp().

bool QuickHelpData::m_bIsTip

Display help string as a tip rather than inline.

Definition at line 276 of file edtwin.cxx.

Referenced by ClearContent(), Move(), SwEditWin::ShowAutoCorrectQuickHelp(), Start(), and Stop().

sal_uInt16 QuickHelpData::nCurArrPos

Index of the current help string.

Definition at line 270 of file edtwin.cxx.

Referenced by ClearContent(), Move(), SortAndFilter(), and Start().

constexpr sal_uInt16 QuickHelpData::nNoPos = std::numeric_limits<sal_uInt16>::max()
static

Definition at line 271 of file edtwin.cxx.

Referenced by ClearContent().

void* QuickHelpData::nTipId

Tip ID when a help string is displayed as a tip.

Definition at line 278 of file edtwin.cxx.

Referenced by ClearContent(), Start(), and Stop().


The documentation for this struct was generated from the following file: