bibhtml  1.0
 All Classes Functions Variables Enumerations
Public Member Functions | Public Attributes | List of all members
BibEntries Class Reference

List of bibliographic entries. More...

Inheritance diagram for BibEntries:

Public Member Functions

BibEntriesfind (const std::string &query, bool ignoreCase, bool abridgedFields) const
 Search entries. More...
 
BibEntriessort (const std::string &pattern, bool abridged) const
 Sort entries. More...
 

Public Attributes

elements
 STL member.
 

Detailed Description

List of bibliographic entries.

Member Function Documentation

BibEntries * BibEntries::find ( const std::string &  query,
bool  ignoreCase,
bool  abridgedFields 
) const

Search entries.

This function returns a new BibList that contains the references that match the query argument. An empty list is returned if no reference matches and a null pointer in case of an error.

Query syntax is: field1 & field2=value2 & field3!=value3 & field4=value4a|!value4b ... All conditions betwen "&" symbols must be met. These conditions mean:

  • field1 : field1 is unempty
  • field2=value2 : field2 contains value2
  • field3!=value3 : field3 does not contains value3
  • field4=value4a|!value4b : field4 contains value4a OR does not contain value4b

Field names can be abridged if abridgedFields is true. Case does not matter if ignoreCase is true.

BibEntries * BibEntries::sort ( const std::string &  pattern,
bool  abridged 
) const

Sort entries.

Syntax is: field1 & -field2 & ... A - prefix reverses order. Field names can be abridged if abridged is true.


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