Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
CmdLineParser Class Reference

#include <cmdlineparser.h>

+ Collaboration diagram for CmdLineParser:

Public Types

enum  Result { Ok , Help , Error }
 
enum  ShowState { Untouched , Show , Hide , Activate }
 
enum  RegisterState { None , Register , Unregister }
 

Public Member Functions

 CmdLineParser (const QStringList &arguments)
 
Result parse ()
 
void setCollectionFile (const QString &file)
 
QString collectionFile () const
 
bool collectionFileGiven () const
 
QString cloneFile () const
 
QUrl url () const
 
bool enableRemoteControl () const
 
ShowState contents () const
 
ShowState index () const
 
ShowState bookmarks () const
 
ShowState search () const
 
QString currentFilter () const
 
bool removeSearchIndex () const
 
bool rebuildSearchIndex () const
 
RegisterState registerRequest () const
 
QString helpFile () const
 
void showMessage (const QString &msg, bool error)
 

Detailed Description

Definition at line 13 of file cmdlineparser.h.

Member Enumeration Documentation

◆ RegisterState

Enumerator
None 
Register 
Unregister 

Definition at line 19 of file cmdlineparser.h.

◆ Result

Enumerator
Ok 
Help 
Error 

Definition at line 17 of file cmdlineparser.h.

◆ ShowState

Enumerator
Untouched 
Show 
Hide 
Activate 

Definition at line 18 of file cmdlineparser.h.

Constructor & Destructor Documentation

◆ CmdLineParser()

CmdLineParser::CmdLineParser ( const QStringList & arguments)

Definition at line 49 of file cmdlineparser.cpp.

References None, and Untouched.

Member Function Documentation

◆ bookmarks()

CmdLineParser::ShowState CmdLineParser::bookmarks ( ) const

Definition at line 298 of file cmdlineparser.cpp.

Referenced by MainWindow::MainWindow().

+ Here is the caller graph for this function:

◆ cloneFile()

QString CmdLineParser::cloneFile ( ) const

◆ collectionFile()

QString CmdLineParser::collectionFile ( ) const

Definition at line 262 of file cmdlineparser.cpp.

◆ collectionFileGiven()

bool CmdLineParser::collectionFileGiven ( ) const

Definition at line 268 of file cmdlineparser.cpp.

Referenced by MainWindow::MainWindow().

+ Here is the caller graph for this function:

◆ contents()

CmdLineParser::ShowState CmdLineParser::contents ( ) const

Definition at line 286 of file cmdlineparser.cpp.

Referenced by MainWindow::MainWindow().

+ Here is the caller graph for this function:

◆ currentFilter()

QString CmdLineParser::currentFilter ( ) const

Definition at line 310 of file cmdlineparser.cpp.

◆ enableRemoteControl()

bool CmdLineParser::enableRemoteControl ( ) const

Definition at line 280 of file cmdlineparser.cpp.

◆ helpFile()

QString CmdLineParser::helpFile ( ) const

Definition at line 328 of file cmdlineparser.cpp.

◆ index()

CmdLineParser::ShowState CmdLineParser::index ( ) const

Definition at line 292 of file cmdlineparser.cpp.

Referenced by MainWindow::MainWindow().

+ Here is the caller graph for this function:

◆ parse()

CmdLineParser::Result CmdLineParser::parse ( )

Definition at line 70 of file cmdlineparser.cpp.

◆ rebuildSearchIndex()

bool CmdLineParser::rebuildSearchIndex ( ) const

◆ registerRequest()

CmdLineParser::RegisterState CmdLineParser::registerRequest ( ) const

Definition at line 322 of file cmdlineparser.cpp.

Referenced by preliminarySetup().

+ Here is the caller graph for this function:

◆ removeSearchIndex()

bool CmdLineParser::removeSearchIndex ( ) const

Definition at line 316 of file cmdlineparser.cpp.

Referenced by preliminarySetup().

+ Here is the caller graph for this function:

◆ search()

CmdLineParser::ShowState CmdLineParser::search ( ) const

Definition at line 304 of file cmdlineparser.cpp.

Referenced by MainWindow::MainWindow().

+ Here is the caller graph for this function:

◆ setCollectionFile()

void CmdLineParser::setCollectionFile ( const QString & file)

Definition at line 256 of file cmdlineparser.cpp.

◆ showMessage()

void CmdLineParser::showMessage ( const QString & msg,
bool error )

Definition at line 240 of file cmdlineparser.cpp.

◆ url()

QUrl CmdLineParser::url ( ) const

Definition at line 274 of file cmdlineparser.cpp.


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