109 lines
2.9 KiB
C++
109 lines
2.9 KiB
C++
// -*- c++ -*-
|
|
// Generated by gtkmmproc -- DO NOT MODIFY!
|
|
#ifndef _GLIBMM_OPTIONENTRY_H
|
|
#define _GLIBMM_OPTIONENTRY_H
|
|
|
|
|
|
/* $Id$ */
|
|
|
|
/* Copyright (C) 2004 The glibmm Development Team
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the Free
|
|
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
*/
|
|
|
|
|
|
#include <glibmm/ustring.h>
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
extern "C" { typedef struct _GOptionEntry GOptionEntry; }
|
|
#endif
|
|
|
|
|
|
namespace Glib
|
|
{
|
|
|
|
/** An OptionEntry defines a single option. To have an effect, it must be added to an OptionGroup with
|
|
* OptionGroup::add_entry().
|
|
*
|
|
* The long name of an option can be used to specify it in a commandline as --long_name.
|
|
* Every option must have a long name. To resolve conflicts if multiple option groups contain the same long name, it is also
|
|
* possible to specify the option as --groupname-long_name.
|
|
*
|
|
* If an option has a short name, it can be specified as -short_name in a commandline.
|
|
*
|
|
* The description for the option is shown in the --help output.
|
|
*
|
|
* The arg_descripton is the placeholder to use for the extra argument parsed by the option in --help output.
|
|
*/
|
|
class OptionEntry
|
|
{
|
|
public:
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
typedef OptionEntry CppObjectType;
|
|
typedef GOptionEntry BaseObjectType;
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
private:
|
|
|
|
public:
|
|
|
|
//Copied from goption.h, instead of generated, so that we can put it inside the class.
|
|
enum Flags
|
|
{
|
|
FLAG_HIDDEN = 1 << 0,
|
|
FLAG_IN_MAIN = 1 << 1,
|
|
FLAG_REVERSE = 1 << 2
|
|
} GOptionFlags;
|
|
|
|
OptionEntry();
|
|
OptionEntry(const OptionEntry& src);
|
|
virtual ~OptionEntry();
|
|
|
|
OptionEntry& operator=(const OptionEntry& src);
|
|
|
|
|
|
Glib::ustring get_long_name() const;
|
|
void set_long_name(const Glib::ustring& value);
|
|
|
|
gchar get_short_name() const;
|
|
void set_short_name(const gchar& value);
|
|
|
|
int get_flags() const;
|
|
void set_flags(const int& value);
|
|
|
|
//TODO: G_OPTION_ARG_CALLBACK,
|
|
|
|
Glib::ustring get_description() const;
|
|
void set_description(const Glib::ustring& value);
|
|
|
|
Glib::ustring get_arg_description() const;
|
|
void set_arg_description(const Glib::ustring& value);
|
|
|
|
GOptionEntry* gobj() { return gobject_; }
|
|
const GOptionEntry* gobj() const { return gobject_; }
|
|
|
|
protected:
|
|
|
|
GOptionEntry* gobject_;
|
|
|
|
|
|
};
|
|
|
|
} // namespace Glib
|
|
|
|
|
|
#endif /* _GLIBMM_OPTIONENTRY_H */
|
|
|