LibreOffice Module sw (master)  1
Public Member Functions | 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, sal_uInt16 nWrdLen)
 
void Stop (SwWrtShell &rSh)
 
bool HasContent () 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< OUString > m_aHelpStrings
 Strings that at least partially match an input word. More...
 
sal_uInt16 nCurArrPos
 Index of the current help string. More...
 
sal_uInt16 nLen
 Length of the input word associated with the help data. 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...
 

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

Member Function Documentation

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

Definition at line 293 of file edtwin.cxx.

Referenced by SwEditWin::KeyInput().

void QuickHelpData::Move ( QuickHelpData rCpy)

Definition at line 5867 of file edtwin.cxx.

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

Referenced by SwEditWin::KeyInput().

void QuickHelpData::Next ( bool  bEndLess)
inline

Next help string.

Definition at line 296 of file edtwin.cxx.

Referenced by SwEditWin::KeyInput().

void QuickHelpData::Previous ( bool  bEndLess)
inline

Previous help string.

Definition at line 302 of file edtwin.cxx.

Referenced by SwEditWin::KeyInput().

void QuickHelpData::SortAndFilter ( const OUString &  rOrigWord)

Definition at line 6104 of file edtwin.cxx.

References m_aHelpStrings, and nCurArrPos.

Referenced by SwEditWin::ShowAutoTextCorrectQuickHelp().

void QuickHelpData::Start ( SwWrtShell rSh,
sal_uInt16  nWrdLen 
)
void QuickHelpData::Stop ( SwWrtShell rSh)

Member Data Documentation

std::vector<OUString> QuickHelpData::m_aHelpStrings

Strings that at least partially match an input word.

Definition at line 268 of file edtwin.cxx.

Referenced by ClearContent(), FillStrArr(), SwEditWin::KeyInput(), Move(), SwEditWin::ShowAutoTextCorrectQuickHelp(), SortAndFilter(), and Start().

bool QuickHelpData::m_bAppendSpace

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

Definition at line 281 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 275 of file edtwin.cxx.

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

bool QuickHelpData::m_bIsDisplayed

Help string is currently displayed.

Definition at line 284 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 277 of file edtwin.cxx.

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

sal_uInt16 QuickHelpData::nCurArrPos

Index of the current help string.

Definition at line 270 of file edtwin.cxx.

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

sal_uInt16 QuickHelpData::nLen

Length of the input word associated with the help data.

Definition at line 272 of file edtwin.cxx.

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

void* QuickHelpData::nTipId

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

Definition at line 279 of file edtwin.cxx.

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


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