HGL::Common::IPluginPoptOptions Interface Reference
[Command line options support]

Interface to enable command line options for plugins. More...

#include <ipluginpoptoptions.h>

List of all members.

Public Member Functions

Command line options support



virtual struct::poptOption * getPoptOptions () const
 Get plugin supplied command line options.

Detailed Description

Interface to enable command line options for plugins.

Author:
Heiko Schäfer <heiko@hgl.rangun.de> BSD License
Since:
0.4.62

Member Function Documentation

virtual struct ::poptOption* HGL::Common::IPluginPoptOptions::getPoptOptions (  )  const [virtual]

Get plugin supplied command line options.

Note:
See http://linux.die.net/man/3/popt for how to create and use the popt structure and Command line options support for details on how to use it in your plugins.

The default implementation returns NULL i.e. it won't provide own command line options

In your POPT_ARG_CALLBACK you can indicate HGL to exit gracefully by throwing HGL::Exception::PoptExitException

Returns:
structure to popt options
Since:
0.4.53

Generated on 9 Apr 2014 for hgl 0.5.26~svn by  doxygen 1.6.1