QElectroTech 0.100.0-dev
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
QETArguments Class Reference

#include <qetarguments.h>

Inherits QObject.

Collaboration diagram for QETArguments:
Collaboration graph

Public Member Functions

 QETArguments (QObject *=nullptr)
 
 QETArguments (const QList< QString > &, QObject *=nullptr)
 
 QETArguments (const QETArguments &)
 
QETArgumentsoperator= (const QETArguments &)
 
 ~QETArguments () override
 
virtual void setArguments (const QList< QString > &)
 
virtual QList< QString > arguments () const
 
virtual QList< QString > files () const
 
virtual QList< QString > projectFiles () const
 
virtual QList< QString > elementFiles () const
 
virtual QList< QString > titleBlockTemplateFiles () const
 
virtual bool langDirSpecified () const
 
virtual QString langDir () const
 
virtual bool printHelpRequested () const
 
virtual bool printLicenseRequested () const
 
virtual bool printVersionRequested () const
 
virtual QList< QString > options () const
 
virtual QList< QString > unknownOptions () const
 

Private Member Functions

void clear ()
 
void parseArguments (const QList< QString > &)
 
void handleFileArgument (const QString &)
 
void handleOptionArgument (const QString &)
 

Private Attributes

QList< QString > project_files_
 
QList< QString > element_files_
 
QList< QString > tbt_files_
 
QList< QString > options_
 
QList< QString > unknown_options_
 
QString lang_dir_
 
bool print_help_
 
bool print_license_
 
bool print_version_
 

Detailed Description

This class represents a set of arguments the application has received as parameters. Initialized from a list of strings, an instance of this class provides access to the differents options and files given on the command line.

Constructor & Destructor Documentation

◆ QETArguments() [1/3]

QETArguments::QETArguments ( QObject *  parent = nullptr)

Constructeur par defaut Cree un objet sans argument.

◆ QETArguments() [2/3]

QETArguments::QETArguments ( const QList< QString > &  args,
QObject *  parent = nullptr 
)

Constructeur

Parameters
argsArguments a analyser et memoriser
parentQObject parent
Here is the call graph for this function:

◆ QETArguments() [3/3]

QETArguments::QETArguments ( const QETArguments qet_arguments)

Constructeur de copie - la copie reprend le parent de l'original

Parameters
qet_argumentsObjet a copier

◆ ~QETArguments()

QETArguments::~QETArguments ( )
override

Destructeur

Member Function Documentation

◆ arguments()

QList< QString > QETArguments::arguments ( ) const
virtual
Returns
tous les arguments (projets et elements) passes en parametres dans l'ordre suivant : options connues puis inconnues, fichiers de types projet puis element.
Here is the caller graph for this function:

◆ clear()

void QETArguments::clear ( )
private

Oublie tous les arguments de cet objet

Here is the caller graph for this function:

◆ elementFiles()

QList< QString > QETArguments::elementFiles ( ) const
virtual
Returns
les fichiers de type element
Here is the caller graph for this function:

◆ files()

QList< QString > QETArguments::files ( ) const
virtual
Returns
tous les fichiers (projets et elements) passes en parametres. Les fichiers de type projet viennent avant les fichiers de type element.
Here is the caller graph for this function:

◆ handleFileArgument()

void QETArguments::handleFileArgument ( const QString &  file)
private

Gere les arguments correspondant a un fichier existant.

Here is the caller graph for this function:

◆ handleOptionArgument()

void QETArguments::handleOptionArgument ( const QString &  option)
private

Gere les arguments correspondant potentiellement a une option. Les options reconnues sont : –common-elements-dir= –common-tbt-dir –config-dir= –lang-dir= –help –version -v –license

Here is the caller graph for this function:

◆ langDir()

QString QETArguments::langDir ( ) const
virtual
Returns
le dossier de langue specifie par l'utilisateur. Si l'utilisateur n'en a pas specifie, une chaine vide est retournee.
Here is the caller graph for this function:

◆ langDirSpecified()

bool QETArguments::langDirSpecified ( ) const
virtual
Returns
true si l'utilisateur a specifie un dossier pour les fichiers de langue
Here is the caller graph for this function:

◆ operator=()

QETArguments & QETArguments::operator= ( const QETArguments qet_arguments)

Operateur d'affectation - la copie ne reprend pas le parent de l'original

Parameters
qet_argumentsObjet a copier

◆ options()

QList< QString > QETArguments::options ( ) const
virtual
Returns
les options reconnues

◆ parseArguments()

void QETArguments::parseArguments ( const QList< QString > &  arguments)
private

Analyse des arguments et les retient dans cet objet. Si cet objet contenait deja des arguments, ceux-ci sont oublies.

Parameters
argumentsArguments a analyser
Here is the call graph for this function:
Here is the caller graph for this function:

◆ printHelpRequested()

bool QETArguments::printHelpRequested ( ) const
virtual
Returns
true si les arguments comportent une demande d'affichage de l'aide, false sinon
Here is the caller graph for this function:

◆ printLicenseRequested()

bool QETArguments::printLicenseRequested ( ) const
virtual
Returns
true si les arguments comportent une demande d'affichage de la licence, false sinon
Here is the caller graph for this function:

◆ printVersionRequested()

bool QETArguments::printVersionRequested ( ) const
virtual
Returns
true si les arguments comportent une demande d'affichage de la version, false sinon
Here is the caller graph for this function:

◆ projectFiles()

QList< QString > QETArguments::projectFiles ( ) const
virtual
Returns
les fichiers de type projet
Here is the caller graph for this function:

◆ setArguments()

void QETArguments::setArguments ( const QList< QString > &  args)
virtual

Definit les arguments de cet objet. Si cet objet contenait deja des arguments, ceux-ci sont oublies.

Parameters
argsArguments a analyser et memoriser
Here is the call graph for this function:

◆ titleBlockTemplateFiles()

QList< QString > QETArguments::titleBlockTemplateFiles ( ) const
virtual
Returns
title block template files
Here is the caller graph for this function:

◆ unknownOptions()

QList< QString > QETArguments::unknownOptions ( ) const
virtual
Returns
les options non reconnues

Member Data Documentation

◆ element_files_

QList<QString> QETArguments::element_files_
private

◆ lang_dir_

QString QETArguments::lang_dir_
private

◆ options_

QList<QString> QETArguments::options_
private

◆ print_help_

bool QETArguments::print_help_
private

◆ print_license_

bool QETArguments::print_license_
private

◆ print_version_

bool QETArguments::print_version_
private

◆ project_files_

QList<QString> QETArguments::project_files_
private

◆ tbt_files_

QList<QString> QETArguments::tbt_files_
private

◆ unknown_options_

QList<QString> QETArguments::unknown_options_
private

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