Zbl::ZLogBookmark Class Reference

Encapsulates information necessary to locate a collection of log records in a log file. More...

#include <ZLogBookmark.h>

Inheritance diagram for Zbl::ZLogBookmark:

Collaboration diagram for Zbl::ZLogBookmark:

Public Types
enum	bookmarkType { RecordNumber = 0, RecordIndex }
typedef QList< ZLogBookmark * >	zLogBookmarkList
Public Types inherited from Zbl::ZLogMap
enum	MarkType { Invalid = ZblLogMapData::Invalid, Selection = ZblLogMapData::Selection, Searchmap = ZblLogMapData::Searchmap, Bookmark = ZblLogMapData::Bookmark }
	Types of log maps: Invalid, Selection, Search, Bookmark. More...
enum	MarkRole { FirstID = ZblLogMapData::FirstID, SeekPosition = ZblLogMapData::SeekPosition, MessageText = ZblLogMapData::MessageText }
	Roles for the log map's data model. More...
typedef QList< ZLogMap * >	zLogMapList

Public Slots
QString	getMarkName () const
void	setMarkName (const QString &name)
QString	getNote () const
void	setNote (const QString &note)
Public Slots inherited from Zbl::ZLogMap
void	insertMark (qint64 recordID, qint64 lastRecordID, qint64 seekPosition)
	Creates a new log mark in the database. More...
bool	hasMark (qint64 recordID)
	Determine if the log map contains a mark for the specified log record. More...
qint64	findNextMark (qint64 startID, bool forward=true) const
	Search forward or backward for the next mark from a specified starting position. More...
bool	removeMark (qint64 recordID, qint64 lastRecordID)
	Removes the specified mark from the log map. More...
void	clear ()
	Removes all marks from the log map. More...

Public Member Functions
	ZLogBookmark (ZLogReader *reader)
	ZLogBookmark (ZLogReader *reader, const QString &name)
Public Member Functions inherited from Zbl::ZLogMap
	ZLogMap (ZLogReader *reader)
	Constructor. More...
MarkType	getMapType ()
	returns this log map's mark type More...
Q_INVOKABLE QObject *	getReader () const
	Returns the foreground log file reader object for this log map. More...

Protected Member Functions
virtual int	logMapType ()
	Returns log map type. Override of ZLogMap::logMapType(). More...
Protected Member Functions inherited from Zbl::ZLogMap
ZLogReader *	getZReader () const
	Returns the foreground log file reader object for this search. More...

Protected Attributes
QString	m_bookmarkName
	Display name for this bookmark. More...
QString	m_note
	Annotation for this bookmark. More...
Protected Attributes inherited from Zbl::ZLogMap
ZBL_DECLARE_LOGGED_OBJECT ZblLogMap	m_map
	Create the m_tag object that presents a Javascript interface to constant integer values. More...
ZLogReader *	m_reader
	The log file reader that created this search object. More...

Properties
QString	name
QString	note
Properties inherited from Zbl::ZLogMap
int	mapType

Additional Inherited Members
Signals inherited from Zbl::ZLogMap
void	selectionUpdated ()
	Sent whenever the ZLogMap state has been changed. More...
Static Public Member Functions inherited from Zbl::ZLogMap
static void	registerType ()
	Registers ZLogMap as a QML type. More...

Detailed Description

Encapsulates information necessary to locate a collection of log records in a log file.

TBD: Don't subclass ZLogMap, encapsulate it! Conversion from searchmark to bookmark can copy map implicitly.

Definition at line 46 of file ZLogBookmark.h.

Member Typedef Documentation

zLogBookmarkList

typedef QList<ZLogBookmark*> Zbl::ZLogBookmark::zLogBookmarkList

Definition at line 57 of file ZLogBookmark.h.

Member Enumeration Documentation

bookmarkType

enum Zbl::ZLogBookmark::bookmarkType

Enumerator
RecordNumber
RecordIndex

Definition at line 51 of file ZLogBookmark.h.

Constructor & Destructor Documentation

ZLogBookmark() [1/2]

Zbl::ZLogBookmark::ZLogBookmark ( ZLogReader *  reader )

explicit

Definition at line 30 of file ZLogBookmark.cpp.

ZLogBookmark() [2/2]

Zbl::ZLogBookmark::ZLogBookmark ( ZLogReader *  reader, const QString &  name  )

explicit

Definition at line 36 of file ZLogBookmark.cpp.

Member Function Documentation

getMarkName

QString Zbl::ZLogBookmark::getMarkName ( ) const

slot

Definition at line 42 of file ZLogBookmark.cpp.

Referenced by Zbl::ZLogReader::getBookmark(), Zbl::ZLogReader::getBookmarkNames(), Zbl::ZLogReader::getSearch(), and Zbl::ZLogReader::removeSearchModel().

getNote

QString Zbl::ZLogBookmark::getNote ( ) const

slot

Definition at line 52 of file ZLogBookmark.cpp.

logMapType()

int Zbl::ZLogBookmark::logMapType ( )

protectedvirtual

Returns log map type. Override of ZLogMap::logMapType().

Returns

the map type ZLogMap::Bookmark

Reimplemented from Zbl::ZLogMap.

Reimplemented in Zbl::ZblLogSearch.

Definition at line 62 of file ZLogBookmark.cpp.

setMarkName

void Zbl::ZLogBookmark::setMarkName ( const QString &  name )

slot

Definition at line 47 of file ZLogBookmark.cpp.

Referenced by Zbl::ZLogReader::newBookmark(), and Zbl::ZblLogSearch::ZblLogSearch().

setNote

void Zbl::ZLogBookmark::setNote ( const QString &  note )

slot

Definition at line 57 of file ZLogBookmark.cpp.

Member Data Documentation

m_bookmarkName

QString Zbl::ZLogBookmark::m_bookmarkName

protected

Display name for this bookmark.

Definition at line 119 of file ZLogBookmark.h.

Referenced by getMarkName(), getNote(), logMapType(), and setMarkName().

m_note

QString Zbl::ZLogBookmark::m_note

protected

Annotation for this bookmark.

Definition at line 125 of file ZLogBookmark.h.

Referenced by logMapType(), and setNote().

Property Documentation

name

QString Zbl::ZLogBookmark::name

readwrite

Definition at line 62 of file ZLogBookmark.h.

Referenced by Zbl::ZblLogSearch::getSearchRolesName(), setMarkName(), and ZLogBookmark().

note

QString Zbl::ZLogBookmark::note

readwrite

Definition at line 63 of file ZLogBookmark.h.

Referenced by setNote().

---

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

• zblcore/ZLogBookmark.h
• zblcore/ZLogBookmark.cpp