13
0
livetrax/libs/gtkmm2/gtk/gtkmm/toggletoolbutton.h

171 lines
4.9 KiB
C
Raw Normal View History

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKMM_TOGGLETOOLBUTTON_H
#define _GTKMM_TOGGLETOOLBUTTON_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/toolbutton.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkToggleToolButton GtkToggleToolButton;
typedef struct _GtkToggleToolButtonClass GtkToggleToolButtonClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{ class ToggleToolButton_Class; } // namespace Gtk
namespace Gtk
{
/** A Gtk::ToolItem containing a toggle button.
*
* A ToggleToolButton is a Gtk::ToolItem that contains a toggle button.
* @ingroup Widgets
*/
class ToggleToolButton : public ToolButton
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef ToggleToolButton CppObjectType;
typedef ToggleToolButton_Class CppClassType;
typedef GtkToggleToolButton BaseObjectType;
typedef GtkToggleToolButtonClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
virtual ~ToggleToolButton();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
friend class ToggleToolButton_Class;
static CppClassType toggletoolbutton_class_;
// noncopyable
ToggleToolButton(const ToggleToolButton&);
ToggleToolButton& operator=(const ToggleToolButton&);
protected:
explicit ToggleToolButton(const Glib::ConstructParams& construct_params);
explicit ToggleToolButton(GtkToggleToolButton* 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.
GtkToggleToolButton* gobj() { return reinterpret_cast<GtkToggleToolButton*>(gobject_); }
///Provides access to the underlying C GtkObject.
const GtkToggleToolButton* gobj() const { return reinterpret_cast<GtkToggleToolButton*>(gobject_); }
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
virtual void on_toggled();
private:
public:
/** Creates a new ToggleToolButton.
*/
ToggleToolButton();
/** Creates a new ToggleToolButton from a StockID.
*
* The ToggleToolButton will be created according to the @a stock_id properties.
*
* @param stock_id The StockID which determines the look of the ToggleToolButton.
*/
explicit ToggleToolButton(const Gtk::StockID& stock_id);
/** Creates a new ToggleToolButton with a label.
*
* The ToggleToolButton will have the label @a label.
*
* @param label The string used to display the label for this ToggleToolButton.
*/
explicit ToggleToolButton(const Glib::ustring& label);
/** Creates a new ToggleToolButton with an image.
*
* The ToggleToolButton will have the label @a label and an image widget @a icon_widget.
*
* @param icon_widget The widget placed as the ToggleToolButton's icon.
* @param label The string used to display the label for this ToggleToolButton.
*/
explicit ToggleToolButton(Widget& icon_widget, const Glib::ustring& label = Glib::ustring());
/** Sets the status of the toggle tool button. Set to <tt>true</tt> if you
* want the GtkToggleButton to be 'pressed in', and <tt>false</tt> to raise it.
* This action causes the toggled signal to be emitted.
*
* Since: 2.4
* @param is_active Whether @a button should be active.
*/
void set_active(bool is_active = true);
/** Queries a Gtk::ToggleToolButton and returns its current state.
* Returns <tt>true</tt> if the toggle button is pressed in and <tt>false</tt> if it is raised.
* @return <tt>true</tt> if the toggle tool button is pressed in, <tt>false</tt> if not
*
* Since: 2.4.
*/
bool get_active() const;
Glib::SignalProxy0< void > signal_toggled();
};
} // namespace Gtk
namespace Glib
{
/** @relates Gtk::ToggleToolButton
* @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::ToggleToolButton* wrap(GtkToggleToolButton* object, bool take_copy = false);
}
#endif /* _GTKMM_TOGGLETOOLBUTTON_H */