WARNING: USE THIS SOFTWARE AT YOUR OWN RISK! THIS IS EXPERIMENTAL SOFTWARE NOT INTENDED FOR PRODUCTION USE! Zuble is currently an early stage prototype. As such Zuble is minimally tested and inherently unstable. It is provided for experimental, development, and demonstration purposes only. Zuble QML Types   |  Zuble C++ Classes   |  Zuble Overview
Zuble  0.1
Zuble Framework C++/QML extension API
Public Types | Public Slots | Signals | Public Member Functions | Protected Attributes | Properties | Friends | List of all members
Zbl::ZLogSearch Class Reference

A wrapper for the explicitly shared ZblLogSearch object. More...

#include <ZLogSearch.h>

Inheritance diagram for Zbl::ZLogSearch:
Inheritance graph
[legend]
Collaboration diagram for Zbl::ZLogSearch:
Collaboration graph
[legend]

Public Types

enum  SearchState { Initial = ZblLogSearch::BEGIN, Scanning = ZblLogSearch::SCANNING, Paused = ZblLogSearch::PAUSED, Complete = ZblLogSearch::COMPLETE }
 
enum  SearchType { CaseSensitive = SearchCaseSensitive, CaseInsensitive = SearchCaseInsensitive }
 

Public Slots

void search ()
 

Signals

void notifySearchState (int newValue)
 
void notifySearchForward (bool newValue)
 
void notifySearchBackward (bool newValue)
 
void notifyActive (bool newValue)
 
void notifySaved (bool newValue)
 
void notifyCompletionFileSize (qint64 newValue)
 

Public Member Functions

 ZLogSearch (QSharedPointer< ZblLogSearch > searchPtr, ZLogReader *reader)
 
QSharedPointer< ZblLogSearch > getZSearch ()
 
QString getPhrase () const
 
int getSearchType () const
 
QList< int > getSearchRoles () const
 
int getCaseSensitive () const
 
int getCaseInsensitive () const
 
int getSearchState () const
 
bool getSearchForward () const
 
void setSearchForward (bool forward)
 
bool getSearchBackward () const
 
void setSearchBackward (bool backward)
 
bool getActive () const
 
bool getSaved () const
 
qint64 getCompletionFileSize () const
 
Q_INVOKABLE QObject * getReader () const
 Returns the foreground log file reader object for this search. More...
 
Q_INVOKABLE QObject * resultModel ()
 Obtain a list model containing an item for each log record represented in the ZLogSearchMark's result set. This is used to display log record links. More...
 
Q_INVOKABLE bool isValid () const
 Determine if this wrapper object points to a valid search object. More...
 
void onInvalidate ()
 Handler for the ZblLogSearch::invalidate signal. More...
 

Protected Attributes

QSharedPointer< ZblLogSearch > m_search
 

Properties

QString searchPhrase
 
int searchType
 
QList< int > searchRoles
 
int status
 
bool active
 
bool saved
 
qint64 completionFileSize
 
bool searchForward
 
bool searchBackward
 
int CaseSensitive
 
int CaseInsensitive
 

Friends

class ZLogViewport
 

Detailed Description

A wrapper for the explicitly shared ZblLogSearch object.

See also
Zbl::ZblLogSearch

Definition at line 18 of file ZLogSearch.h.

Member Enumeration Documentation

◆ SearchState

enum Zbl::ZLogSearch::SearchState
Enumerator
Initial 
Scanning 
Paused 
Complete 

Definition at line 28 of file ZLogSearch.h.

◆ SearchType

enum Zbl::ZLogSearch::SearchType
Enumerator
CaseSensitive 
CaseInsensitive 

Definition at line 37 of file ZLogSearch.h.

Constructor & Destructor Documentation

◆ ZLogSearch()

Zbl::ZLogSearch::ZLogSearch ( QSharedPointer< ZblLogSearch >  searchPtr,
ZLogReader *  reader 
)
explicit

Definition at line 6 of file ZLogSearch.cpp.

Member Function Documentation

◆ getActive()

bool Zbl::ZLogSearch::getActive ( ) const

Definition at line 65 of file ZLogSearch.cpp.

◆ getCaseInsensitive()

int Zbl::ZLogSearch::getCaseInsensitive ( ) const

Definition at line 51 of file ZLogSearch.cpp.

◆ getCaseSensitive()

int Zbl::ZLogSearch::getCaseSensitive ( ) const

Definition at line 46 of file ZLogSearch.cpp.

◆ getCompletionFileSize()

qint64 Zbl::ZLogSearch::getCompletionFileSize ( ) const

Definition at line 75 of file ZLogSearch.cpp.

◆ getPhrase()

QString Zbl::ZLogSearch::getPhrase ( ) const

Definition at line 22 of file ZLogSearch.cpp.

◆ getReader()

QObject * Zbl::ZLogSearch::getReader ( ) const

Returns the foreground log file reader object for this search.

Returns
A ZLogReader object

Definition at line 17 of file ZLogSearch.cpp.

◆ getSaved()

bool Zbl::ZLogSearch::getSaved ( ) const

Definition at line 70 of file ZLogSearch.cpp.

◆ getSearchBackward()

bool Zbl::ZLogSearch::getSearchBackward ( ) const

Definition at line 100 of file ZLogSearch.cpp.

◆ getSearchForward()

bool Zbl::ZLogSearch::getSearchForward ( ) const

Definition at line 82 of file ZLogSearch.cpp.

◆ getSearchRoles()

QList< int > Zbl::ZLogSearch::getSearchRoles ( ) const

Definition at line 38 of file ZLogSearch.cpp.

◆ getSearchState()

int Zbl::ZLogSearch::getSearchState ( ) const

Definition at line 56 of file ZLogSearch.cpp.

◆ getSearchType()

int Zbl::ZLogSearch::getSearchType ( ) const

Definition at line 30 of file ZLogSearch.cpp.

◆ getZSearch()

QSharedPointer< ZblLogSearch > Zbl::ZLogSearch::getZSearch ( )

Definition at line 12 of file ZLogSearch.cpp.

Referenced by Zbl::ZLogReader::deleteSearch(), Zbl::ZLogReader::removeSearchModel(), and Zbl::ZLogViewport::setCurrentSearch().

◆ isValid()

bool Zbl::ZLogSearch::isValid ( ) const

Determine if this wrapper object points to a valid search object.

Returns
true if this object represents a valid search, false if not.

Definition at line 126 of file ZLogSearch.cpp.

Referenced by Zbl::ZLogReader::deleteSearch().

◆ notifyActive

void Zbl::ZLogSearch::notifyActive ( bool  newValue)
signal

◆ notifyCompletionFileSize

void Zbl::ZLogSearch::notifyCompletionFileSize ( qint64  newValue)
signal

◆ notifySaved

void Zbl::ZLogSearch::notifySaved ( bool  newValue)
signal

◆ notifySearchBackward

void Zbl::ZLogSearch::notifySearchBackward ( bool  newValue)
signal

Referenced by setSearchBackward().

◆ notifySearchForward

void Zbl::ZLogSearch::notifySearchForward ( bool  newValue)
signal

Referenced by setSearchForward().

◆ notifySearchState

void Zbl::ZLogSearch::notifySearchState ( int  newValue)
signal

Referenced by ZLogSearch().

◆ onInvalidate()

void Zbl::ZLogSearch::onInvalidate ( )

Handler for the ZblLogSearch::invalidate signal.

This method releases the encapsulated reference to the ZblLogSearch object that backs this object so that it can be deleted, thus invalidating this object.

Definition at line 131 of file ZLogSearch.cpp.

Referenced by Zbl::ZLogReader::getSearch().

◆ resultModel()

QObject * Zbl::ZLogSearch::resultModel ( )

Obtain a list model containing an item for each log record represented in the ZLogSearchMark's result set. This is used to display log record links.

The returned ZLogReclinkModel object remains synchronized to the ZLogSearch object that created it. Links may continue to be added to the model as the search operation progresses.

Returns
A ZLogReclinkModel object containing the search result set.
See also
ZLogReclinkModel, ZLogBookmark, ZLogMap, ZblLogMap

Definition at line 118 of file ZLogSearch.cpp.

◆ search

void Zbl::ZLogSearch::search ( )
slot

◆ setSearchBackward()

void Zbl::ZLogSearch::setSearchBackward ( bool  backward)

Definition at line 108 of file ZLogSearch.cpp.

◆ setSearchForward()

void Zbl::ZLogSearch::setSearchForward ( bool  forward)

Definition at line 90 of file ZLogSearch.cpp.

Friends And Related Function Documentation

◆ ZLogViewport

friend class ZLogViewport
friend

Definition at line 20 of file ZLogSearch.h.

Member Data Documentation

◆ m_search

QSharedPointer<ZblLogSearch> Zbl::ZLogSearch::m_search
protected

Definition at line 156 of file ZLogSearch.h.

Referenced by getActive(), getCompletionFileSize(), getPhrase(), getReader(), getSaved(), getSearchBackward(), getSearchForward(), getSearchRoles(), getSearchState(), getSearchType(), getZSearch(), isValid(), onInvalidate(), resultModel(), Zbl::ZLogViewport::setCurrentSearch(), setSearchBackward(), setSearchForward(), and ZLogSearch().

Property Documentation

◆ active

bool Zbl::ZLogSearch::active
read

Definition at line 61 of file ZLogSearch.h.

◆ CaseInsensitive

int Zbl::ZLogSearch::CaseInsensitive
read

Definition at line 73 of file ZLogSearch.h.

◆ CaseSensitive

int Zbl::ZLogSearch::CaseSensitive
read

Definition at line 72 of file ZLogSearch.h.

◆ completionFileSize

qint64 Zbl::ZLogSearch::completionFileSize
read

Definition at line 63 of file ZLogSearch.h.

◆ saved

bool Zbl::ZLogSearch::saved
read

Definition at line 62 of file ZLogSearch.h.

◆ searchBackward

bool Zbl::ZLogSearch::searchBackward
readwrite

Definition at line 68 of file ZLogSearch.h.

◆ searchForward

bool Zbl::ZLogSearch::searchForward
readwrite

Definition at line 67 of file ZLogSearch.h.

◆ searchPhrase

QString Zbl::ZLogSearch::searchPhrase
read

Definition at line 52 of file ZLogSearch.h.

◆ searchRoles

QList<int> Zbl::ZLogSearch::searchRoles
read

Definition at line 56 of file ZLogSearch.h.

◆ searchType

int Zbl::ZLogSearch::searchType
read

Definition at line 54 of file ZLogSearch.h.

◆ status

int Zbl::ZLogSearch::status
read

Definition at line 60 of file ZLogSearch.h.

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

Zuble documentation copyright © 2019 Bob Dinitto. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Zuble is a derivative work of Qt version 5. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.

Generated on Mon Nov 11 2019 03:25:03 for Zuble by   doxygen 1.8.13