.TH "shevek::args::option" 3 "Fri May 11 2012" "libshevek" \" -*- nroff -*-
.ad l
.nh
.SH NAME
shevek::args::option \- 
.PP
Define an option which can be given to the program\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <args\&.hh>\fP
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef sigc::slot1< void, bool > \fBcallback0\fP"
.br
.RI "\fICallback for options without an argument\&. \fP"
.ti -1c
.RI "typedef sigc::slot2< void, 
.br
bool, Glib::ustring const & > \fBcallback1\fP"
.br
.RI "\fICallback for options with an argument\&. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, \fBcallback0\fP handle, bool *used=NULL)"
.br
.RI "\fIOption has no argument and calls a function\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool have_default, \fBcallback1\fP handle, Glib::ustring default_val=Glib::ustring(), bool *used=NULL)"
.br
.RI "\fIOption has mandatory argument and calls a function\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, \fBcallback0\fP handle0, \fBcallback1\fP handle1, bool *used=NULL)"
.br
.RI "\fIOption has optional argument and calls respective function\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool &var, bool value, bool *used=NULL)"
.br
.RI "\fISet the value of a boolean variable\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool have_default, Glib::ustring &var, bool *used=NULL)"
.br
.RI "\fISet the value of a string variable (utf-8)\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool have_default, std::string &var, bool *used=NULL)"
.br
.RI "\fISet the value of a string variable\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool have_default, unsigned long &var, bool *used=NULL)"
.br
.RI "\fISet the value of an integer variable\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool have_default, long &var, bool *used=NULL)"
.br
.RI "\fISet the value of an integer variable\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool have_default, unsigned &var, bool *used=NULL)"
.br
.RI "\fISet the value of an integer variable\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool have_default, int &var, bool *used=NULL)"
.br
.RI "\fISet the value of an integer variable\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool have_default, unsigned short &var, bool *used=NULL)"
.br
.RI "\fISet the value of an integer variable\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool have_default, short &var, bool *used=NULL)"
.br
.RI "\fISet the value of an integer variable\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool have_default, float &var, bool *used=NULL)"
.br
.RI "\fISet the value of a floating point variable\&. \fP"
.ti -1c
.RI "\fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, bool have_default, double &var, bool *used=NULL)"
.br
.RI "\fISet the value of a floating point variable\&. \fP"
.ti -1c
.RI "template<typename _T > \fBoption\fP (char shortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, std::list< _T > &list)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBargs\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Define an option which can be given to the program\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<typename _T > \fBshevek::args::option::option\fP (charshortopt, Glib::ustring const &longopt, Glib::ustring const &help_line, std::list< _T > &list)"Fill a list of variables\&. An item is appended to the list for each time the option is specified\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for libshevek from the source code\&.