KVIrc 5.2.6
Developer APIs
KviInputHistory Class Reference

Input history class. More...

#include <KviInputHistory.h>

Public Member Functions

void add (const QString &szString)
 Adds a string to the history.
 
std::vector< QString > list ()
 Returns the list of string in the history.
 
void load (const QString &szFileName)
 Loads the history.
 
void save (const QString &szFileName)
 Saves the history.
 

Static Public Member Functions

static void done ()
 Destroys the class instance.
 
static void init ()
 Initializes the class instance.
 
static KviInputHistoryinstance ()
 Returns the instance of the class.
 

Protected Attributes

std::vector< QString > m_StringList
 

Static Private Attributes

static KviInputHistorym_pSelf = nullptr
 

Detailed Description

Input history class.

Member Function Documentation

◆ add()

void KviInputHistory::add ( const QString & szString)

Adds a string to the history.

Parameters
szStringThe string to add
Returns
void

References KVI_INPUT_MAX_GLOBAL_HISTORY_ENTRIES, and m_StringList.

Referenced by KviInputEditor::finishInput(), load(), KviInputEditor::sendKvs(), and KviInputEditor::sendPlain().

◆ done()

void KviInputHistory::done ( )
static

Destroys the class instance.

Returns
void

References m_pSelf.

Referenced by KviApplication::~KviApplication().

◆ init()

void KviInputHistory::init ( )
static

Initializes the class instance.

Returns
void

References m_pSelf.

Referenced by KviApplication::setup().

◆ instance()

◆ list()

std::vector< QString > KviInputHistory::list ( )
inline

Returns the list of string in the history.

Returns
KviPointerList<QString> *

References m_StringList.

◆ load()

void KviInputHistory::load ( const QString & szFileName)

◆ save()

void KviInputHistory::save ( const QString & szFileName)

Saves the history.

Parameters
szFileNameThe name of the file where to save
Returns
void

References KviConfigurationFile::clear(), m_StringList, KviCString::ptr(), KviCString::sprintf(), KviConfigurationFile::Write, and KviConfigurationFile::writeEntry().

Referenced by KviApplication::saveInputHistory().

Member Data Documentation

◆ m_pSelf

KviInputHistory * KviInputHistory::m_pSelf = nullptr
staticprivate

Referenced by done(), init(), and instance().

◆ m_StringList

std::vector<QString> KviInputHistory::m_StringList
protected

Referenced by add(), list(), and save().


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