KVIrc 5.2.6
Developer APIs
KviKvsVariantList Class Reference

Class to handle variant variables lists. More...

#include <KviKvsVariantList.h>

Public Member Functions

void allAsString (QString &szBuffer)
 Appends all elements in a single string delimited by spaces.
 
void append (bool bBoolean)
 Appends an element to the list.
 
void append (const QString &szParam, bool bEscape=false)
 Appends an element to the list.
 
void append (KviKvsArray *pArray)
 Appends an element to the list.
 
void append (KviKvsHash *pHash)
 Appends an element to the list.
 
void append (KviKvsVariant *pItem)
 Appends an element to the list.
 
void append (kvs_hobject_t hObject)
 Appends an element to the list.
 
void append (kvs_int_t iInt)
 Appends an element to the list.
 
void append (kvs_real_t dReal)
 Appends an element to the list.
 
KviKvsVariantat (int iIdx)
 Returns the element of the list at the given index.
 
void clear ()
 Clears the list.
 
unsigned int count ()
 Returns the size of the list.
 
KviKvsVariantfirst ()
 Returns the first element of the list.
 
bool firstAsString (QString &szBuffer)
 Returns true if there was a first parameter at all.
 
 KviKvsVariantList ()
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (KviKvsVariant *pV1)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (KviKvsVariant *pV1, KviKvsVariant *pV2)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (KviKvsVariant *pV1, KviKvsVariant *pV2, KviKvsVariant *pV3)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (KviKvsVariant *pV1, KviKvsVariant *pV2, KviKvsVariant *pV3, KviKvsVariant *pV4)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (KviKvsVariant *pV1, KviKvsVariant *pV2, KviKvsVariant *pV3, KviKvsVariant *pV4, KviKvsVariant *pV5)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (KviKvsVariant *pV1, KviKvsVariant *pV2, KviKvsVariant *pV3, KviKvsVariant *pV4, KviKvsVariant *pV5, KviKvsVariant *pV6)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (KviKvsVariant *pV1, KviKvsVariant *pV2, KviKvsVariant *pV3, KviKvsVariant *pV4, KviKvsVariant *pV5, KviKvsVariant *pV6, KviKvsVariant *pV7)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (QString *pS1)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (QString *pS1, QString *pS2)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (QString *pS1, QString *pS2, QString *pS3)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (QString *pS1, QString *pS2, QString *pS3, QString *pS4)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (QString *pS1, QString *pS2, QString *pS3, QString *pS4, QString *pS5)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (QString *pS1, QString *pS2, QString *pS3, QString *pS4, QString *pS5, QString *pS6)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (QString *pS1, QString *pS2, QString *pS3, QString *pS4, QString *pS5, QString *pS6, QString *pS7)
 Constructs the KviKvsVariantList object.
 
 KviKvsVariantList (QStringList *pSL)
 Constructs the KviKvsVariantList object.
 
KviKvsVariantnext ()
 Returns the next element of the list.
 
bool nextAsString (QString &szBuffer)
 Returns true if there was a next parameter at all.
 
void prepend (KviKvsVariant *pItem)
 Prepends an element to the list.
 
void setAutoDelete (bool bAutoDelete)
 Sets the auto delete flag on the list.
 
 ~KviKvsVariantList ()
 Destroys the KviKvsVariantList object.
 

Protected Attributes

KviPointerList< KviKvsVariant > * m_pList
 

Detailed Description

Class to handle variant variables lists.

Constructor & Destructor Documentation

◆ KviKvsVariantList() [1/16]

KviKvsVariantList::KviKvsVariantList ( )

Constructs the KviKvsVariantList object.

Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [2/16]

KviKvsVariantList::KviKvsVariantList ( KviKvsVariant * pV1)

Constructs the KviKvsVariantList object.

Parameters
pV1The first element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [3/16]

KviKvsVariantList::KviKvsVariantList ( KviKvsVariant * pV1,
KviKvsVariant * pV2 )

Constructs the KviKvsVariantList object.

Parameters
pV1The first element's list
pV2The second element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [4/16]

KviKvsVariantList::KviKvsVariantList ( KviKvsVariant * pV1,
KviKvsVariant * pV2,
KviKvsVariant * pV3 )

Constructs the KviKvsVariantList object.

Parameters
pV1The first element's list
pV2The second element's list
pV3The third element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [5/16]

KviKvsVariantList::KviKvsVariantList ( KviKvsVariant * pV1,
KviKvsVariant * pV2,
KviKvsVariant * pV3,
KviKvsVariant * pV4 )

Constructs the KviKvsVariantList object.

Parameters
pV1The first element's list
pV2The second element's list
pV3The third element's list
pV4The fourth element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [6/16]

KviKvsVariantList::KviKvsVariantList ( KviKvsVariant * pV1,
KviKvsVariant * pV2,
KviKvsVariant * pV3,
KviKvsVariant * pV4,
KviKvsVariant * pV5 )

Constructs the KviKvsVariantList object.

Parameters
pV1The first element's list
pV2The second element's list
pV3The third element's list
pV4The fourth element's list
pV5The fifth element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [7/16]

KviKvsVariantList::KviKvsVariantList ( KviKvsVariant * pV1,
KviKvsVariant * pV2,
KviKvsVariant * pV3,
KviKvsVariant * pV4,
KviKvsVariant * pV5,
KviKvsVariant * pV6 )

Constructs the KviKvsVariantList object.

Parameters
pV1The first element's list
pV2The second element's list
pV3The third element's list
pV4The fourth element's list
pV5The fifth element's list
pV6The sixth element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [8/16]

KviKvsVariantList::KviKvsVariantList ( KviKvsVariant * pV1,
KviKvsVariant * pV2,
KviKvsVariant * pV3,
KviKvsVariant * pV4,
KviKvsVariant * pV5,
KviKvsVariant * pV6,
KviKvsVariant * pV7 )

Constructs the KviKvsVariantList object.

Parameters
pV1The first element's list
pV2The second element's list
pV3The third element's list
pV4The fourth element's list
pV5The fifth element's list
pV6The sixth element's list
pV7The seventh element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [9/16]

KviKvsVariantList::KviKvsVariantList ( QString * pS1)

Constructs the KviKvsVariantList object.

Parameters
pS1The first element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [10/16]

KviKvsVariantList::KviKvsVariantList ( QString * pS1,
QString * pS2 )

Constructs the KviKvsVariantList object.

Parameters
pS1The first element's list
pS2The second element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [11/16]

KviKvsVariantList::KviKvsVariantList ( QString * pS1,
QString * pS2,
QString * pS3 )

Constructs the KviKvsVariantList object.

Parameters
pS1The first element's list
pS2The second element's list
pS3The third element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [12/16]

KviKvsVariantList::KviKvsVariantList ( QString * pS1,
QString * pS2,
QString * pS3,
QString * pS4 )

Constructs the KviKvsVariantList object.

Parameters
pS1The first element's list
pS2The second element's list
pS3The third element's list
pS4The fourth element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [13/16]

KviKvsVariantList::KviKvsVariantList ( QString * pS1,
QString * pS2,
QString * pS3,
QString * pS4,
QString * pS5 )

Constructs the KviKvsVariantList object.

Parameters
pS1The first element's list
pS2The second element's list
pS3The third element's list
pS4The fourth element's list
pS5The fifth element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [14/16]

KviKvsVariantList::KviKvsVariantList ( QString * pS1,
QString * pS2,
QString * pS3,
QString * pS4,
QString * pS5,
QString * pS6 )

Constructs the KviKvsVariantList object.

Parameters
pS1The first element's list
pS2The second element's list
pS3The third element's list
pS4The fourth element's list
pS5The fifth element's list
pS6The sixth element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [15/16]

KviKvsVariantList::KviKvsVariantList ( QString * pS1,
QString * pS2,
QString * pS3,
QString * pS4,
QString * pS5,
QString * pS6,
QString * pS7 )

Constructs the KviKvsVariantList object.

Parameters
pS1The first element's list
pS2The second element's list
pS3The third element's list
pS4The fourth element's list
pS5The fifth element's list
pS6The sixth element's list
pS7The seventh element's list
Returns
KviKvsVariantList

References m_pList.

◆ KviKvsVariantList() [16/16]

KviKvsVariantList::KviKvsVariantList ( QStringList * pSL)

Constructs the KviKvsVariantList object.

Parameters
pSLPointer to a QStringList
Returns
KviKvsVariantList

References m_pList.

◆ ~KviKvsVariantList()

KviKvsVariantList::~KviKvsVariantList ( )

Destroys the KviKvsVariantList object.

References m_pList.

Member Function Documentation

◆ allAsString()

void KviKvsVariantList::allAsString ( QString & szBuffer)

Appends all elements in a single string delimited by spaces.

Parameters
szBufferThe buffer where to store the string
Returns
void

References first(), next(), szBuffer, and v.

Referenced by KviKvsTreeNodeParameterReturn::execute().

◆ append() [1/8]

void KviKvsVariantList::append ( bool bBoolean)
inline

Appends an element to the list.

Parameters
bBooleanThe boolean element to append
Returns
void

References m_pList.

◆ append() [2/8]

void KviKvsVariantList::append ( const QString & szParam,
bool bEscape = false )
inline

Appends an element to the list.

Parameters
szParamThe string element to append
bEscapeWhether the string has to be escaped for KVS
Returns
void

References m_pList.

◆ append() [3/8]

void KviKvsVariantList::append ( KviKvsArray * pArray)
inline

Appends an element to the list.

Parameters
pArrayThe array element to append
Returns
void

References m_pList, and pArray.

◆ append() [4/8]

void KviKvsVariantList::append ( KviKvsHash * pHash)
inline

Appends an element to the list.

Parameters
pHashThe hash element to append
Returns
void

References m_pList.

◆ append() [5/8]

void KviKvsVariantList::append ( KviKvsVariant * pItem)
inline

Appends an element to the list.

Parameters
pItemThe element to append
Returns
void

References m_pList.

Referenced by KviScriptUserButton::btnClicked(), KviXmlHandler::characters(), KviKvsCallbackFileDialog::done(), KviKvsCallbackImageDialog::done(), KviKvsCallbackMessageBox::done(), KviKvsCallbackTextInput::done(), KviUserListView::emitDoubleClick(), KviUserListView::emitRightClick(), KviXmlHandler::endElement(), KviXmlHandler::error(), KviKvsTreeNodeDataList::evaluate(), KvsObject_widget::eventFilter(), KviKvsCallbackObject::execute(), KvsObject_xmlReader::fatalError(), KviKvsCoreSimpleCommands::KVSCSC(), KviKvsAsyncDnsOperation::lookupTerminated(), KviIrcView::mouseDoubleClickEvent(), KviIrcServerParser::parseLiteralQuit(), KviIrcServerParser::parseMessage(), KviIrcServerParser::parseNumericEndOfWhois(), KviIrcServerParser::parseNumericNoSuchNick(), KviIrcServerParser::parseNumericNoSuchServer(), popup_kvs_cmd_show(), setup_finish(), KvsObject_trayIcon::slotActivated(), KvsObject_ftp::slotCommandFinished(), KvsObject_http::slotDataReadProgress(), KvsObject_http::slotDataSendProgress(), KvsObject_ftp::slotDataTransferProgress(), KvsObject_http::slotDone(), KvsObject_socket::slotError(), KvsObject_ftp::slotListInfo(), KvsObject_http::slotReadyRead(), KvsObject_socket::slotReadyRead(), KvsObject_http::slotRequestFinished(), KvsObject_http::slotRequestStarted(), KvsObject_http::slotResponseHeaderReceived(), KvsObject_http::slotSslErrors(), KvsObject_ftp::slotStateChanged(), KvsObject_http::slotStateChanged(), KvsObject_socket::slotStateChanged(), KviXmlHandler::startElement(), SinglePopupEditor::testPopup(), HttpFileTransfer::transferTerminated(), KviKvsProcessAsyncOperation::trigger(), KviIrcView::triggerMouseRelatedKvsEvents(), and KviXmlHandler::warning().

◆ append() [6/8]

void KviKvsVariantList::append ( kvs_hobject_t hObject)
inline

Appends an element to the list.

Parameters
hObjectThe hObject element to append
Returns
void

References m_pList.

◆ append() [7/8]

void KviKvsVariantList::append ( kvs_int_t iInt)
inline

Appends an element to the list.

Parameters
iIntThe integer element to append
Returns
void

References m_pList.

◆ append() [8/8]

void KviKvsVariantList::append ( kvs_real_t dReal)
inline

Appends an element to the list.

Parameters
dRealThe real element to append
Returns
void

References m_pList.

◆ at()

KviKvsVariant * KviKvsVariantList::at ( int iIdx)
inline

Returns the element of the list at the given index.

Parameters
iIdxThe index of the list we want to extract
Returns
KviKvsVariant *

References m_pList.

Referenced by KviKvsTreeNodeMultipleParameterIdentifier::evaluateReadOnly(), KviKvsTreeNodeSingleParameterIdentifier::evaluateReadOnly(), KviIrcView::mouseDoubleClickEvent(), and PluginManager::pluginCall().

◆ clear()

void KviKvsVariantList::clear ( )
inline

Clears the list.

Returns
void

References m_pList.

Referenced by KviKvsTreeNodeDataList::evaluate().

◆ count()

◆ first()

◆ firstAsString()

bool KviKvsVariantList::firstAsString ( QString & szBuffer)

Returns true if there was a first parameter at all.

Parameters
szBufferThe buffer where to store the string
Returns
bool

References first(), szBuffer, and v.

◆ next()

◆ nextAsString()

bool KviKvsVariantList::nextAsString ( QString & szBuffer)

Returns true if there was a next parameter at all.

Parameters
szBufferThe buffer where to store the string
Returns
bool

References next(), szBuffer, and v.

◆ prepend()

void KviKvsVariantList::prepend ( KviKvsVariant * pItem)
inline

Prepends an element to the list.

Parameters
pItemThe element to prepend
Returns
void

References m_pList.

Referenced by KviKvsCoreSimpleCommands::KVSCSC().

◆ setAutoDelete()

Member Data Documentation

◆ m_pList


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