digiKam
option_base Class Referenceabstract
+ Inheritance diagram for option_base:

Public Member Functions

void add_namespace_prefix (std::string prefix)
 
virtual std::string get_default_string () const
 
std::string get_description () const
 
std::string get_name () const
 
std::string getLongOption () const
 
char getShortOption () const
 
virtual std::string getTypeDescr () const =0
 
virtual bool has_default () const =0
 
bool has_description () const
 
bool hasLongOption () const
 
bool hasShortOption () const
 
virtual bool is_defined () const =0
 
bool is_undefined () const
 
 option_base ()
 
 option_base (const char *name)
 
virtual LIBDE265_API bool processCmdLineArguments (char **argv, int *argc, int idx)
 
void set_cmd_line_options (const char *long_option, char short_option=0)
 
void set_description (std::string descr)
 
void set_ID (const char *name)
 
void set_short_option (char short_option)
 
void unsetCmdLineOption ()
 
virtual ~option_base ()
 

Constructor & Destructor Documentation

◆ option_base() [1/2]

option_base::option_base ( )
inline

◆ option_base() [2/2]

option_base::option_base ( const char *  name)
inline

◆ ~option_base()

virtual option_base::~option_base ( )
inlinevirtual

Member Function Documentation

◆ add_namespace_prefix()

void option_base::add_namespace_prefix ( std::string  prefix)
inline

References prefix.

◆ get_default_string()

◆ get_description()

std::string option_base::get_description ( ) const
inline

◆ get_name()

std::string option_base::get_name ( ) const
inline

Referenced by getLongOption().

◆ getLongOption()

std::string option_base::getLongOption ( ) const
inline

References get_name().

◆ getShortOption()

char option_base::getShortOption ( ) const
inline

◆ getTypeDescr()

virtual std::string option_base::getTypeDescr ( ) const
pure virtual

◆ has_default()

◆ has_description()

bool option_base::has_description ( ) const
inline

◆ hasLongOption()

bool option_base::hasLongOption ( ) const
inline

◆ hasShortOption()

bool option_base::hasShortOption ( ) const
inline

◆ is_defined()

◆ is_undefined()

bool option_base::is_undefined ( ) const
inline

References is_defined().

◆ processCmdLineArguments()

virtual LIBDE265_API bool option_base::processCmdLineArguments ( char **  argv,
int *  argc,
int  idx 
)
inlinevirtual

◆ set_cmd_line_options()

void option_base::set_cmd_line_options ( const char *  long_option,
char  short_option = 0 
)
inline

◆ set_description()

void option_base::set_description ( std::string  descr)
inline

◆ set_ID()

◆ set_short_option()

void option_base::set_short_option ( char  short_option)
inline

◆ unsetCmdLineOption()

void option_base::unsetCmdLineOption ( )
inline

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