[KLF Application][KLF Tools][KLF Backend][KLF Home]
KLatexFormula Project
Public Types | Public Member Functions | Public Attributes | List of all members
KLFLibResourceEngine::QueryResult Struct Reference

A structure that will hold the result of a query() query. More...

#include <klflib.h>

Collaboration diagram for KLFLibResourceEngine::QueryResult:
Collaboration graph
[legend]

Public Types

enum  Flags { FillEntryIdList = 0x01, FillRawEntryList = 0x02, FillEntryWithIdList = 0x04 }
 

Public Member Functions

 QueryResult (uint fill_flags=0x00)
 

Public Attributes

uint fillFlags
 
QList< KLFLib::entryIdentryIdList
 
KLFLibEntryList rawEntryList
 
QList< KLFLibEntryWithIdentryWithIdList
 

Detailed Description

A structure that will hold the result of a query() query.

This class will contain the entry ID list, the raw entry list and the entry-with-id list of the entries that matched the query() query this object was given to.

fillFlags may specify which of the aforementioned lists are to be filled (those that are not needed by the caller don't have to be filled, this saves time). You may pass those flags to the constructor.

Once the fillFlags adjusted, pass a pointer to this object to the query() function to retrieve results.

Warning
The lists in this object are not garanteed to be cleared at the beginning of query(). If you recycle this object to call query() a second time, be sure to clean this object first.

Definition at line 970 of file klflib.h.

Member Enumeration Documentation

Enumerator
FillEntryIdList 
FillRawEntryList 
FillEntryWithIdList 

Definition at line 972 of file klflib.h.

Constructor & Destructor Documentation

KLFLibResourceEngine::QueryResult::QueryResult ( uint  fill_flags = 0x00)
inline

Constructor. Sets fillFlags as given, and sets reasonable default values for the other members.

Definition at line 976 of file klflib.h.

Member Data Documentation

QList<KLFLib::entryId> KLFLibResourceEngine::QueryResult::entryIdList
QList<KLFLibEntryWithId> KLFLibResourceEngine::QueryResult::entryWithIdList
uint KLFLibResourceEngine::QueryResult::fillFlags
KLFLibEntryList KLFLibResourceEngine::QueryResult::rawEntryList

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

Generated by doxygen 1.8.11