13
0
livetrax/libs/gtkmm2/gtk/gtkmm/radiotoolbutton.h
Taybin Rutkin d09f6b3016 Initial revision
git-svn-id: svn://localhost/trunk/ardour2@4 d708f5d6-7413-0410-9779-e7cbd77b26cf
2005-05-13 20:47:18 +00:00

196 lines
5.7 KiB
C++

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKMM_RADIOTOOLBUTTON_H
#define _GTKMM_RADIOTOOLBUTTON_H
#include <glibmm.h>
/* $Id$ */
/* box.h
*
* Copyright (C) 2003 The gtkmm 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 <gtkmm/toggletoolbutton.h>
#include <gtkmm/radiobuttongroup.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkRadioToolButton GtkRadioToolButton;
typedef struct _GtkRadioToolButtonClass GtkRadioToolButtonClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{ class RadioToolButton_Class; } // namespace Gtk
namespace Gtk
{
/** A toolbar item that contains a radio button.
*
* A Gtk::RadioToolButton is a Gtk::ToolItem that contains a radio button, that is,
* a button that is part of a group of toggle buttons where only one button can be
* active at a time.
*
* @ingroup Widgets
*/
class RadioToolButton : public ToggleToolButton
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef RadioToolButton CppObjectType;
typedef RadioToolButton_Class CppClassType;
typedef GtkRadioToolButton BaseObjectType;
typedef GtkRadioToolButtonClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
virtual ~RadioToolButton();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
friend class RadioToolButton_Class;
static CppClassType radiotoolbutton_class_;
// noncopyable
RadioToolButton(const RadioToolButton&);
RadioToolButton& operator=(const RadioToolButton&);
protected:
explicit RadioToolButton(const Glib::ConstructParams& construct_params);
explicit RadioToolButton(GtkRadioToolButton* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_type() G_GNUC_CONST;
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GtkObject.
GtkRadioToolButton* gobj() { return reinterpret_cast<GtkRadioToolButton*>(gobject_); }
///Provides access to the underlying C GtkObject.
const GtkRadioToolButton* gobj() const { return reinterpret_cast<GtkRadioToolButton*>(gobject_); }
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
private:
public:
typedef RadioButtonGroup Group;
/** Creates a new Gtk::RadioToolButton and a new group.
*
* The RadioToolButton will have an empty label and will reside in an newly created Group.
* Use get_group() to retrieve this group and pass it to other radio buttons to assign
* them to this group.
*
* Since: 2.4
*/
RadioToolButton();
/** Creates a new Gtk::RadioToolButton in an existing group.
*
* The RadioToolButton will have the label @a label and will be put into the Group
* @a group.
*
* @param group The existing group which will be used for this RadioButton.
* @param label The string used to display the label for this RadioToolButton.
*
* Since: 2.4
*/
explicit RadioToolButton(Group& group, const Glib::ustring& label = Glib::ustring());
/** Creates a new Gtk::RadioToolButton in an existing group.
*
* The RadioToolButton will be created according to the StockID properties and put into
* the Group @a group.
*
* @param group The existing group which will be used for this RadioButton.
* @param stock_id The StockID which determines the look of the RadioToolButton.
*
* Since: 2.4
*/
RadioToolButton(Group& group, const Gtk::StockID& stock_id);
//This would look to much like a copy constructor:
//People should use second.set_group(first.get_group()) instead.
//explicit RadioToolButton(RadioToolButton& group, const Gtk::StockID& stock_id = Gtk::StockID());
//This does not correspond to any gtk_radio_tool_button_*_new() function,
//but it should work (it just sets properties), and it makes this class consistent with the
//other ToolButton classes.
/** Creates a new Gtk::RadioToolButton with an image and a new group.
*
* The RadioToolButton will have the label @a label and an image widget @a icon_widget.
*
* @param icon_widget The widget placed as the RadioToolButton's icon.
* @param label The string used to display the label for this RadioToolButton.
*
* Since: 2.4
*/
explicit RadioToolButton(Widget& icon_widget, const Glib::ustring& label = Glib::ustring());
/** Returns the radio button group @a button belongs to.
* @return The group @a button belongs to.
*
* Since: 2.4.
*/
Group get_group();
/** Adds @a button to @a group , removing it from the group it belonged to before.
*
* Since: 2.4
* @param group An existing radio button group.
*/
void set_group(Group& group);
};
} // namespace Gtk
namespace Glib
{
/** @relates Gtk::RadioToolButton
* @param object The C instance
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*/
Gtk::RadioToolButton* wrap(GtkRadioToolButton* object, bool take_copy = false);
}
#endif /* _GTKMM_RADIOTOOLBUTTON_H */