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...
 
void * nTipId
 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 257 of file edtwin.cxx.

Constructor & Destructor Documentation

◆ QuickHelpData()

QuickHelpData::QuickHelpData ( )
inline

Definition at line 277 of file edtwin.cxx.

References ClearContent().

Member Function Documentation

◆ ClearContent()

void QuickHelpData::ClearContent ( )

◆ CurLen()

sal_uInt16 QuickHelpData::CurLen ( ) const
inline

Definition at line 286 of file edtwin.cxx.

References m_aHelpStrings, and nCurArrPos.

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

◆ CurStr()

const OUString & QuickHelpData::CurStr ( ) const
inline

Definition at line 285 of file edtwin.cxx.

References m_aHelpStrings, and nCurArrPos.

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

◆ FillStrArr()

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

◆ HasContent()

bool QuickHelpData::HasContent ( ) const
inline

Definition at line 284 of file edtwin.cxx.

References m_aHelpStrings, nCurArrPos, and nNoPos.

Referenced by SwEditWin::KeyInput().

◆ Move()

void QuickHelpData::Move ( QuickHelpData rCpy)

Definition at line 6222 of file edtwin.cxx.

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

Referenced by SwEditWin::KeyInput().

◆ Next()

void QuickHelpData::Next ( bool  bEndLess)
inline

Next help string.

Definition at line 289 of file edtwin.cxx.

References m_aHelpStrings, m_bIsAutoText, and nCurArrPos.

Referenced by SwEditWin::KeyInput().

◆ Previous()

void QuickHelpData::Previous ( bool  bEndLess)
inline

Previous help string.

Definition at line 295 of file edtwin.cxx.

References m_aHelpStrings, m_bIsAutoText, and nCurArrPos.

Referenced by SwEditWin::KeyInput().

◆ SortAndFilter()

void QuickHelpData::SortAndFilter ( const OUString &  rOrigWord)

Definition at line 6453 of file edtwin.cxx.

References m_aHelpStrings, and nCurArrPos.

Referenced by SwEditWin::ShowAutoCorrectQuickHelp().

◆ Start()

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

◆ Stop()

void QuickHelpData::Stop ( SwWrtShell rSh)

Member Data Documentation

◆ m_aHelpStrings

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 260 of file edtwin.cxx.

Referenced by ClearContent(), CurLen(), CurStr(), FillStrArr(), HasContent(), Move(), Next(), Previous(), SwEditWin::ShowAutoCorrectQuickHelp(), SwEditWin::ShowAutoText(), and SortAndFilter().

◆ m_bAppendSpace

bool QuickHelpData::m_bAppendSpace

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

Definition at line 272 of file edtwin.cxx.

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

◆ m_bIsAutoText

bool QuickHelpData::m_bIsAutoText

Help data stores AutoText names rather than AutoComplete words.

Definition at line 266 of file edtwin.cxx.

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

◆ m_bIsDisplayed

bool QuickHelpData::m_bIsDisplayed

◆ m_bIsTip

bool QuickHelpData::m_bIsTip

Display help string as a tip rather than inline.

Definition at line 268 of file edtwin.cxx.

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

◆ nCurArrPos

sal_uInt16 QuickHelpData::nCurArrPos

Index of the current help string.

Definition at line 262 of file edtwin.cxx.

Referenced by ClearContent(), CurLen(), CurStr(), HasContent(), Move(), Next(), Previous(), SortAndFilter(), and Start().

◆ nNoPos

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

Definition at line 263 of file edtwin.cxx.

Referenced by ClearContent(), and HasContent().

◆ nTipId

void* QuickHelpData::nTipId

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

Definition at line 270 of file edtwin.cxx.

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


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