Definition for a single command line option. More...

#include <libmythbase/mythcommandlineparser.h>

Inheritance diagram for CommandLineArg:

Collaboration diagram for CommandLineArg:

Public Member Functions
	CommandLineArg (const QString &name, QMetaType::Type type, QVariant def, QString help, QString longhelp)
	Default constructor for CommandLineArg class. More...

	CommandLineArg (const QString &name, QMetaType::Type type, QVariant def)
	Reduced constructor for CommandLineArg class. More...

	CommandLineArg (const QString &name)
	Dummy constructor for CommandLineArg class. More...

	~CommandLineArg () override=default

CommandLineArg *	SetGroup (const QString &group)

void	AddKeyword (const QString &keyword)

QString	GetName (void) const

QString	GetUsedKeyword (void) const

int	GetKeywordLength (void) const
	Return length of full keyword string for use in determining indent of help text. More...

QString	GetHelpString (int off, const QString &group="", bool force=false) const
	Return string containing help text with desired offset. More...

QString	GetLongHelpString (QString keyword) const
	Return string containing extended help text. More...

bool	Set (const QString &opt)
	Set option as provided on command line with no value. More...

bool	Set (const QString &opt, const QByteArray &val)
	Set option as provided on command line with value. More...

void	Set (const QVariant &val)

CommandLineArg *	SetParent (const QString &opt)
	Set argument as child of given parent. More...

CommandLineArg *	SetParent (const QStringList &opts)
	Set argument as child of multiple parents. More...

CommandLineArg *	SetParentOf (const QString &opt)
	Set argument as parent of given child. More...

CommandLineArg *	SetParentOf (const QStringList &opts)
	Set argument as parent of multiple children. More...

CommandLineArg *	SetChild (const QString &opt)
	Set argument as parent of given child. More...

CommandLineArg *	SetChild (const QStringList &opt)
	Set argument as parent of multiple children. More...

CommandLineArg *	SetChildOf (const QString &opt)
	Set argument as child of given parent. More...

CommandLineArg *	SetChildOf (const QStringList &opts)
	Set argument as child of multiple parents. More...

CommandLineArg *	SetRequiredChild (const QString &opt)
	Set argument as parent of given child and mark as required. More...

CommandLineArg *	SetRequiredChild (const QStringList &opt)
	Set argument as parent of multiple children and mark as required. More...

CommandLineArg *	SetRequiredChildOf (const QString &opt)
	Set argument as child required by given parent. More...

CommandLineArg *	SetRequiredChildOf (const QStringList &opt)
	Set argument as child required by multiple parents. More...

CommandLineArg *	SetRequires (const QString &opt)
	Set argument as requiring given option. More...

CommandLineArg *	SetRequires (const QStringList &opts)
	Set argument as requiring multiple options. More...

CommandLineArg *	SetBlocks (const QString &opt)
	Set argument as incompatible with given option. More...

CommandLineArg *	SetBlocks (const QStringList &opts)
	Set argument as incompatible with multiple options. More...

CommandLineArg *	SetDeprecated (QString depstr="")
	Set option as deprecated. More...

CommandLineArg *	SetRemoved (QString remstr="", QString remver="")
	Set option as removed. More...

void	PrintVerbose (void) const
	Internal use. More...

Public Member Functions inherited from ReferenceCounter
	ReferenceCounter (const QString &debugName, bool logDebug=true)
	Creates reference counter with an initial value of 1. More...

virtual int	IncrRef (void)
	Increments reference count. More...

virtual int	DecrRef (void)
	Decrements reference count and deletes on 0. More...

Static Public Member Functions
static void	AllowOneOf (const QList< CommandLineArg * > &args)
	Mark a list of arguments as mutually exclusive. More...

Static Public Member Functions inherited from ReferenceCounter
static void	PrintDebug (void)
	Print out any leaks if that level of debugging is enabled. More...

Private Member Functions
QString	GetKeywordString (void) const
	Return string containing all possible keyword triggers for this argument. More...

void	SetParentOf (CommandLineArg *other, bool forward=true)
	Internal use, set argument as parent of given child. More...

void	SetChildOf (CommandLineArg *other, bool forward=true)
	Internal use, set argument as child of given parent. More...

void	SetRequires (CommandLineArg *other, bool forward=true)
	Internal use, set argument as requiring given option. More...

void	SetBlocks (CommandLineArg *other, bool forward=true)
	Internal use, set argument as incompatible with given option. More...

void	Convert (void)
	Convert stored string value from QByteArray to QString. More...

QString	GetPreferredKeyword (void) const
	Return the longest keyword for the argument. More...

bool	TestLinks (void) const
	Test all related arguments to make sure specified requirements are fulfilled. More...

void	CleanupLinks (void)
	Clear out references to other arguments in preparation for deletion. More...

void	PrintRemovedWarning (QString &keyword) const
	Internal use. More...

void	PrintDeprecatedWarning (QString &keyword) const
	Internal use. More...

Private Attributes
bool	m_given {false}

bool	m_converted {false}

QString	m_name

QString	m_group

QString	m_deprecated

QString	m_removed

QString	m_removedversion

QMetaType::Type	m_type {QMetaType::UnknownType}

QVariant	m_default

QVariant	m_stored

QStringList	m_keywords

QString	m_usedKeyword

QList< CommandLineArg * >	m_parents

QList< CommandLineArg * >	m_children

QList< CommandLineArg * >	m_requires

QList< CommandLineArg * >	m_requiredby

QList< CommandLineArg * >	m_blocks

QString	m_help

QString	m_longhelp

Friends
class	MythCommandLineParser

Additional Inherited Members
Protected Member Functions inherited from ReferenceCounter
virtual	~ReferenceCounter (void)
	Called on destruction, will warn if object deleted with references in place. More...

Protected Attributes inherited from ReferenceCounter
bool	m_logDebug
	This is used to suppress creating LoggingItem classes for LoggingItem reference count changes. More...

QAtomicInt	m_referenceCount {1}

Detailed Description

Definition for a single command line option.

This class contains instructions for the command line parser about what options to process from the command line. Each instance can correspond to multiple argument keywords, and stores a default value, whether it has been supplied, help text, and optional interdependencies with other CommandLineArgs.

Definition at line 21 of file mythcommandlineparser.h.

Constructor & Destructor Documentation

◆ CommandLineArg() [1/3]

CommandLineArg::CommandLineArg	(	const QString &	name,
		QMetaType::Type	type,
		QVariant	def,
		QString	help,
		QString	longhelp
	)

Default constructor for CommandLineArg class.

This constructor is for use with command line parser, defining an option that can be used on the command line, and should be reported in –help printouts

Definition at line 284 of file mythcommandlineparser.cpp.

Referenced by SetBlocks(), SetChild(), SetChildOf(), SetParent(), SetParentOf(), SetRequiredChild(), SetRequiredChildOf(), and SetRequires().

◆ CommandLineArg() [2/3]

CommandLineArg::CommandLineArg	(	const QString &	name,
		QMetaType::Type	type,
		QVariant	def
	)

Reduced constructor for CommandLineArg class.

This constructor is for internal use within the command line parser. It is intended for use in supplementary data storage for information not supplied directly on the command line.

Definition at line 301 of file mythcommandlineparser.cpp.

◆ CommandLineArg() [3/3]

CommandLineArg::CommandLineArg ( const QString & name )

explicit

Dummy constructor for CommandLineArg class.

This constructor is for internal use within the command line parser. It is used as a placeholder for defining relations between different command line arguments, and is reconciled with the proper argument of the same name prior to parsing inputs.

Definition at line 317 of file mythcommandlineparser.cpp.

◆ ~CommandLineArg()

CommandLineArg::~CommandLineArg ( )

overridedefault

Member Function Documentation

◆ SetGroup()

CommandLineArg* CommandLineArg::SetGroup ( const QString & group )

inline

Definition at line 30 of file mythcommandlineparser.h.

Referenced by MythCommandLineParser::addLogging(), MythCommandLineParser::addMouse(), MythCommandLineParser::addWindowed(), MythFrontendCommandLineParser::LoadArguments(), MythFillDatabaseCommandLineParser::LoadArguments(), MythTranscodeCommandLineParser::LoadArguments(), MythExternRecorderCommandLineParser::LoadArguments(), MythCommFlagCommandLineParser::LoadArguments(), MythFileRecorderCommandLineParser::LoadArguments(), and MythUtilCommandLineParser::LoadArguments().

◆ AddKeyword()

void CommandLineArg::AddKeyword ( const QString & keyword )

inline

Definition at line 32 of file mythcommandlineparser.h.

Referenced by MythCommandLineParser::add().

◆ GetName()

QString CommandLineArg::GetName ( void ) const

inline

Definition at line 34 of file mythcommandlineparser.h.

Referenced by MythCommandLineParser::Parse().

◆ GetUsedKeyword()

QString CommandLineArg::GetUsedKeyword ( void ) const

inline

Definition at line 35 of file mythcommandlineparser.h.

◆ GetKeywordLength()

int CommandLineArg::GetKeywordLength ( void ) const

Return length of full keyword string for use in determining indent of help text.

Definition at line 336 of file mythcommandlineparser.cpp.

◆ GetHelpString()

QString CommandLineArg::GetHelpString	(	int	off,
		const QString &	group = `""`,
		bool	force = `false`
	)		const

Return string containing help text with desired offset.

This function returns a string containing all usable keywords and the shortened help text, for use with the general help printout showing all options. It automatically accounts for terminal width, and wraps the text accordingly.

The group option acts as a filter, only returning text if the argument is part of the group the parser is currently printing options for.

Child arguments will not produce help text on their own, but only indented beneath each of the marked parent arguments. The force option specifies that the function is being called by the parent argument, and help should be output.

Definition at line 362 of file mythcommandlineparser.cpp.

◆ GetLongHelpString()

QString CommandLineArg::GetLongHelpString ( QString keyword ) const

Return string containing extended help text.

This function returns a longer version of the help text than that provided with the list of arguments, intended for more detailed, specific information. This also documents the type of argument it takes, default value, and any relational dependencies with other arguments it might have.

Definition at line 437 of file mythcommandlineparser.cpp.

◆ Set() [1/3]

bool CommandLineArg::Set ( const QString & opt )

Set option as provided on command line with no value.

This specifies that an option is given, but there is no corresponding value, meaning this can only be used on a boolean, integer, and string arguments. All other will return false.

Definition at line 545 of file mythcommandlineparser.cpp.

Referenced by MythCommandLineParser::Parse(), and MythCommandLineParser::SetValue().

◆ Set() [2/3]

bool CommandLineArg::Set	(	const QString &	opt,
		const QByteArray &	val
	)

Set option as provided on command line with value.

Definition at line 578 of file mythcommandlineparser.cpp.

◆ Set() [3/3]

void CommandLineArg::Set ( const QVariant & val )

inline

Definition at line 43 of file mythcommandlineparser.h.

◆ SetParent() [1/2]

CommandLineArg * CommandLineArg::SetParent ( const QString & opt )

Set argument as child of given parent.

Definition at line 678 of file mythcommandlineparser.cpp.

◆ SetParent() [2/2]

CommandLineArg * CommandLineArg::SetParent ( const QStringList & opts )

Set argument as child of multiple parents.

Definition at line 686 of file mythcommandlineparser.cpp.

◆ SetParentOf() [1/3]

CommandLineArg * CommandLineArg::SetParentOf ( const QString & opt )

Set argument as parent of given child.

Definition at line 661 of file mythcommandlineparser.cpp.

Referenced by MythTVSetupCommandLineParser::LoadArguments(), and SetChildOf().

◆ SetParentOf() [2/3]

CommandLineArg * CommandLineArg::SetParentOf ( const QStringList & opts )

Set argument as parent of multiple children.

Definition at line 669 of file mythcommandlineparser.cpp.

◆ SetChild() [1/2]

CommandLineArg * CommandLineArg::SetChild ( const QString & opt )

Set argument as parent of given child.

Definition at line 712 of file mythcommandlineparser.cpp.

◆ SetChild() [2/2]

CommandLineArg * CommandLineArg::SetChild ( const QStringList & opt )

Set argument as parent of multiple children.

Definition at line 720 of file mythcommandlineparser.cpp.

◆ SetChildOf() [1/3]

CommandLineArg * CommandLineArg::SetChildOf ( const QString & opt )

Set argument as child of given parent.

Definition at line 695 of file mythcommandlineparser.cpp.

Referenced by MythMetadataLookupCommandLineParser::LoadArguments(), MythTranscodeCommandLineParser::LoadArguments(), MythAVTestCommandLineParser::LoadArguments(), MythUtilCommandLineParser::LoadArguments(), and SetParentOf().

◆ SetChildOf() [2/3]

CommandLineArg * CommandLineArg::SetChildOf ( const QStringList & opts )

Set argument as child of multiple parents.

Definition at line 703 of file mythcommandlineparser.cpp.

◆ SetRequiredChild() [1/2]

CommandLineArg * CommandLineArg::SetRequiredChild ( const QString & opt )

Set argument as parent of given child and mark as required.

Definition at line 729 of file mythcommandlineparser.cpp.

Referenced by MythAVTestCommandLineParser::LoadArguments().

◆ SetRequiredChild() [2/2]

CommandLineArg * CommandLineArg::SetRequiredChild ( const QStringList & opt )

Set argument as parent of multiple children and mark as required.

Definition at line 738 of file mythcommandlineparser.cpp.

◆ SetRequiredChildOf() [1/2]

CommandLineArg * CommandLineArg::SetRequiredChildOf ( const QString & opt )

Set argument as child required by given parent.

Definition at line 750 of file mythcommandlineparser.cpp.

Referenced by MythFillDatabaseCommandLineParser::LoadArguments(), and MythUtilCommandLineParser::LoadArguments().

◆ SetRequiredChildOf() [2/2]

CommandLineArg * CommandLineArg::SetRequiredChildOf ( const QStringList & opt )

Set argument as child required by multiple parents.

Definition at line 759 of file mythcommandlineparser.cpp.

◆ SetRequires() [1/3]

CommandLineArg * CommandLineArg::SetRequires ( const QString & opt )

Set argument as requiring given option.

Definition at line 771 of file mythcommandlineparser.cpp.

Referenced by MythCommandLineParser::addRecording(), MythTranscodeCommandLineParser::LoadArguments(), and MythFillDatabaseCommandLineParser::LoadArguments().

◆ SetRequires() [2/3]

CommandLineArg * CommandLineArg::SetRequires ( const QStringList & opts )

Set argument as requiring multiple options.

Definition at line 779 of file mythcommandlineparser.cpp.

◆ SetBlocks() [1/3]

CommandLineArg * CommandLineArg::SetBlocks ( const QString & opt )

Set argument as incompatible with given option.

Definition at line 788 of file mythcommandlineparser.cpp.

Referenced by MythCommandLineParser::addLogging(), MythCommandLineParser::addMouse(), MythMetadataLookupCommandLineParser::LoadArguments(), MythFrontendCommandLineParser::LoadArguments(), MythFillDatabaseCommandLineParser::LoadArguments(), MythTVSetupCommandLineParser::LoadArguments(), and SetBlocks().

◆ SetBlocks() [2/3]

CommandLineArg * CommandLineArg::SetBlocks ( const QStringList & opts )

Set argument as incompatible with multiple options.

Definition at line 796 of file mythcommandlineparser.cpp.

◆ SetDeprecated()

CommandLineArg * CommandLineArg::SetDeprecated ( QString depstr = "" )

Set option as deprecated.

Definition at line 805 of file mythcommandlineparser.cpp.

◆ SetRemoved()

CommandLineArg * CommandLineArg::SetRemoved	(	QString	remstr = `""`,
		QString	remver = `""`
	)

Set option as removed.

Definition at line 815 of file mythcommandlineparser.cpp.

Referenced by MythCommandLineParser::addLogging(), MythShutdownCommandLineParser::LoadArguments(), MythLCDServerCommandLineParser::LoadArguments(), and MythFillDatabaseCommandLineParser::LoadArguments().

◆ AllowOneOf()

void CommandLineArg::AllowOneOf ( const QList< CommandLineArg * > & args )

static

Mark a list of arguments as mutually exclusive.

Definition at line 939 of file mythcommandlineparser.cpp.

Referenced by MythMetadataLookupCommandLineParser::LoadArguments(), MythShutdownCommandLineParser::LoadArguments(), MythCommFlagCommandLineParser::LoadArguments(), MythBackendCommandLineParser::LoadArguments(), and MythUtilCommandLineParser::LoadArguments().

◆ PrintVerbose()

void CommandLineArg::PrintVerbose ( void ) const

Internal use.

Print processed input in verbose mode.

Definition at line 1146 of file mythcommandlineparser.cpp.

◆ GetKeywordString()

QString CommandLineArg::GetKeywordString ( void ) const

private

Return string containing all possible keyword triggers for this argument.

Definition at line 326 of file mythcommandlineparser.cpp.

Referenced by GetHelpString(), and GetKeywordLength().

◆ SetParentOf() [3/3]

void CommandLineArg::SetParentOf	(	CommandLineArg *	other,
		bool	forward = `true`
	)

private

Internal use, set argument as parent of given child.

This option is intended for internal use only, as part of reconciling dummy options with their matched real counterparts.

Definition at line 829 of file mythcommandlineparser.cpp.

◆ SetChildOf() [3/3]

void CommandLineArg::SetChildOf	(	CommandLineArg *	other,
		bool	forward = `true`
	)

private

Internal use, set argument as child of given parent.

This option is intended for internal use only, as part of reconciling dummy options with their matched real counterparts.

Definition at line 857 of file mythcommandlineparser.cpp.

◆ SetRequires() [3/3]

void CommandLineArg::SetRequires	(	CommandLineArg *	other,
		bool	forward = `true`
	)

private

Internal use, set argument as requiring given option.

This option is intended for internal use only, as part of reconciling dummy options with their matched real counterparts.

Definition at line 885 of file mythcommandlineparser.cpp.

◆ SetBlocks() [3/3]

void CommandLineArg::SetBlocks	(	CommandLineArg *	other,
		bool	forward = `true`
	)

private

Internal use, set argument as incompatible with given option.

This option is intended for internal use only, as part of reconciling dummy options with their matched real counterparts.

Definition at line 914 of file mythcommandlineparser.cpp.

◆ Convert()

void CommandLineArg::Convert ( void )

private

Convert stored string value from QByteArray to QString.

This is a work around to delay string processing until after QApplication has been initialized, to allow the locale to be configured and unicode handling to work properly

Definition at line 967 of file mythcommandlineparser.cpp.

Referenced by MythCommandLineParser::toMap(), MythCommandLineParser::toString(), and MythCommandLineParser::toStringList().

◆ GetPreferredKeyword()

QString CommandLineArg::GetPreferredKeyword ( void ) const

private

Return the longest keyword for the argument.

This is used to determine which keyword to use when listing relations to other options. The longest keyword is presumed to be the most descriptive.

Definition at line 1031 of file mythcommandlineparser.cpp.

◆ TestLinks()

bool CommandLineArg::TestLinks ( void ) const

private

Test all related arguments to make sure specified requirements are fulfilled.

Definition at line 1053 of file mythcommandlineparser.cpp.

◆ CleanupLinks()

void CommandLineArg::CleanupLinks ( void )

private

Clear out references to other arguments in preparation for deletion.

Definition at line 1125 of file mythcommandlineparser.cpp.

◆ PrintRemovedWarning()

void CommandLineArg::PrintRemovedWarning ( QString & keyword ) const

private

Internal use.

Print warning for removed option.

Definition at line 1236 of file mythcommandlineparser.cpp.

Referenced by GetLongHelpString(), and MythCommandLineParser::Parse().

◆ PrintDeprecatedWarning()

void CommandLineArg::PrintDeprecatedWarning ( QString & keyword ) const

private

Internal use.

Print warning for deprecated option.

Definition at line 1252 of file mythcommandlineparser.cpp.

Referenced by GetLongHelpString(), and MythCommandLineParser::Parse().

Friends And Related Function Documentation

◆ MythCommandLineParser

friend class MythCommandLineParser

friend

Definition at line 73 of file mythcommandlineparser.h.

Member Data Documentation

◆ m_given

bool CommandLineArg::m_given {false}

private

Definition at line 92 of file mythcommandlineparser.h.

Referenced by Convert(), MythCommandLineParser::operator[](), PrintVerbose(), Set(), TestLinks(), MythCommandLineParser::toBool(), MythCommandLineParser::toDateTime(), MythCommandLineParser::toDouble(), MythCommandLineParser::toInt(), MythCommandLineParser::toLongLong(), MythCommandLineParser::toMap(), MythCommandLineParser::toSize(), MythCommandLineParser::toString(), MythCommandLineParser::toStringList(), and MythCommandLineParser::toUInt().

◆ m_converted

bool CommandLineArg::m_converted {false}

private

Definition at line 93 of file mythcommandlineparser.h.

Referenced by CommandLineArg(), Convert(), MythCommandLineParser::toMap(), MythCommandLineParser::toString(), and MythCommandLineParser::toStringList().

◆ m_name

QString CommandLineArg::m_name

private

Definition at line 94 of file mythcommandlineparser.h.

Referenced by PrintVerbose(), SetBlocks(), SetChildOf(), SetParentOf(), and SetRequires().

◆ m_group

QString CommandLineArg::m_group

private

Definition at line 95 of file mythcommandlineparser.h.

Referenced by GetHelpString().

◆ m_deprecated

QString CommandLineArg::m_deprecated

private

Definition at line 96 of file mythcommandlineparser.h.

Referenced by GetHelpString(), GetLongHelpString(), MythCommandLineParser::Parse(), PrintDeprecatedWarning(), and SetDeprecated().

◆ m_removed

QString CommandLineArg::m_removed

private

Definition at line 97 of file mythcommandlineparser.h.

Referenced by GetHelpString(), GetLongHelpString(), MythCommandLineParser::Parse(), PrintRemovedWarning(), and SetRemoved().

◆ m_removedversion

QString CommandLineArg::m_removedversion

private

Definition at line 98 of file mythcommandlineparser.h.

Referenced by PrintRemovedWarning(), and SetRemoved().

◆ m_type

QMetaType::Type CommandLineArg::m_type {QMetaType::UnknownType}

private

Definition at line 99 of file mythcommandlineparser.h.

Referenced by CommandLineArg(), Convert(), GetLongHelpString(), PrintVerbose(), Set(), MythCommandLineParser::SetValue(), MythCommandLineParser::toBool(), and MythCommandLineParser::toStringList().

◆ m_default

QVariant CommandLineArg::m_default

private

Definition at line 100 of file mythcommandlineparser.h.

Referenced by GetLongHelpString(), MythCommandLineParser::operator[](), Set(), MythCommandLineParser::toBool(), MythCommandLineParser::toDateTime(), MythCommandLineParser::toDouble(), MythCommandLineParser::toInt(), MythCommandLineParser::toLongLong(), MythCommandLineParser::toMap(), MythCommandLineParser::toSize(), MythCommandLineParser::toString(), MythCommandLineParser::toStringList(), and MythCommandLineParser::toUInt().

◆ m_stored

QVariant CommandLineArg::m_stored

private

Definition at line 101 of file mythcommandlineparser.h.

Referenced by Convert(), MythCommandLineParser::operator[](), MythCommandLineParser::Parse(), PrintVerbose(), Set(), MythCommandLineParser::toBool(), MythCommandLineParser::toDateTime(), MythCommandLineParser::toDouble(), MythCommandLineParser::toInt(), MythCommandLineParser::toLongLong(), MythCommandLineParser::toMap(), MythCommandLineParser::toSize(), MythCommandLineParser::toString(), MythCommandLineParser::toStringList(), and MythCommandLineParser::toUInt().

◆ m_keywords

QStringList CommandLineArg::m_keywords

private

Definition at line 103 of file mythcommandlineparser.h.

Referenced by GetKeywordString(), GetLongHelpString(), and GetPreferredKeyword().

◆ m_usedKeyword

QString CommandLineArg::m_usedKeyword

private

Definition at line 104 of file mythcommandlineparser.h.

Referenced by Set(), and TestLinks().

◆ m_parents

QList<CommandLineArg*> CommandLineArg::m_parents

private

Definition at line 106 of file mythcommandlineparser.h.

Referenced by CleanupLinks(), GetHelpString(), GetKeywordLength(), GetLongHelpString(), SetChildOf(), SetParent(), SetRequiredChildOf(), and TestLinks().

◆ m_children

QList<CommandLineArg*> CommandLineArg::m_children

private

Definition at line 107 of file mythcommandlineparser.h.

Referenced by CleanupLinks(), GetHelpString(), GetLongHelpString(), SetChild(), SetParentOf(), and SetRequiredChild().

◆ m_requires

QList<CommandLineArg*> CommandLineArg::m_requires

private

Definition at line 108 of file mythcommandlineparser.h.

Referenced by CleanupLinks(), GetLongHelpString(), SetRequiredChild(), SetRequires(), and TestLinks().

◆ m_requiredby

QList<CommandLineArg*> CommandLineArg::m_requiredby

private

Definition at line 109 of file mythcommandlineparser.h.

Referenced by CleanupLinks(), and SetRequiredChildOf().

◆ m_blocks

QList<CommandLineArg*> CommandLineArg::m_blocks

private

Definition at line 110 of file mythcommandlineparser.h.

Referenced by CleanupLinks(), GetLongHelpString(), SetBlocks(), and TestLinks().

◆ m_help

QString CommandLineArg::m_help

private

Definition at line 112 of file mythcommandlineparser.h.

Referenced by GetHelpString(), and GetLongHelpString().

◆ m_longhelp

QString CommandLineArg::m_longhelp

private

Definition at line 113 of file mythcommandlineparser.h.

Referenced by GetLongHelpString().

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

mythtv/libs/libmythbase/mythcommandlineparser.h
mythtv/libs/libmythbase/mythcommandlineparser.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CommandLineArg() [1/3]

◆ CommandLineArg() [2/3]

◆ CommandLineArg() [3/3]

◆ ~CommandLineArg()

Member Function Documentation

◆ SetGroup()

◆ AddKeyword()

◆ GetName()

◆ GetUsedKeyword()

◆ GetKeywordLength()

◆ GetHelpString()

◆ GetLongHelpString()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetParent() [1/2]

◆ SetParent() [2/2]

◆ SetParentOf() [1/3]

◆ SetParentOf() [2/3]

◆ SetChild() [1/2]

◆ SetChild() [2/2]

◆ SetChildOf() [1/3]

◆ SetChildOf() [2/3]

◆ SetRequiredChild() [1/2]

◆ SetRequiredChild() [2/2]

◆ SetRequiredChildOf() [1/2]

◆ SetRequiredChildOf() [2/2]

◆ SetRequires() [1/3]

◆ SetRequires() [2/3]

◆ SetBlocks() [1/3]

◆ SetBlocks() [2/3]

◆ SetDeprecated()

◆ SetRemoved()

◆ AllowOneOf()

◆ PrintVerbose()

◆ GetKeywordString()

◆ SetParentOf() [3/3]

◆ SetChildOf() [3/3]

◆ SetRequires() [3/3]

◆ SetBlocks() [3/3]

◆ Convert()

◆ GetPreferredKeyword()

◆ TestLinks()

◆ CleanupLinks()

◆ PrintRemovedWarning()

◆ PrintDeprecatedWarning()

Friends And Related Function Documentation

◆ MythCommandLineParser

Member Data Documentation

◆ m_given

◆ m_converted

◆ m_name

◆ m_group

◆ m_deprecated

◆ m_removed

◆ m_removedversion

◆ m_type

◆ m_default

◆ m_stored

◆ m_keywords

◆ m_usedKeyword

◆ m_parents

◆ m_children

◆ m_requires

◆ m_requiredby

◆ m_blocks

◆ m_help

◆ m_longhelp